~ruther/map-led-strip

85077ba6152de29228dbdc6d163d6f857267662a — František Boháček 1 year, 9 months ago 9000f2f
docs: add basic README
1 files changed, 21 insertions(+), 0 deletions(-)

A README.md
A README.md => README.md +21 -0
@@ 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 \<ID or NAME\> \<R\> \<G\> \<B\> - 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 \<R\> \<G\> \<B\> - set all LEDs to this color

Animations are not finished yet.
\ No newline at end of file

Do not follow this link