aboutsummaryrefslogtreecommitdiff
path: root/README.rst
blob: e4d69a0c401c7433fbf5b7e8c1432b19888b518d (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
=====================
 Granddaughter Clock
=====================

Hardware
========

* Raspberry Pico2W
* 12 RGB LED ring

Dependencies
============

The following modules from the `Adafruit library bundle
<https://circuitpython.org/libraries>`_ are used and need to be in the
``lib`` directory on the board.

* ``adafruit_connection_manager.mpy``
* ``adafruit_minimqtt``
* ``adafruit_ntp.mpy``
* ``adafruit_ticks.mpy``
* ``neopixel.mpy``

plus the python version of `my own HSV to RGB library
<https://git.trueelena.org/electronics/colours/tree/python/colours.py>`_

* ``colours.py``

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.