Device LED feedback
This document describes the various static LED animations for the Smart Sensor. These animations are shown during:
- boot up
- commissioning
- OTA update
- errors
- state changes
- user-interaction with the button (already covered in the button actions document)
Animation definition
Each animation is defined over a cycle which can be repeated.
The duration of a cycle is left to the implementer to match the animation duration.
Boot-up animations
Following boot-up events are defined in sequence:
| Event | Colour | Animation | Duration |
|---|---|---|---|
| Power-up | Sauter Tri-Colour | Breathing | 1.5s (Total) |
| Network initialization | Orange | Breathing | Until a working mesh or MQTT network is configured. Skipped if configured. |
| Sensor ready / Commissioning done | Green | Blinking | 5s |
Network initialization means either:
- The gateway has received MQTT connection information (Server, port, security)
- A node or a gateway has been provisioned with BLE Mesh network keys
Commissioning animations
Commissioning animations are shown during provisioning of the device with the mobile app.
When user enters the 'Add a new node' screen, unprovisioned devices will be lit up in the same colour as shown in the app.
Before configuring a certain device, breating animation will also be shown just to double-check that the right device is selected.
Upon successful provisioning, the device will show a blinking green animation for 5 seconds.
OTA update animations
OTA update animations are shown during OTA update of the device.
| Event | Colour | Animation | Duration |
|---|---|---|---|
| Device is awaiting firmware update | Orange | Chasing | Until update |
| OTA update failed | Red | Chasing | 1h |
A device awaiting update timeouts after 10 minutes and then soft reboots.
If the device reboots due to timeout (meaning the OTA update was not successful), after booting the device will display a red chasing animation for an hour (instead of a green blinking animation indicating that the device is provisioned).
Error animations
| Event | Colour | Animation | Duration |
|---|---|---|---|
| Internal error - Service needed | Red | Blinking | Until reboot |
| -> failed initialization of BLE Mesh Server or Client | |||
| -> failed initialization of sensors (hardware problem) | |||
| Lost communication (Mesh or MQTT) | Orange | Blinking | Until communication is restored |
Communication loss is not enforced during firmware update mode. A loss of communication can be either:
- No longer connected to an MQTT broker
- A node is no longer communication with the BLE Mesh Network.
State changes
NFC Tap animation is shown when mobile phone or some other NFC device is close to the NFC antenna of the Smart Sensor.
| Event | Colour | Animation | Duration |
|---|---|---|---|
| NFC Tap (if powered on) | Turquoise | Breathing once | 500ms |