Nano33BLE tidy up.

Author: dave

examples/nano33ble/MotionDetection.h

@@ -9,30 +9,40 @@
 #include <Arduino_LSM9DS1.h>
 #include "nano33ble_menu.h"
 
-class MotionDetection : public Executable {
+/**
+ * Here we create a polling event that checks if the acceleration / magnetic data is available, and whenever it is
+ * it triggers the event. This tidies up the class slightly by avoiding if statements in the exec() methods.
+ * In short, the timeOfNextCheck method is called every `eventFrequency` micros, and we tell taskManager that the
+ * event is triggered when both readings are available. At this point `exec()` is called and we take the readings
+ * and put then into menu items.
+ */
+class MotionDetection : public BaseEvent {
+private:
+    uint32_t eventFrequency = 1000UL;
 public:
     void initialise() {
         IMU.begin();
         auto imuRate = IMU.magneticFieldSampleRate();
-        taskManager.scheduleFixedRate(max(int(imuRate), 100), this);
+        eventFrequency = min(int(imuRate), 100) * 1000UL;
     }
 
-    void exec() {
-        if(IMU.magneticFieldAvailable()) {
-            float x, y, z;
-            IMU.readMagneticField(x, y, z);
-            menuAccelerometerMagX.setFloatValue(x);
-            menuAccelerometerMagY.setFloatValue(y);
-            menuAccelerometerMagZ.setFloatValue(z);
-        }
-
-        if(IMU.accelerationAvailable()) {
-            float x, y, z;
-            IMU.readAcceleration(x, y, z);
-            menuAccelerometerAccelX.setFloatValue(x);
-            menuAccelerometerAccelY.setFloatValue(y);
-            menuAccelerometerAccelZ.setFloatValue(z);
-        }
+    uint32_t timeOfNextCheck() override {
+        setTriggered(IMU.magneticFieldAvailable() && IMU.accelerationAvailable());
+
+        return eventFrequency;
+    }
+
+    void exec() override {
+        float x, y, z;
+        IMU.readMagneticField(x, y, z);
+        menuAccelerometerMagX.setFloatValue(x);
+        menuAccelerometerMagY.setFloatValue(y);
+        menuAccelerometerMagZ.setFloatValue(z);
+
+        IMU.readAcceleration(x, y, z);
+        menuAccelerometerAccelX.setFloatValue(x);
+        menuAccelerometerAccelY.setFloatValue(y);
+        menuAccelerometerAccelZ.setFloatValue(z);
     }
 };
 

examples/nano33ble/SensorManager.h

@@ -11,17 +11,20 @@
 #include <MenuItems.h>
 #include "nano33ble_menu.h"
 
-class SensorManager : Executable{
+/**
+ * Here we have a class that extends `Executable`, meaning that the `exec()` method is called every time the event
+ * is scheduled by task manager. We read the data from the sensors and set them onto menu items.
+ */
+class SensorManager : public Executable {
 private:
     bool initialised{};
 public:
     void initialise() {
         initialised = HTS.begin()  != 0;
         initialised = initialised && BARO.begin();
-        initialised = initialised && taskManager.scheduleFixedRate(1, this, TIME_SECONDS) != TASKMGR_INVALIDID;
     }
 
-    void exec() {
+    void exec() override {
         menuTemp.setFromFloatingPointValue(HTS.readTemperature());
         menuHumidity.setFromFloatingPointValue(HTS.readHumidity());
         menuBPressure.setFromFloatingPointValue(BARO.readPressure());

examples/nano33ble/nano33ble.ino

@@ -1,32 +1,57 @@
+/**
+ * @file nano33ble.ino
+ * An example of using tcMenu with the Nano33BLE Sense. This example uses some of the sensors on-board the device
+ * along with an I2C LCD backpack based display and a rotary encoder. Although this is pre-generated for you, you
+ * can load the example's emf file into TcMenu Designer and take a look around or re-build it.
+ *
+ * You can get or adjust the pin configurations by loading the emf file into the designer
+ */
+
 #include "nano33ble_menu.h"
 #include "SensorManager.h"
 #include "MotionDetection.h"
 #include <AnalogDeviceAbstraction.h>
 
+// on the analog menu, we both have an analog input and an analog output (PWM). You can configure those pins here.
 const int analogInputPin = A0;
 const int pwmOutputPin = 2;
 
+// We work with analog input and output here, so we use an analog device to make it easier. It provides the ability
+// to treat analog values as floats between 0..1 on any supported platform.
+ArduinoAnalogDevice analogDevice;
+
+// We create a class extending Executable for the temprature, humidity, and pressure sensors that are built in
 SensorManager sensorManager;
+
+// We create an event class extending BaseEvent to manage the motion detection
 MotionDetection motionDetection;
-ArduinoAnalogDevice analogDevice;
 
 void setup() {
+    // First we set up the analog pins
+    analogDevice.initPin(pwmOutputPin, DIR_OUT);
+    analogDevice.initPin(analogInputPin, DIR_IN);
+
+    // and set up the menu itself, so it starts displaying and accepting input
     setupMenu();
+
+    // then we initialise our sensor and motion detection and register with task manager.
     sensorManager.initialise();
     motionDetection.initialise();
-    analogDevice.initPin(pwmOutputPin, DIR_OUT);
-    analogDevice.initPin(analogInputPin, DIR_IN);
+    taskManager.registerEvent(&motionDetection);
+    taskManager.scheduleFixedRate(1, &sensorManager, TIME_SECONDS);
 
+    // lastly we set up something simple to read from analog in
     taskManager.scheduleFixedRate(100, [] {
        menuAnalogReadingsInA0.setFloatValue(analogDevice.getCurrentFloat(analogInputPin));
     });
 }
 
+// All TaskManager sketches must call runLoop very often from the loop method, you should not use any delays.
 void loop() {
     taskManager.runLoop();
-
 }
 
+// And something to change the PWM output when the PWM menu item changes
 void CALLBACK_FUNCTION onPWMChanged(int id) {
     auto newPwm = menuAnalogReadingsOutputPWM.getCurrentValue() / 100.0F;
     analogDevice.setCurrentFloat(pwmOutputPin, newPwm);