Example updates

Author: davetcc

README.md

@@ -260,6 +260,10 @@ You can create matrix keyboards with any arrangement of keys, but the two most c
 
 Alongside the example, there is comprehensive documentation describing the use of [matrix keyboards on Arduino](https://www.thecoderscorner.com/products/arduino-libraries/io-abstraction/matrix-keyboard-keypad-manager/).  
 
+## Inbuilt Unit testing framework and mocking
+
+IoAbstraction has a very simple unit test framework built into it, it works on a very wide range of boards, more or less everything in our supported list. In addition to this there are mock versions of some components to make testing your code easier. See https://www.thecoderscorner.com/products/arduino-libraries/io-abstraction/ioabstraction-troubleshooting-unit-testing/
+
 ## ESP32 extras mode
 
 On ESP32 we are slowly adding support for direct IDF, as it's been requested by one of our clients. This will slowly appear over several releases. To enable this mode you can set the flag `IOA_USE_ESP32_EXTRAS`. Once you do this IDF functions are used for all digital IO functions. We always use IDF functions for analog input and DAC output, and are slowly moving toward direct LTDC functions for PWM instead of wrappers. 

examples/analogExample/analogExample.ino

@@ -30,10 +30,7 @@ public:
     }
 
     void exec() override {
-        Serial.print("Trigger AnalogInEvent Threshold ");
-        Serial.print(analogThreshold);
-        Serial.print(", value ");
-        Serial.println(lastReading);
+        serdebugF3("Trigger AnalogInEvent Threshold, Last:  ", analogThreshold, lastReading);
     }
 };
 
@@ -48,41 +45,31 @@ void setup() {
     Serial.begin(115200);
 
     // set up the device pin directions upfront.
-    analog.initPin(ANALOG_IN_PIN, DIR_IN);
-    analog.initPin(PWM_OR_DAC_PIN, DIR_OUT);
+    internalAnalogDevice().initPin(ANALOG_IN_PIN, DIR_IN);
+    internalAnalogDevice().initPin(PWM_OR_DAC_PIN, DIR_OUT);
 
     // this is how to register an event with task manager
-    taskManager.registerEvent(new MyAnalogExceedsEvent(internalAnalogIo(), ANALOG_IN_PIN), true);
+    taskManager.registerEvent(new MyAnalogExceedsEvent(internalAnalogDevice(), ANALOG_IN_PIN), true);
 
     // we schedule a task to run every 500 millis that reads the value from A1 and prints it output
     // along with the largest possible value
     taskManager.scheduleFixedRate(500, [] {
-        Serial.print("Analog input value is ");
-        Serial.print(analog.getCurrentValue(ANALOG_IN_PIN));
-        Serial.print("/");
-        Serial.print(analog.getMaximumRange(DIR_IN, ANALOG_IN_PIN));
-        Serial.print(" - ");
-        Serial.print(analog.getCurrentFloat(ANALOG_IN_PIN) * 100.0F);
-        Serial.println('%');
+        serdebugF4("Analog input value is ", internalAnalogDevice().getCurrentValue(ANALOG_IN_PIN),
+                   internalAnalogDevice().getMaximumRange(DIR_IN, ANALOG_IN_PIN),
+                   internalAnalogDevice().getCurrentFloat(ANALOG_IN_PIN) * 100.0F);
 
 #ifdef ESP32
-        auto* espAnalog = reinterpret_cast<ESP32AnalogDevice*>(analog);
         // On ESP32 boards, where the analogWrite function doesn't exist we use the underlying functions
         // to access either the DAC or LEDC subsystem, if you want to get hold of the ledc channel you can.
-        EspAnalogOutputMode* outputMode = espAnalog->getEspOutputMode(PWM_OR_DAC_PIN);
+        EspAnalogOutputMode* outputMode = internalAnalogDevice().getEspOutputMode(PWM_OR_DAC_PIN);
         if(outputMode != nullptr) {
-            Serial.print("ESP32 Output type: ");
-            Serial.print(outputMode->isDac());
-            Serial.print(", ledc (pwm channel): ");
-            Serial.println(outputMode->getPwmChannel());
+            serdebugF2("ESP32 Output type: ", outputMode->isDac());
+            serdebugF2("LEDC (pwm channel): ", outputMode->getPwmChannel());
         }
 
-        EspAnalogInputMode* inputMode = espAnalog->getEspInputMode(ANALOG_IN_PIN);
+        EspAnalogInputMode* inputMode = internalAnalogDevice().getEspInputMode(ANALOG_IN_PIN);
         if(inputMode != nullptr) {
-            Serial.print("ESP32 Input on dac1: ");
-            Serial.print(inputMode->isOnDAC1());
-            Serial.print(", channel: ");
-            Serial.println(inputMode->getChannel());
+            serdebugF3("ESP32 Input (ondac1, channel): ", inputMode->isOnDAC1(), inputMode->getChannel());
         }
 #endif
     });
@@ -94,7 +81,7 @@ void setup() {
         if(ledCycleValue >= 0.98) ledCycleAdj = -0.01;
         if(ledCycleValue <= 0.02) ledCycleAdj = 0.01;
 
-        analog.setCurrentFloat(PWM_OR_DAC_PIN, ledCycleValue);
+        internalAnalogDevice().setCurrentFloat(PWM_OR_DAC_PIN, ledCycleValue);
     }, TIME_MILLIS);
 }
 

examples/joystickRotaryEncoder/joystickRotaryEncoder.ino

@@ -10,49 +10,41 @@
 #include <IoAbstraction.h>
 #include <JoystickSwitchInput.h>
 
-#define ANALOG_INPUT_PIN 25
-#define ANALOG_LEFT_RIGHT_PIN 37
+#define ANALOG_INPUT_PIN 34
+#define ANALOG_LEFT_RIGHT_PIN 33
 #define BUTTON_PIN 2
 #define MULTI_IO_ARDUINO_PIN_MAX 100
 // we need to create an analog device that the joystick encoder will use to get readings.
 // In this case on arduino analog pins.
-AnalogDevice* analogDevice;
 
 // We now want to receive button input from both Arduino pins, and two extra simulated button pins that
 // are acutally when the joystick moves left and right. So we need a multiIoAbstraction.
-MultiIoAbstractionRef multiIo = multiIoExpander(MULTI_IO_ARDUINO_PIN_MAX);
+MultiIoAbstraction multiIo(MULTI_IO_ARDUINO_PIN_MAX);
 
 void onEncoderChange(int newValue) {
-    Serial.print("New joystick value: ");
-    Serial.print(newValue);
-    Serial.print(", analog in ");
-    Serial.print(analogDevice->getCurrentValue(ANALOG_INPUT_PIN));
-    Serial.print(", switch ");
-    Serial.println(analogDevice->getCurrentValue(ANALOG_LEFT_RIGHT_PIN));
+    serdebugF4("New joystick val, in, lr: ", newValue, internalAnalogDevice().getCurrentValue(ANALOG_INPUT_PIN), internalAnalogDevice().getCurrentValue(ANALOG_LEFT_RIGHT_PIN));
 
 }
 
 void setup() {
     Serial.begin(115200);
 
-    analogDevice = internalAnalogIo();
-    
     // MKR boards require the line below to wait for the serial port, uncomment if needed
     // However, it doesn't work on some other boards and locks them up.
     //while(!Serial);
 
-    Serial.println("Starting joystick rotary encoder example");
+    serdebugF("Starting joystick rotary encoder example");
 
     // now we add an expander that handles the left and right function of the joystick as two buttons, these could
     // be useful for next and back functions for example. The mid point for calibration will be half max value in
     // our case, if your potentiometer differs, set the calibration accordingly. Joystick pins will start at 100.
-    multiIoAddExpander(multiIo, joystickTwoButtonExpander(analogDevice, ANALOG_LEFT_RIGHT_PIN, .5F), 10);
+    multiIo.addIoExpander(joystickTwoButtonExpander(internalAnalogIo(), ANALOG_LEFT_RIGHT_PIN, .5F), 10);
 
     // first initialise switches using the multi io expander and pull up switch logic.
-    switches.initialise(multiIo, true);
+    switches.initialise(asIoRef(multiIo), true);
 
     // now register the joystick
-    setupAnalogJoystickEncoder(analogDevice, ANALOG_INPUT_PIN, onEncoderChange);
+    setupAnalogJoystickEncoder(internalAnalogIo(), ANALOG_INPUT_PIN, onEncoderChange);
 
     // once you've registed the joystick above with switches, you can then alter the mid point and tolerance if needed
     // here we set the midpoint to 65% and the tolerance (or point at which we start reading) at +-5%.