Examples

The firmware tree carries a few modules that exist to be read rather than deployed. Each is one header and one source file, under lib/thesada-mod-example-*/, off in every build until you turn it on. These pages walk through them. If you want to write one from scratch instead, start with Build your first module.

The modules are on the firmware dev branch and ship with the next release; until then, build from dev to try them.

Example Shape Demonstrates
temperature-mqtt sensor a timed read, one publish to MQTT, one to the event bus
remote-relay actuator one shell command reachable over serial, HTTP and MQTT, state published on every change

A third, blink-led, is being contributed and gets its page when it lands.

Turning one on takes two switches, the same as for any module: its ENABLE_EXAMPLE_* line in src/thesada_config.h, and "enabled": true in its config.json block.


Table of contents


Thesada - AGPL-3.0-only (app) / GPL-3.0-only (firmware) / CC BY-NC-SA 4.0 (docs) - License

This site uses Just the Docs, a documentation theme for Jekyll.