webapi: Switch configuration from TOML to YAML

.gitignore

@@ -7,6 +7,7 @@
 
 .env
 Rustmas.toml
+Rustmas.yaml
 
 webui/dist
 

Rustmas.example.yaml

@@ -0,0 +1,31 @@
+# path to an sqlite database, for parameter storage
+database_path: db.sqlite
+
+controller:
+  # path to CSV file with light positions
+  points_path: lights.csv
+
+  # path to the [animation plugins directory](../animations/README.md)
+  plugin_path: target/animations/
+
+  # you can specify multiple light endpoints
+  # if you don't want to use actual lights and just want to use the visualizer, define empty lights
+  # lights: []
+  lights:
+    # URL of the pico-w-neopixel-server endpoint over HTTP
+    - remote: http://192.168.0.2
+      # In case your lights expect a different byte order for color triplets,
+      # you can overwrite the default RGB ordering. Supported values are RGB (default), GRB and BGR.
+      byte_order: GRB
+
+    # URL of the pico-w-neopixel-server endpoint over TCP
+    - remote: tcp://192.168.0.3
+
+    # URL of the pico-w-neopixel-server endpoint over UDP
+    - remote: udp://192.168.0.4
+
+    # to autodetect lights connected via USB
+    - tty: detect
+
+    # to specify lights connected via USB
+    - tty: /dev/usb.tty0

animations/README.md

@@ -15,7 +15,7 @@ cd animations
 
 This will build, package and gather all the starting plugins under `target/animations/`
 in the root of the Rustmas repository. You can then point your Web API to
-that directory by setting `plugin_path` in `Rustmas.toml` to `target/animations/`.
+that directory by setting `plugin_path` in `Rustmas.yaml` to `target/animations/`.
 
 
 Docker
@@ -38,7 +38,7 @@ cargo install --path animation-wrapper
 ```
 
 Running this utility will produce a `.crab` file, which then needs to be copied
-to the `plugin_path` directory specified in `Rustmas.toml`.
+to the `plugin_path` directory specified in `Rustmas.yaml`.
 
 **Note:** adding a new animation will require you to refresh animation list by going
 into *Settings* -> *Animations* in WebUI. Modifying an existing animation will 

docker/README.md

@@ -12,11 +12,11 @@ the project. You can use the provided example file [`lights.csv.example`](../lig
     ```
 
 2. Rustmas configuration file. You can copy the provided 
-[`Rustmas.example.toml`](../Rustmas.example.toml) file to `Rustmas.toml` in 
+[`Rustmas.example.yaml`](../Rustmas.example.yaml) file to `Rustmas.yaml` in 
 the root directory and tweak the example settings.
 
     ```
-    cp Rustmas.example.toml Rustmas.toml
+    cp Rustmas.example.yaml Rustmas.yaml
     ```
 
 3. An empty sqlite database file. The Web API runs appropriate migrations 

docker/compose.yaml

@@ -10,5 +10,5 @@ services:
       - "8081:8081"
     volumes:
       - ../db.sqlite:/rustmas/db.sqlite:rw,z
-      - ../Rustmas.toml:/rustmas/Rustmas.toml:z
+      - ../Rustmas.yaml:/rustmas/Rustmas.yaml:z
       - ../lights.csv:/rustmas/lights.csv:z

webapi/DEPLOYMENT.md

@@ -72,13 +72,17 @@ a Raspberry PI, you will likely only need to modify the WorkingDirectory and Exe
 point to the right place (the example file assumes the repository is located at `/home/pi/rustmas`)
 and lights URL.
 
-Create a `Rustmas.toml` file in the working directory specified in the service configuration file.
-You can copy the [`Rustmas.example.toml`](../Rustmas.example.toml) file and adjust it as needed.
+Create a `Rustmas.yaml` file in the working directory specified in the service configuration file.
+You can copy the [`Rustmas.example.yaml`](../Rustmas.example.yaml) file and adjust it as needed.
 
 ```
-cp Rustmas.example.toml Rustmas.toml
+cp Rustmas.example.yaml Rustmas.yaml
 ```
 
+> [!NOTE]
+> In previous versions of Rustmas we suggested providing the configuration in a TOML file,
+rather than a YAML file. These should still work, but the use-case is no longer actively supported.
+
 Before running the service, you will need to build the WebAPI:
 
 ```

webapi/README.md

@@ -64,12 +64,12 @@ cp db.sqlite.example db.sqlite
 
 ### Configuration file
 
-In order to run WebAPI locally, you need to create a Rustmas.toml file.
-You can find an example with options explained in the [Rustmas.example.toml](../Rustmas.example.toml)
+In order to run WebAPI locally, you need to create a Rustmas.yaml file.
+You can find an example with options explained in the [Rustmas.example.yaml](../Rustmas.example.yaml)
 file. Simply make a copy of it and adjust it however you need.
 
 ```
-cp Rustmas.example.toml Rustmas.toml
+cp Rustmas.example.yaml Rustmas.yaml
 ```
 
 ### Building animations