feat: ledlab

README.md

@@ -0,0 +1,23 @@
+# SPORE LEDLab
+
+LEDLab is a tool for streaming animations to SPORE nodes that implement the PixelStreamController.
+
+## Components
+
+### Server
+
+- listens on UDP port 4210 to discover SPORE nodes
+- provides a websocket server API to interact with SPORE nodes over UDP
+- can stream PixelStream presets either directly to a SPORE node or to all nodes using the UDP broadcast address
+- preset parameters can be adjusted / configured on-the-fly directly through websockets
+- if a websocket client is connected (UI), the stream is also sent to the websocket client
+- can forward a stream received from websocket to UDP
+- default matrix size is 16x16 pixels
+
+### Web-UI
+
+- default matrix size can be configured in the UI, default is 16x16 pixel
+- shows canvas of the currently running stream (scaled up); the stream is received over websocket from the server
+- preset selection: select any of the presets defined in the backend to be streamed (by the backend) to one or all SPORE nodes
+- preset configuration: the parameters of a preset can be changed on-the-fly and changes the stream in realtime
+- the UI is based on the spore-ui project and uses the same component framework and styling. components and other required JS files used in spore-ui are just copied over if needed