Data

Tools

Indexes

Applications

Experiments

Awesome

An open API service indexing awesome lists of open source software.

https://github.com/ams-osram/osp_aomw

A library with middleware for OSP applications.
https://github.com/ams-osram/osp_aomw

arduino as1163 e3731i library osp rgb-led

Last synced: about 1 month ago
JSON representation

A library with middleware for OSP applications.

Awesome Lists containing this project

README 

          
# OSP Middleware aomw



Library "OSP Middleware aomw", usually abbreviated to "aomw",

is one of the **aolibs**; short for Arduino OSP libraries from ams-OSRAM.

This suite implements support for chips that use the Open System Protocol, 

like the AS1163 ("SAID") or the OSIRE E3731i ("RGBi").

The landing page for the _aolibs_ is on 

[GitHub](https://github.com/ams-OSRAM/OSP_aotop).



## Introduction



Library _aomw_ is a library with middleware for OSP applications.

It implements features like building a topology map of an OSP chain 

(which type of chip at which OSP address), has several I2C device drivers 

(for I2C devices used in the evaluation kit) and scripting 

(simple light animations).



![aomw in context](extras/aolibs-aomw.drawio.png)



These features are typically used in the `aoapps` library.



This library also contains a module for color conversions: `aomw_color`.

The module is needed to tweak the PWM settings of individual RGB triplets

in order for a series of them to all show the exact same color;

and to keep that color when temperature changes. Module `aomw_color`

comes with _examples_ but it is not used in the various demos because 

it requires management of color calibration data, beyond the scope of the

evaluation kit.



## Examples



This library comes with the following examples.

You can find them in the Arduino IDE via 

[File > Examples > OSP Middleware aomw > ...](examples):



- **aomw_min** ([source](examples/aomw_min))  

  This demo scans the OSP chain using the topo builder from the middleware to 

  form a topology map of all nodes of the OSP chain. Next, it toggles

  the first triplet between magenta and yellow. Note that topo abstracts

  away that a SAID has three RGB triplets and an RGBI one, and that they

  need different telegrams for the same results.

  

- **aomw_topodump** ([source](examples/aomw_topodump))  

  This demo scans the OSP chain using the topo builder from the middleware to 

  form a topology map of all nodes of the OSP chain. Next, it prints out the 

  chain configuration: nodes, triplets, i2cbridges.

  It does feature some time measurement code. See the comment at

  the end of the sketch for an analysis of the measurements.

  

- **aomw_topodemo** ([source](examples/aomw_topodemo))  

  This demo first creates a topology map of all nodes of the OSP chain. 

  Next it animates a running led animation, constantly updating the triplets.

  The topo map creation and running led animation is driven from a state

  machine. This would allow running commands from serial or scanning for 

  presses of UI buttons.

  

- **aomw_toposkip** ([source](examples/aomw_toposkip))  

  This demos the SKIPCHN feature: the topo builder skips channel x of a SAID if

  the SAID has the SKIPCHNx bit set in OTP. The demo begins with no channels

  skipped, but each step adds one channel to skip.

  

- **aomw_flag** ([source](examples/aomw_flag))  

  This demo builds a topology map of all nodes of the OSP chain. Next, it 

  uses this topo map to paint country flags spread out over an entire OSP chain.



- **aomw_sseg** ([source](examples/aomw_sseg))  

  This demo initializes an OSP chain, powers the I2C bridge in a SAID 

  and checks whether there is a quad 7-segment display - as on the SAIDsense 

  board. If there is, the demo configures the display and starts showing 

  increasing numbers.



- **aomw_as6212** ([source](examples/aomw_as6212))  

  This demo initializes an OSP chain, powers the I2C bridge in a SAID and checks 

  whether there is an AS6212 temperature sensor - as on the SAIDsense board. 

  If there is, the demo configures the sensor and starts reading and printing 

  temperatures at a steady pace.



- **aomw_sfh5721**  ([source](examples/aomw_sfh5721))  

  This demo initializes an OSP chain, powers the I2C bridge in a SAID and 

  checks whether there is a SFH5721 light sensor - as on the SAIDsense board. 

  If there is, the demo configures the sensor and starts reading and printing 

  light levels at a steady pace.



- **aomw_as5600** ([source](examples/aomw_as5600))  

  This demo initializes an OSP chain, powers the I2C bridge in a SAID and checks 

  whether there is a AS5600 rotary sensor - as on the SAIDsense board. 

  If there is, the demo configures the sensor and starts reading and printing 

  angles at a steady pace.



- **aomw_iox4b4l** ([source](examples/aomw_iox4b4l))  

  This demo initializes an OSP chain, powers the I2C bridge in a SAID and 

  checks whether there is a "selector". A selector is an I/O-expander (IOX),

  an I2C device that exposes a set of GPIO pins, in the case of a selector

  connected to 4 buttons and 4 indicator LEDs.

  If the selector is found (there is on on the SAIDbasic board and one on 

  the SAIDsense board), the demo plays a light show on the connected 

  indicator LEDs, which can be interrupted by pressing a button connected 

  to the IOX.



- **aomw_eeprom** ([source](examples/aomw_eeprom))  

  This demo initializes an OSP chain, powers the I2C bridge in a SAID

  and checks whether there is an EEPROM. If so, reads and prints the

  entire EEPROM contents, then modifies one row and then restores that.

  It finalizes by doing a compare of the current EEPROM content with

  the values read at the start.

  

- **aomw_tscript** ([source](examples/aomw_tscript))  

  This demo uses topo to initialize the OSP chain, then installs one of the

  animation scripts. The main program continuously loops over all script

  instructions to draw the "frames".

  

- **aomw_colormath** ([source](examples/aomw_colormath))  

  This demo shows how to compute the duty cycles for the R, G, and B LEDs of

  a calibrated triplet, in order to reach a target color point. This demo 

  also includes a (post-mixing) temperature correction.

  The demo is "mathematical" in that it shows _how_ the computations are done.

  This demo does not _control_ triplets, or use actual sensor data 

  (temperature), it spoofs inputs and only prints outputs to Serial. 

  See `aomw_colordemo` for a more realistic example.

  

- **aomw_colordemo** ([source](examples/aomw_colordemo))  

  This demo shows how to get uniform colors over multiple RGB triplets with

  varying temperatures. It controls a SAID chain with triplets, using the 

  temperature sensor in the SAIDs as an approximation of the triplets' 

  temperatures. Note however, the supplied calibration data, although real, 

  is very unlikely to match the users' hardware.



      

## Module architecture



This library contains several modules (a source and header file), 

see figure below. The green boxes are header files (`.h`), 

the blue boxes are source files (`.cpp`). Arrows indicate `#include`.

The modules in the red pane have a common characteristic: they 

are drivers for I2C devices via a SAID. 



![Modules](extras/aomw-modules.drawio.png)



- **aomw_topo** (`aomw_topo.cpp` and `aomw_topo.h`) builds and then 

  provides the so-called "topology map", a data structure describing the 

  attached OSP chain: how many OSP nodes, how many RGB triplets, how many 

  I2C bridges, plus to which OSP node each triplet or I2C bridge connects. 

  Building the map includes reset, init and a scan (identity, otp) of all 

  nodes, plus configuring all nodes (drive current, power state, errors).

  

  Another high level feature of the topo module is to abstract away how to 

  _drive_ triplets (is a triplet on a channel, the channel's drive current 

  settings, the available PWM bits). The topo module defines its own

  dynamic range: "topo brightness range", ranging from 0 to 0x7FFF and 

  is able to map that to any triplet (RGBI's and RGBs connected to SAID).

  The `aomw_topo_settriplet` abstractions makes it _the API_ 

  for other modules (`aomw_tscript`, `aomw_flag`, most apps in library aoapps).

  

  The topo module also has a command handler that can be registered with the 

  command interpreter. This makes the topology map and the high level

  `aomw_topo_settriplet()` available through the serial interface.

  

- **aomw_tscript** (`aomw_tscript.cpp` and `aomw_tscript.h`) implements an

  interpreter that executes instructions describing an animation on an RGB 

  strip. Typically those scripts are stored in an EEPROM, but the scripts can 

  also come from other sources, there is no dependency from `aomw_tscript` to 

  `aomw_eeprom`. This module uses `aomw_topo` to render the script so any

  OSP chain supported by topo could be used as a target.

  

  The script is an balance between functionality and low memory footprint.

  Instructions are 16 bits (so a 256 byte EEPROM can store 128 instructions).

  The RGB values in the instruction are only 3 bit each (so 8 shades). A more

  detailed explanation is in [aomw_tscript.cpp](src/aomw_tscript.cpp).

  

  This module also contains some animation scripts. The application 

  [eepromflasher](https://github.com/ams-OSRAM/OSP_aotop/tree/main/examples/eepromflasher)

  allows writing scripts to EEPROMs. The app 

  [aoapps_aniscript](https://github.com/ams-OSRAM/OSP_aoapps/tree/main/src/aoapps_aniscript.cpp)

  reads those EEPROMs and play the animation.



- **aomw_flag** (`aomw_flag.cpp` and `aomw_flag.h`) is a module that can "paint"

  one of its supported country flags (Dutch, European union) to the OSP chain. 

  The flags are available by name and by index. This module uses `aomw_topo` 

  to render the flags on RGB modules.

  

  The app [aoapps_swflag](https://github.com/ams-OSRAM/OSP_aoapps/tree/main/src/aoapps_swflag.cpp)

  uses this module to paint a flag.



- **aomw_color** (`aomw_color.cpp` and `aomw_color.h`) is a module that 

  contains color data types and color conversion routines with the aim to

  realize uniform colors in an OSP chain irrespective of variations in 

  manufacturing (exact color point of an LED) and irrespective of local 

  temperature (differences). This module comes with two examples 

  ([math](examples/aomw_colormath) and [demo](examples/aomw_colordemo)); 

  but it is not used in any real demo (because the calibration data does not 

  match "your" hardware).



- **aomw_iox4b4l** (`aomw_iox4b4l.cpp` and `aomw_iox4b4l.h`) is a driver for 

  a "selector" as is found on the SAIDbasic and SAIDsense board. A selector

  is an I2C based I/O-expander with 4 of its GPIOs attached to an indicator LED, 

  and 4 of its GPIOs attached to a button.



  The app [aoapps_swflag](https://github.com/ams-OSRAM/OSP_aoapps/tree/main/src/aoapps_swflag.cpp)

  uses the buttons of the selector to select one in four country flags

  (and it uses the indicator LEDs to indicate the currently selected flag).

  

  The app [aoapps_sensors](https://github.com/ams-OSRAM/OSP_aoapps/tree/main/src/aoapps_sensors.cpp)

  uses the buttons of the selector to select which sensor is active

  (and it uses the indicator LEDs to indicate the currently selected sensor).



- **aomw_eeprom** (`aomw_eeprom.cpp` and `aomw_eeprom.h`) is a driver for

  I2C based EEPROMs (AT24C02C with 256 locations of 1 byte). The driver 

  can read bytes from or write bytes to such an EEPROM. It also has a 

  compare feature and a presence check (test if an EEPROM is attached 

  to the I2C bus of a SAID).



- **aomw_as5600** (`aomw_as5600.cpp` and `aomw_as5600.h`) 

  is a driver for an I2C based magnetic rotary sensor (AS5600).

  It is a simple driver. Upon startup it configures the sensor for its 

  (factory) default register settings. Furthermore there is a function

  to read the (raw) angle and a function to read the magnetic force.



- **aomw_as6212** (`aomw_as6212.cpp` and `aomw_as6212.h`) 

  is a driver for an I2C based temperature sensor (AS6212).

  It is a simple driver; it does not support the thresholds, nor

  the CONFIG fields AL, IM, POL, CF[]. In addition to a function to get 

  the temperature the conversion rate can be controlled.



- **aomw_sfh5721** (`aomw_sfh5721.cpp` and `aomw_sfh5721.h`) 

  is a driver for an I2C based ambient light sensor (SFH 5721).

  It is a simple driver; it does not support any configuration or 

  channel selection, there is only a function to get the ambient lux level.



- **aomw_sseg** (`aomw_sseg.cpp`, `aomw_sseg.i` and `aomw_sseg.h`) 

  is a driver for a quad 7-segment display as found on SAIDsense board. It uses 

  four I2C based I/O-expanders (PCA9554) to drive the four 7-segment 

  display modules. It includes a font (`aomw_sseg.i`) for the entire ASCII 

  set (although some characters are hard to render on a 7-segment display). 

  This font comes from [Maarten Pennings' GitHub](https://github.com/maarten-pennings/SevenSegment-over-Serial/tree/main/font).



Each module has its own header file, but the library has an overarching 

header `aomw.h`, which includes the module headers. It is suggested that 

users just include the overarching header.



## API



The header [aomw.h](src/aomw.h) contains the API of this library.

It includes the module headers. The headers contain little documentation; 

for that see the module source files. 



### aomw



- `aomw_init()` not really needed, but added for forward compatibility.

- `AOMW_VERSION`  identifies the version of the library.



### aomw_topo



The core functions are `aomw_topo_build()` and `aomw_topo_settriplet(tix,rgb)`.



The API of the topo module can be divided in several parts.

First of all there are the functions to build the topology map.



- `aomw_topo_build()` is the high level function sending multiple telegrams

  to probe the OSP chain and build the topology map. this includes 

  reset and init.

- `aomw_topo_build_start()`, `aomw_topo_build_step()`, and `aomw_topo_build_done()`

  achieve the same as `aomw_topo_build()`, but these only send

  one telegram per call (see below on execution architecture).

  

Secondly, there are functions to query the topology map.



- `aomw_topo_loop()` indicates direction loop or bidir.

- `aomw_topo_numnodes()` returns the number of OSP node, and

  `aomw_topo_node_id(addr)` returns the type of each node.

  `aomw_topo_node_numtriplets(addr)` returns the number of triplets 

  associated with a node, and `aomw_topo_node_triplet1(addr)` the index

  of the first triplet associated to it.

- More important are the triplet functions: `aomw_topo_numtriplets()`

  returns the number of triplets, `aomw_topo_triplet_addr(tix)` returns

  the address of the OSP node driving the triplet, `aomw_topo_triplet_chan(tix)`

  returns the channel number withing the OSP node driving the triplet, and

  `aomw_topo_triplet_onchan(tix)` returns true if the OSP node uses channels.

- Two functions list all I2C bridges:

  `aomw_topo_numi2cbridges()` list the total amount, and 

  `aomw_topo_i2cbridge_addr(bix)` the associated OSP node.

- `aomw_topo_i2cfind(daddr7)` searches all I2C bridges for an I2C device that

  acknowledges a read from I2C device address `daddr7`.



Thirdly, there are functions to print (dump) the topology map.



- `aomw_topo_dump_summary()` prints a one-line summary to `Serial`.

- `aomw_topo_dump_nodes()` prints a table of all OSP nodes to `Serial`.

- `aomw_topo_dump_triplets()` prints a table all triplets to `Serial`.

- `aomw_topo_dump_i2cbridges()` prints a table of all I2C bridges to `Serial`.

- `aomw_topo_dump_power()` prints the max power consumption of the nodes to `Serial`.



Fourthly, there is the high level API to use the topology map to 

control (the color/brightness of) triplets.



- `AOMW_TOPO_BRIGHTNESS_MAX` defines the "topo brightness range" 

  maximum value (0 is the minimum).

- Type `aomw_topo_rgb_t` is a struct with three fields (r/g/b) each supposed 

  to be in the "topo brightness range".

- `aomw_topo_red`..`aomw_topo_white` some stock colors 

  (of type `aomw_topo_rgb_t`).

- Key function `aomw_topo_settriplet(tix,rgb)` sets a triplet `tix` 

  to a color `rgb`. As an extra feature, `rgb` is dimmed down using 

  the global dim level (see `aomw_topo_dim_set`).

- `aomw_topo_dim_set(dim)` and `aomw_topo_dim_get()` allow the caller to set

  a multiplication factor (0..dim/1024) for `settriplet`.



Fifthly, there is a command handler.



- `aomw_topo_cmd_register()` registers the `topo` command with the command 

  interpreter. This makes the topology map and the high level

  `aomw_topo_settriplet()` and `aomw_topo_dim_set()` available through 

  the serial interface.



### aomw_tscript



The tiny animation script interpreter has two high level functions.



- `aomw_tscript_install(*ints,num)` installs a script 

  (i.e. an array of 16 bit instructions) for the interpreter.

- `aomw_tscript_playframe()` plays one frame from the installed script.

  Should be called repeatedly with a constant rate to play the whole

  script with a fixed frame rate. Automatically wraps around.



Lower level functions



- `aomw_tscript_gotofirst()`, `aomw_tscript_gotonext()`, and 

  `aomw_tscript_atend()` form the iterator used by play frame.

- `aomw_tscript_get()` returns the decoded instruction under the 

  cursor (pointer) of the iterator.

- `aomw_tscript_playinst()` plays one instruction (the one under the 

  cursor/pointer of the iterator). Note that one frame could be built-up 

  from multiple instructions via the "with-previous" flag.



Finally this module has some stock scripts.



- `aomw_tscript_rainbow()`, `aomw_tscript_rainbow_bytes()`

- `aomw_tscript_bouncingblock()`, `aomw_tscript_bouncingblock_bytes()`

- `aomw_tscript_colormix()`, `aomw_tscript_colormix_bytes()`

- `aomw_tscript_heartbeat()`, `aomw_tscript_heartbeat_bytes()`



### aomw_flag



The flag module has "painters": functions that paint a pattern on 

the OSP chain, using the `aomw_topo_settriplet()`.



- `aomw_flag_painter_dutch()`

- `aomw_flag_painter_columbia()`

- `aomw_flag_painter_japan()`

- `aomw_flag_painter_mali()`

- `aomw_flag_painter_italy()`

- `aomw_flag_painter_europe()`

- `aomw_flag_painter_usa()`

- `aomw_flag_painter_china()`



Next to that, the painters are also available by index:



- `AOMW_FLAG_PIX_DUTCH`

- `AOMW_FLAG_PIX_COLUMBIA`

- `AOMW_FLAG_PIX_JAPAN` 

- `AOMW_FLAG_PIX_MALI`    

- `AOMW_FLAG_PIX_ITALY`

- `AOMW_FLAG_PIX_EUROPE`

- `AOMW_FLAG_PIX_USA`   

- `AOMW_FLAG_PIX_CHINA`



The index can be used for this (lookup) table.



- `aomw_flag_count()`, `aomw_flag_name(pix)`, and `aomw_flag_painter(pix)`



### aomw_color



The color module has several data types representing colors in different 

color spaces.



- `aomw_color_cxcyiv1_t` and `aomw_color_cxcyiv3_t` 

  CIE x,y coordinates and luminous intensity (Cx,Cy,Iv).

  This is a color space that matches the human eye, it is used to _calibrate_

  LED colors; it is less suited for color _computations_.

  The helper functions `aomw_color_cxcyiv1_to_str()` and 

  `aomw_color_cxcyiv3_to_str()` convert instances to a string.



- `aomw_color_xyz1_t` and `aomw_color_xyz3_t` tristimulus X, Y, Z color space.

  This color space is used by the color _computations_ in this library. 

  The helper functions `aomw_color_xyz1_to_str()` and 

  `aomw_color_xyz3_to_str()` convert instances to a string.



- `aomw_color_mix_t` and `aomw_color_pwm_t` represent duty cycles as 

  fractional numbers (`float`) or as (`uint16_t`) PWM settings.

  The helper functions `aomw_color_mix_to_str()` and 

  `aomw_color_pwm_to_str()` convert instances to a string.



- `aomw_color_poly_t`, `aomw_color_poly1_t` and `aomw_color_poly3_t` 

  represent polynomials that are used to correct a `aomw_color_cxcyiv1/3_t`

  color point when temperature drifts away from the color calibration

  reference temperature.



Calibration data typically comes for fewer drive currents than the SAID 

supports. Therefore, this library provides interpolation functions

`aomw_color_interpolate3()` that interpolates between two 

`aomw_color_cxcyiv3_t`. There is also the helper `aomw_color_interpolate1()`.



Calibration data typically comes for one single reference temperature.

Therefore this library provides temperature correction functions

`aomw_color_poly_apply3()` on `aomw_color_cxcyiv3_t`.  There is also the 

helper `aomw_color_poly_apply1()`.



Calibration data typically comes in the form of `aomw_color_cxcyiv3_t`,

but color computations use `aomw_color_xyz3_t`. This library 

therefore has conversion function `aomw_color_cxcyiv3_to_xyz3()`.

There is also the helper `aomw_color_cxcyiv1_to_xyz1()`.



The color module has two color computation functions.



- `aomw_color_computemix()` computes the mixing ratio of the red, green and

  blue led, in order to reach a target color. It needs the calibration data

  of the triplet for which to compute the mixing ratio.



- `aomw_color_mix_to_pwm()` computes the PWM settings from the mixing ratio.



See section [Color computation](#color-computation) for details on 

the implementation.



### aomw_iox4b4l



This module implements a driver for a "selector".



A selector is an I2C based I/O-expander (PCA9554ABS and PCA6408ABSHP)

connected to 4 buttons and 4 indicator LEDs, providing a simple user 

interface to selected one of four.

Such a selector is present on the SAIDbasic board (PCA6408ABSHP)

and the SAIDsense board (PCA9554ABS).



First, the driver needs to be coupled to an selector:



- `aomw_iox4b4l_present(addr,daddr7)` checks if the I/O-expander 

  with I2C address `daddr7` is on the bus of the OSP node `addr` 

  (SAID with I2C bridge).

- `aomw_iox4b4l_init(addr,daddr7,pincfg)` couples the I/O-expander 

  (with address `daddr7`, attached to the OSP node with address `addr`)

  to the driver.

  This driver is not multi-instance. It can only control one IOX.

  The `pincfg` describes which pin is button or LED and whether it is

  low active or high active.

- There are macros for `daddr7` and `pincfg` for two boards in the eval kit 

  that have a selector: `AOMW_IOX4B4L_DADDR7_SAIDSENSE`, `AOMW_IOX4B4L_PINCFG_SAIDSENSE`

  for SAIDsense and `AOMW_IOX4B4L_DADDR7_SAIDBASIC`, `AOMW_IOX4B4L_PINCFG_SAIDBASIC`

  for SAIDbasic.



To control the indicator LEDs on the selector:



- `aomw_iox4b4l_led_on(leds)`, `aomw_iox4b4l_led_off(leds)`, 

  `aomw_iox4b4l_led_tgl`, and `aomw_iox4b4l_led_set(leds)`

  control the indicator LEDs connected to the I/O-expander.

- `AOMW_IOX4B4L_LEDxxx` are the various masks used for the `leds`

  parameter; they denote one (or zero, or all) indicator LEDs.



To check the buttons on the selector:



- `aomw_iox4b4l_but_scan()` scans all input lines of the I/O-expander 

  (those were the buttons are attached to) and stores the current 

  four button states, maintaining the previous state too.

- `aomw_iox4b4l_but_wentdown(buts)`, `aomw_iox4b4l_but_isdown(buts)`, 

  `aomw_iox4b4l_but_wentup(buts)`, and `aomw4b4l_iox_but_isup(buts)` 

  report the last transition or current button state.

- `AOMW_IOX4B4L_BUTxxx` are the various masks used for the `buts`

  parameter; they denote one (or zero, or all) buttons.



### aomw_eeprom



This module implements a driver for an EEPROM memory.



The EEPROMS used in the OSP evaluation kit are I2C devices storing 1 byte

in 256 locations (AT24C02C). Depending on their position in the system, 

these I2C EEPROMs have a different I2C address. There is an EEPROM on the 

OSP32 board, on the SAIDbasic board and there are stand-alone EEPROM sticks

(that can be plugged into the OSP32 or SAIDbasic board).



For the boards in the eval kit, the I2C addresses of the used EEPROMs are 

already defined:



- `AOMW_EEPROM_DADDR7_OSP32` address of the EEPROM on OSP32 board.

- `AOMW_EEPROM_DADDR7_SAIDBASIC` address of the EEPROM on SAIDbasic board.

- `AOMW_EEPROM_DADDR7_STICK` address of the EEPROM on I2C EEPROM stick.



The access functions have the I2C address as parameter 

(next to the OSP address and the EEPROM memory address):



- `aomw_eeprom_read(...)`    reads bytes from an I2C EEPROM.

- `aomw_eeprom_write(...)`   writes bytes to an I2C EEPROM.

- `aomw_eeprom_compare(...)` reads bytes from an I2C EEPROM and compares them with a buffer.

- `aomw_eeprom_present(...)` checks if an EEPROM is present on an I2C bus.



### aomw_as5600



This module implements a driver for an 

[AS5600 magnetic rotary sensor](https://ams-osram.com/products/sensor-solutions/position-sensors/ams-as5600-position-sensor).



The AS5600 is an I2C sensor, present on the SAIDsense board.



First, the driver needs to be coupled to an I2C device:



- `aomw_as5600_present(addr)` checks if the AS5600 is 

  on the bus of the OSP node `addr` (SAID with I2C bridge).

- `aomw_as5600_init(addr)` couples the AS5600, attached to the OSP node with 

  address `addr`, to the driver.

  This driver is not multi-instance. It can only control one AS5600.

- The macro `AOMW_AS5600_DADDR7_SAIDSENSE` maps to the I2C address of 

  the AS5600 on the SAIDsense board.

  

This is a simple driver, it allows no configuration of the sensor.

It only has two "getters":



- `aomw_as5600_angle_get()` gets the angle measured by the sensor.

- `aomw_as5600_force_get()` gets the magnetic force measured by the sensor.



### aomw_as6212



This module implements a driver for an 

[AS6212 temperature sensor](https://ams-osram.com/products/sensor-solutions/temperature-sensors/ams-as621x-temperature-sensors).



The AS6212 is an I2C sensor, present on the SAIDsense board.



First, the driver needs to be coupled to an I2C device:



- `aomw_as6212_present(addr)` checks if the AS6212 is 

  on the bus of the OSP node `addr` (SAID with I2C bridge).

- `aomw_as6212_init(addr)` couples the AS6212, attached to the OSP node with 

  address `addr`, to the driver.

  This driver is not multi-instance. It can only control one AS6212.

- The macro `AOMW_AS6212_DADDR7_SAIDSENSE` maps to the I2C address of 

  the AS6212 on the SAIDsense board.

  

This is a simple driver, it allows only configuration of the conversion

rate and has one "getters":



- `aomw_as6212_temp_get()` gets the temperature measured by the sensor.

- `aomw_as6212_convrate_set(...)`, `aomw_as6212_convrate_get()` sets and 

   gets the conversion rate.



### aomw_sfh5721



This module implements a driver for an 

[SFH5721 ambient light sensor](https://ams-osram.com/products/sensor-solutions/ambient-light-color-spectral-proximity-sensors/osram-chip-led-sfh-5721).



The SFH5721 is an I2C sensor, present on the SAIDsense board.



First, the driver needs to be coupled to an I2C device:



- `aomw_sfh5721_present(addr)` checks if the SFH5721 is 

  on the bus of the OSP node `addr` (SAID with I2C bridge).

- `aomw_sfh5721_init(addr)` couples the SFH5721, attached to the OSP node with 

  address `addr`, to the driver.

  This driver is not multi-instance. It can only control one SFH5721.

- The macro `AOMW_SFH5721_DADDR7_SAIDSENSE` maps to the I2C address of 

  the SFH5721 on the SAIDsense board.

  

This is a simple driver, it has one "getter":



- `aomw_sfh5721_als_get()` gets the ambient light measured by the sensor.



### aomw_sseg



This module implements a driver for a quad-segment display as

present on the SAIDsense board.



First, the driver needs to be coupled to an I2C device:



- `aomw_sseg_present(addr)` checks if the display is 

  on the bus of the OSP node `addr` (SAID with I2C bridge).

- `aomw_sseg_init(addr)` couples the display, attached to the OSP node with 

  address `addr`, to the driver.

  This driver is not multi-instance. It can only control one display.

- The macros `AOMW_SSEG_X_DADDR7_SAIDSENSE` map to the I2C address of 

  I/O-expanders that drive the display on the SAIDsense board.

  

There are several ways to write to the display:



- `aomw_sseg_clr()` clears the display, all segments off.

- `aomw_sseg_set(...)` an array of bytes (with 8 bits for each of the segments) determines what is shown.

- `aomw_sseg_print(...)` the passed string is printed - using a built-in font.

- `aomw_sseg_printf(...)` as `printf`.



## Color computation



The module `aomw_color` provides an a reference implementation 

of color computations with the aim to achieve uniform colors

independent of _manufacturing variation_ and independent of LED

_temperature_ at run time. It relies on a data base with 

_color calibration_ data (color points) and _temperature correction_ 

data ("polynomials") per RGB triplet. 



Key input for the color computation is the _target_ color (which includes 

brightness) that must be realized with some source triplet. Other inputs 

are the selected drive current (which may depend on the target color), the 

triplet temperature and the PWM range configured in the driver. 



The diagram below shows the computation steps, all the inputs and the 

database with calibration data. It is annotated (in fixed width font) with 

the names of functions and data types from this library that are needed for 

each step. Some of these are found in module `aomw_color`, others in the

example [`aomw_colordemo`](examples/aomw_colordemo).



![Color computation](extras/aomw_color.drawio.png)



This flow computes the PWM settings for the red, green and blue LED of the 

source triplet so that it emits the target color. 



The example [`aomw_colordemo`](examples/aomw_colordemo) shows how a

calibration database (`caldb`) could be organized:



- The array `caldb_colors[]` stores the color points per RGB triplet for two 

  drive currents. This results in storing three floats (Cx,Cy,Iv) for red, 

  three for green and three for blue, times two (for the drive currents).

  This results in 18 floats per triplet.

  

- Given a triplet index and a drive current, the `caldb` interpolates between

  the two stored drive currents to obtain (Cx,Cy,Iv) for red, green and blue.



- The array `caldb_polys[]` stores the temperature dependencies (via a second 

  degree polynomial) per RGB triplet. This results in storing two float

  polynomial coefficients (a,b) per color space component (Cx,Cy,Iv) for red, 

  three for green and three for blue. This results in another 18 floats per 

  triplet. The `aomw_colordemo` also shows a solution that uses one generic

  polynomial instead of per triplet.



- The next step is to use the actual triplet temperature, and polynomial

  to compute the temperature shift of the color points.

  

- All these computations are in the `cxcyiv3` domain, the last abstraction

  the calibration database in `aomw_colordemo` makes is to convert to the 

  XYZ color space.



- The database exposes one function `void caldb_get(tix,current,tempc,*triplet)`,

  where `tix` is the triplet index, `cur` is the drive current, `tempc`

  the triplet temperature, and `triplet` is an output parameter returning 

  the calibration parameters.

  

- The calibration database could also expose the temperature correction 

  polynomials for a _post_ mixing temperature correction approach. See

  [`aomw_colormath`](examples/aomw_colormath) for an example.



Once the calibration database supplies the color point of a triplet,

the function `aomw_color_computemix()` computes the mixing ratios for that

triplet to reach a specified target color. A step is `aomw_color_mix_to_pwm()`

which maps the mixing ratios to 14, 15 or 16 bit PWM driver.



## Execution architecture



One aspect in this library touches the topic of execution architecture. 

The topo build (`aomw_topo_build()`) sends multiple telegrams

to probe the OSP chain and build the topology map. Running this is 

one go would block other tasks (e.g. checking button presses or

receiving commands via serial) for a too long time.



Therefore, `aomw_topo_build()` has been split in three parts 

(`aomw_topo_build_start()`, `aomw_topo_build_step()`, and 

`aomw_topo_build_done()`). These functions send one telegram per call. 

This is more suitable when other time critical

tasks need to be executed as well.



## Commands



The topo module also has a command handler that can be registered with the 

command interpreter. This makes the topology map and the high level

`aomw_topo_settriplet()` available through the serial interface.



```cpp

// Pick commands that we want in this application

void cmds_register() {

  aocmd_register();           // include all standard commands from aocmd

  aomw_topo_cmd_register();   // include the topo command

  Serial.printf("cmds: registered\n");

}



void setup() {

  // Identify over Serial

  Serial.begin(115200);



  // Initialize all libraries

  aospi_init(); 

  aoosp_init();

  aocmd_init();

  aoui32_init();

  aomw_init();



  cmds_register();

  ...

}



void loop() {

  // Process incoming characters (commands)

  aocmd_cint_pollserial();

  ...

}

```



Note that the command `topo enum` is more powerful than `osp enum`;

it is "query-able".



## Version history _aomw_



- **2026 April 29, 1.0.1**

  - Versions printout now separated with `,` (in examples).

  - Documentation improved in `aomw_sfh5721.cpp`.

  - Bug fix: reorder do/print in `aomw_flag.ino`.

  

- **2025 September 17, 1.0.0**

  - Compatibility **warning** `aomw_iox` module and its demo `aomw_iox.ino` are removed (replaced by `aomw_iox4b4l`).

  - Updated documentation.

  - Added module `aomw_as5600` (magnetic rotary sensor) and example `aomw_as5600.ino` for SAIDsense board.

  - Added module `aomw_as6212` (temperature sensor) and example `aomw_as6212.ino` for SAIDsense board.

  - Added module `aomw_iox4b4l` (I/O-expander with 4 buttons and 4 LEDs) and example `aomw_iox4b4l.ino` for SAIDsense board.

  - Added module `aomw_sfh5721` (ambient light sensor) and example `aomw_sfh5721.ino` for SAIDsense board.

  - Added module `aomw_sseg` (quad 7-segment display) and example `aomw_sseg.ino` for SAIDsense board.

  - Added demo `aomw_toposkip.ino`.

  - Topo builder now skips a triplet if SKIPCHNx is set in OTP; also does not set current for skipped channels.



- **2025 May 21, 0.5.0**

  - Added link to examples.

  - Added module `aomw_color` with an examples `aomw_colormath.ino` and `aomw_colordemo`; updated `readme.md` accordingly.

  - Added `aomw_topo_dump_power()` also as part of `topo enum` command.

  - Fixed commented code in `aomw_eeprom_compare()`.

  - Fix: made `aomw_topo.h` self contained: added `#include `.

  - Added OSP32 v12 names for LEDs (e.g. L1.0 aka OUT0).

  - Documented the used max PWM.

  

- **2025 March 3, 0.4.3**

  - Extended memory for topo to cover largest possible OSP chain.

  - Fixed typos in doc and code.

  - Fixed links to apps.



- **2024 November 29, 0.4.2**

  - Renamed some `err` variables to `result`.

  - `aomw_tscript_get()` now has "script installed" assert.

  - Updated API documentation of tscript.

  - Updated `readme.md` and some sources (typos, signaling -> indicator; I/O-expander).

  

- **2024 October 8, 0.4.1**

  - Fixed parsing problems Doxygen.

  - Prefixed `modules.drawio.png` with library short name.

  - Updated topology and tiny script documentation (in cpp files).

  - Fixed doc on "under voltage".

  - Moved domain from `github.com/ams-OSRAM-Group` to `github.com/ams-OSRAM`.

  - Term cleanup ("indicator LEDs" and "I/O-expander").

  - Fixed bug in `walk` animation in `aomw_tscript.ino`.

  - Fixed HARDWARE description in `aomw_iox.ino`.

  - Fixed ADDR bug and added printf with used device address in `aomw_eeprom.ino`.

  - `aomw_flag.ino` now also shows how to use iterator.

  - Update to `readme.md`.

  - Added BEHAVIOR section to explanation in examples.



- **2024 September 5, 0.4.0**

  - API section in readme now shows parameter names.

  - Adapted to `aoosp_exec_resetinit` not needing `last` and `loop`.

  - Introduced "topo brightness range".

  - Warning to run `topo build` first.

  - More uniform error messages in command `topo`.

  - Added color `aomw_topo_off`.

  - Moved from shorthand `bix` to `iix` for "I2C bridge index".

  - Added links in `readme.md` for all example sketches.

  - added `name` to `aomw_topo_rgb_t`.

  - Example `aomw_min` added.

  - Corrected link to GitHub from aotop to OSP_aotop.

  - Remove "oalib" from `sentence=` in `library.properties`.

  - Arduino name changed from `OSP Middleware - aomw` to `OSP Middleware aomw`.

  - Renamed dir `extra` to `extras`.

  - `license.txt`, `examples\xxx.ino` line endings changed from LF to CR+LF.



- **2024 July 02, 0.3.0**  

  - Initial release candidate.



(end)