aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorElena ``of Valhalla'' Grandi <valhalla@trueelena.org>2025-03-14 08:38:43 +0100
committerElena ``of Valhalla'' Grandi <valhalla@trueelena.org>2025-03-14 08:38:43 +0100
commit9ad87e3baa2b19303e05abaf2ae93ea0651e2d97 (patch)
treeb1a3da942ca54020721a5c98af4520a335ad8b75
parentd268db641278659e1bc85bb11e373e4eab60ec17 (diff)
Document the settings.toml
-rw-r--r--README.rst19
1 files changed, 19 insertions, 0 deletions
diff --git a/README.rst b/README.rst
index 2e39e3e..54d029b 100644
--- a/README.rst
+++ b/README.rst
@@ -7,3 +7,22 @@ Hardware
* Raspberry Pico2W
* 12 RGB LED ring
+
+Dependencies
+============
+
+settings.toml
+-------------
+
+the clock requires a ``settings.toml`` with the following variables:
+
+``CIRCUITPY_WIFI_SSID``
+ your wifi ssd
+``CIRCUITPY_WIFI_PASSWORD``
+ your wifi password
+``MQTT_HOST``
+ the mqtt server you want to use
+``MQTT_SENS_FEED``
+ a base topic that receives messages from sensors, with a topic in the
+ form ``MQTT_SENS_FEED/<location>/<type>`` and a numeric value as the
+ payload.