0.4.0

- Updated documentation.
- `aoapps_swflag.cpp` switched to new driver `aomw_iox4b4l`; it also supports selector SAIDsense (next to the one on SAIDbasic).
- Added module `aoapps_sensors` (to be used with the SAIDsense demo board) and example `aoapps_sensors.ino`.
- Added link to examples.

Author: Maarten Pennings

examples/aoapps_sensors/aoapps_sensors.ino

@@ -0,0 +1,97 @@
+// saidbasic.ino - the demo application for the SAIDbasic board
+/*****************************************************************************
+ * Copyright 2024,2025 by ams OSRAM AG                                       *
+ * All rights are reserved.                                                  *
+ *                                                                           *
+ * IMPORTANT - PLEASE READ CAREFULLY BEFORE COPYING, INSTALLING OR USING     *
+ * THE SOFTWARE.                                                             *
+ *                                                                           *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS       *
+ * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT         *
+ * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS         *
+ * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT  *
+ * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,     *
+ * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT          *
+ * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,     *
+ * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY     *
+ * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT       *
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE     *
+ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.      *
+ *****************************************************************************/
+#include <aospi.h>     // aospi_init()
+#include <aoosp.h>     // aoosp_init()
+#include <aocmd.h>     // aocmd_cint_pollserial()
+#include <aoui32.h>    // aoui32_oled_splash()
+#include <aomw.h>      // aomw_init()
+#include <aoapps.h>    // aoapps_mngr_start()
+
+
+/*
+DESCRIPTION
+This is a template for a sketch using multiple apps and the app manager.
+It contains two apps ("runled" and "sensors"). The "A" button switches to 
+the next app. For simplicity the command interpreter has not been added. 
+
+HARDWARE
+The demo should run on the OSP32 board, connected to the SAIDsense board. 
+In Arduino select board "ESP32S3 Dev Module".
+
+BEHAVIOR
+The behavior depends on the app chosen and the buttons pressed.
+
+OUTPUT
+Welcome to aoapps_sensors.ino
+
+spi: init(MCU-B)
+osp: init
+mw: init
+apps: init
+ui32: init
+sensors: using temp sensor 48 on SAID 003 
+sensors: using rotation sensor 36 on SAID 003
+sensors: using light sensor 26 on SAID 003
+sensors: using display 38 on SAID 003
+sensors: using selector 3F on SAID 003
+*/
+
+
+void setup() {
+  // Identify over Serial
+  Serial.begin(115200);
+  do delay(250); while( ! Serial );
+  Serial.printf("\n\nWelcome to aoapps_sensors.ino\n\n");
+
+  // Initialize all libraries
+  aospi_init(); 
+  aoosp_init();
+  aomw_init();
+  aoapps_init();
+  aoui32_init();
+
+  // Splash screen
+  aoui32_oled_splash("aoapps_sensors", "1.0");
+  delay(1000);
+
+  // App registration
+  aoapps_runled_register();  // First app registered
+  aoapps_sensors_register(); // Second  app registered
+  aoapps_sensors_resethw();  // Switch off display on SAISsense
+
+  // Start
+  aoapps_mngr_start();
+}
+
+
+void loop() {
+  // Check physical buttons
+  aoui32_but_scan();
+
+  // Switch to next app when A was pressed
+  if( aoui32_but_wentdown(AOUI32_BUT_A) ) aoapps_mngr_switchnext();
+
+  // Animation step in current application
+  aoapps_mngr_step();
+}
+
+
+

extras/aoapps-modules.drawio.png

@@ -1,5 +1,5 @@
 name=OSP ReusableApps aoapps
-version=0.3.0
+version=0.4.0
 author=ams-OSRAM
 maintainer=ams-OSRAM
 sentence=A library with reusable "apps" for OSP chains.

library.properties

@@ -11,8 +11,8 @@ The landing page for the _aolibs_ is on
 ## Introduction
 
 Library _aoapps_ is a library with reusable "apps" for OSP chains.
-Multiple apps form one firmware image (or executable) for the ESP32 
-as  explained below.
+Multiple apps form one _firmware image_ or _executable_ for the ESP32 
+as explained below.
 
 
 ![aoapps in context](extras/aolibs-aoapps.drawio.png)
@@ -23,7 +23,7 @@ that exposes a `step()` function, which is constantly called from the
 main loop, and which manages the animation implemented by the app.
 
 In addition to the apps, this library also contains an _app manager_. 
-A top-level sketch includes the manager and registers one or more apps, 
+A sketch includes the manager and registers one or more apps, 
 either from this library or from elsewhere (self developed). Typically 
 the "A" button on the OSP32 board is used to tell the app manager
 to switch from one app to the next.
@@ -70,22 +70,28 @@ void loop() {
 
 This library comes with the following examples.
 You can find them in the Arduino IDE via 
-File > Examples > OSP ReusableApps aoapps > ...
+[File > Examples > OSP ReusableApps aoapps > ...](examples):
 
 - **aoapps_switch** ([source](examples/aoapps_switch))  
-  This demo implements an application with two (dummy) apps.
+  This demo implements an executable with two (dummy) apps, 
+  App1 and App2, which are part of the example.
   By pressing but A, the user can switch between the apps.
   The name of the active app is shown on the OLED.
   The green and red signaling LED show heart beat and error.
   App1 shows how to process button presses.
   App2 goes into error after a while (to show that the green heart beat 
   LED stops and the red error LED switches on).
 
-- **aoapps_runled** ([source](examples/aoapps_runled)) 
+- **aoapps_runled** ([source](examples/aoapps_runled))  
   This demo shows how to run an app.
   It uses the "runled" app, which has been made to expose its internals;
   the start, step and stop function.
 
+- **aoapps_sensors** ([source](examples/aoapps_sensors))  
+  This is a template for a sketch using multiple apps and the app manager.
+  It contains two apps ("runled" and "sensors"). The "A" button switches to 
+  the next app. For simplicity the command interpreter has not been added. 
+
 
 ## Module architecture
 
@@ -114,12 +120,12 @@ This library contains several modules, see figure below (arrows indicate `#inclu
   - The goal is to show that various OSP nodes can be mixed and have color/brightness matched.
 
 - **aoapps_swflag** (`aoapps_swflag.cpp` and `aoapps_swflag.h`) is one of the stock apps.
-  - Shows one (static) flag at a time, eg the Dutch national flag red/white/blue spread over the OSP chain.
-  - Tries to find a SAID with an I2C bridge with an I/O-expander (with four buttons and four indicator LEDs).
-  - If there is no I/O-expander, shows four static flags switching on a time basis.
-  - If there are multiple I/O-expanders the first one is taken.
-  - When an I/O-expander is found the four buttons select which flag to show.
-  - The indicator LEDs connected to the I/O-expander indicate which button/flag was selected.
+  - Shows one (static) flag at a time, e.g. the Dutch national flag red/white/blue spread over the OSP chain.
+  - Tries to find a SAID with an I2C bridge with a "selector", an I/O-expander with four buttons and four indicator LEDs.
+  - If there is no selector, shows four static flags switching on a time basis.
+  - If there are multiple selectors the first SAIDbasic one is taken, or the first SAIDsense when no SAIDbasic.
+  - When a selector is found the four buttons select which flag to show.
+  - The indicator LEDs indicate which button/flag was selected.
   - The X and Y buttons control the dim level (RGB brightness).
   - This app adds a command to configure which four flags will be shown.
   - The goal is to show a "sensor" (button) being accessible from the root MCU (the ESP).
@@ -146,6 +152,32 @@ This library contains several modules, see figure below (arrows indicate `#inclu
   - Note, the tool [eepromflasher](https://github.com/ams-OSRAM/OSP_aotop/tree/main/examples/eepromflasher)
     allows flashing EEPROMs with the various animation scripts.
 
+- **aoapps_sensors** (`aoapps_sensors.cpp` and `aoapps_sensors.h`) is one of the stock apps.
+  - Measures the temperature using an AS6212 temperature sensor.
+  - Measures the angle of the knob using an AS5600 rotary sensor.
+  - Measures the light intensity using an SFH5721 ambient light sensor.
+  - Only one of the three sensors is active at one time.
+  - To change the active sensor, either press the X button to cycle to next,
+    or press one of the selector buttons TEMP, ROTARY, ALS (and EXT) on 
+    the SAIDsense board.
+  - The indicator LED (paired with the selector button) of the active 
+    sensor switches on.
+  - The quad 7-segment display shows the readout of the active sensor.
+  - When the temperature sensor is active, the OSP chains shows a red part
+    and a blue part that change with temperature.
+  - When the angle sensor is active, the knob angle (0-360) determines how 
+    many triplets are yellow (0..num triplets).
+  - When ambient light sensor is active, the higher the ambient light level,
+    the greener the triplets.
+  - This app is written for the SAIDsense board.
+  - For backward compatibility with older board, this app supports a board 
+    without light sensor, rotary sensor, or selector.
+  - The Y button scrolls the type number of the sensor.
+  - The X button toggles between temperature, angle or light sensor being active.
+  - Upon a press the display shows the units for a short moment.
+  - Active sensor has its indicator LED on.
+  - Goal is to show a sensor can be used in OSP (eg for climate control, light adaption).
+
 
 ## API
 
@@ -212,14 +244,15 @@ so desired). This handler allows the user manage apps.
 
 - `aoapps_runled_start()`, `aoapps_runled_step()`, `aoapps_runled_stop()`
    are external, making it easier to demo this app without the manager.
+   For the other apps these functions are kept private.
 
 
 ### aoapps_swflag
 
 - `aoapps_swflag_register()` registers the swflag app with the app manager.
-- `aoresult_t aoapps_swflag_resethw()` resets the I/O-expander, thereby 
-  switching off the indicator LEDs attached to it. This helps reset the PCB
-  state when the MCU is reset.
+- `aoapps_swflag_resethw()` resets the selector, thereby 
+  switching off the indicator LEDs attached to it. 
+  This helps reset the PCB state when the MCU is reset.
 
 
 ### aoapps_dither
@@ -232,6 +265,14 @@ so desired). This handler allows the user manage apps.
 - `aoapps_aniscript_register()` registers the aniscript app with the app manager.
 
 
+### aoapps_sensors
+
+- `aoapps_sensors_register()` registers the sensors app with the app manager.
+- `aoapps_sensors_resethw()` resets the selector and the quad 7-segment display, 
+  thereby switching off the LEDs attached to them. 
+  This helps reset the PCB state when the MCU is reset.
+
+
 ## Execution architecture
 
 To keep execution architecture simple, top-level sketches employ a 
@@ -342,7 +383,6 @@ the `boot.cmd` which is executed at startup, for example:
 `apps config sw set  dutch mali europe italy`.
 
 
-
 ## The voidapp
 
 The app manager has one app always registered, the "voidapp". This app
@@ -361,6 +401,12 @@ of the OSP chain, without app telegrams interfering.
 
 ## Version history _aoapps_
 
+- **2025 September 17, 0.4.0**
+  - Updated documentation.
+  - `aoapps_swflag.cpp` switched to new driver `aomw_iox4b4l`; it also supports selector SAIDsense (next to the one on SAIDbasic).
+  - Added module `aoapps_sensors` (to be used with the SAIDsense demo board) and example `aoapps_sensors.ino`.
+  - Added link to examples.
+
 - **2025 March 3, 0.3.0**
   - Added the feature that an app can be hidden; the `hide` commands toggles.
   - The voidapp no longer is hardwired hidden; it uses the new hidden feature.

readme.md

@@ -1,6 +1,6 @@
 // aoapps.h - apps for OSP chains (eg running LEDs)
 /*****************************************************************************
- * Copyright 2024 by ams OSRAM AG                                            *
+ * Copyright 2024,2025 by ams OSRAM AG                                       *
  * All rights are reserved.                                                  *
  *                                                                           *
  * IMPORTANT - PLEASE READ CAREFULLY BEFORE COPYING, INSTALLING OR USING     *
@@ -23,7 +23,7 @@
 
 
 // Identifies lib version
-#define AOAPPS_VERSION "0.3.0"
+#define AOAPPS_VERSION "0.4.0"
 
 
 // Include the (headers of the) modules of this app
@@ -32,6 +32,7 @@
 #include <aoapps_swflag.h>     // the app "swflag" 
 #include <aoapps_dither.h>     // the app "dither" 
 #include <aoapps_aniscript.h>  // the app "aniscript" 
+#include <aoapps_sensors.h>    // the app "sensors"
 
 
 // Initializes the aoapps library (the mngr)