Initial commit

.gitignore

@@ -0,0 +1,2 @@
+*~
+.*

LICENSE

@@ -0,0 +1,19 @@
+Copyright 2022 Nils Freydank <nils.freydank@datenschutz-ist-voll-doof.de>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

README.rst

@@ -0,0 +1,28 @@
+rpi-pico-candle / Little christmas candle
+=========================================
+
+The rpi-pico-candle project uses a real candle or any similar structured and
+shaped object and adds some LED to simulate flickering candle light aswell as
+a PWM-driven piezo for somewhat-nerdy christmas music.
+
+The code is written in python and should run on the `micropython port`_ for the
+rpi pico boards. (Note that circuitpython exists, too, but is not supported
+by this project.)
+
+To put files on the pico board you can use e.g. the tool `adafruit-ampy`_.
+The file :code:`main.py` is executed first.
+
+Music data are stored as JSON files in a custom format which sets the note's
+name plus the interval, e.g. c4 and _q for a quarter note.
+
+Note that the names use the German naming, which means that ’b’ is ’h’ and
+’bb’ is ’b’. Details can be found inside the file `music.py`.
+
+At startup the software plays a version of the German christmas song
+`’O Tannenbaum’`_.
+
+.. _`micropython port`: https://micropython.org/download/rp2-pico/#
+.. _`adafruit-ampy`: https://pypi.org/project/adafruit-ampy/
+.. _`’O Tannenbaum’`: https://en.wikipedia.org/wiki/O_Tannenbaum
+
+.. vim:fileencoding=utf-8:ts=4:syntax=rst:expandtab