From 85077ba6152de29228dbdc6d163d6f857267662a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Franti=C5=A1ek=20Boh=C3=A1=C4=8Dek?= Date: Wed, 21 Jun 2023 17:29:54 +0200 Subject: [PATCH] docs: add basic README --- README.md | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000000000000000000000000000000000000..927ab671ee8eaded75d24270805b72ed17bcd1d8 --- /dev/null +++ b/README.md @@ -0,0 +1,21 @@ +WIP. + +This is a small project project that is made for a board made by LaskaKit (https://github.com/LaskaKit/LED_Czech_Map/), +it has 72 LEDs (WS2812B). This project is written in Rust. + +## Aim +Make a command handler and an animation manager. +Allow to send commands using uart and react to them with +chaning states of the LEDs. + +There should be commands for starting animations, such as rainbow or a point moving. + +## Progress +Currently there is a command handler, +the following commands are available: + - HELLO_WORLD - respond with Hello world! + - SET \ \ \ \ - Sets the given LED to the given color (255 max). The LED may be specified by an index or by city name. Spaces in names should ber replaced with "_" + - RESET - reset all LEDs + - ALL \ \ \ - set all LEDs to this color + +Animations are not finished yet. \ No newline at end of file