Skip to content

Latest commit

 

History

History
216 lines (163 loc) · 5.57 KB

README.md

File metadata and controls

216 lines (163 loc) · 5.57 KB
Raw

led-firmware

Make sure you have a board with a WLAN module.

Installation of MicroPython for ESP8266 Boards

Tutorial: https://docs.micropython.org/en/latest/esp8266/tutorial/intro.html

Download for ESP8266: http://micropython.org/download/#esp8266

Installation of MicroPython for Arduino Nano RP2040 Connect.

Tutorial: http://docs.micropython.org/en/latest/esp8266/tutorial/intro.html#intro

NOTE: The device is normally called /dev/ttyACM0 instead of /dev/ttyUSB0

Download: https://micropython.org/download/?port=rp2

Installation of MicroPython for ESP32 Boards

Tutorial: http://docs.micropython.org/en/latest/esp32/tutorial/intro.html#esp32-intro

Download: https://micropython.org/download/esp32/

General

This project is built with micropython for either the ESP8266 NodeMCU, ESP32 NodeMCU or in the future with micropython for the Arduino Nano RP2040H.

Known Issues

  1. Implementation of the HEAD function is missing
  2. Implement Content-Type: application/json for Requests.
  3. Implement Accept: for Requests.
  4. Moar Animations
  5. Implement a way of streaming the current colour of each LED of the connected stripe.

How-To Start

The initial main file is the boot.py. From there it is separated by api objects and handling the http server and the led driver as well as the store module.

.
├── README.md
├── apiserver
│   ├── __init__.py
│   ├── api.py
│   ├── constants.py
│   ├── objects
│   │   ├── __init__.py
│   │   ├── animation.py
│   │   ├── hsl.py
│   │   ├── response.py
│   │   └── rgb.py
│   └── util.py
├── boot.py
├── driver
│   ├── __init__.py
│   ├── animations
│   │   ├── __init__.py
│   │   ├── base.py
│   │   ├── breath.py
│   │   ├── manual.py
│   │   ├── normal.py
│   │   ├── off.py
│   │   └── snake.py
│   ├── constants.py
│   ├── led.py
│   ├── store.py
│   └── util.py
├── pymakr.conf
├── secure.py
└── webserver
    ├── __init__.py
    └── http.py

The Store Module

driver.store.Store is handling all the state keeping between reboots. This keeps the colours and necessary data from the animations persisted onto the Microcontroller. It does that by reading every 240 ticks the json file and comparing it with the current state. If the state changed it dumps it back to disk. This is working as redisdump.

The LEDDriver

driver.led.LedDriver is handling the LEDs. It manages the setting of LEDs which animation is currently in control and also what animations are registered and available to the driver.

Animations

snake

This is an animation which runs a connected length of leds through the led strip. It stores the steps between each tick the length of the snake and the colour.

breath

This is an animation which pulses between different colours. It stores up to 6 colours and transitions between them.

off

This shows always RGB(0,0,0). The off state.

normal

This is a normal colour selector which sets the colour of all LEDs at once and is persisted between reboots.

manual

This mode is automatically activated when the /leds/ and the /leds/{unit} endpoint is used. It does nothing directly with the LEDs except displaying the current state of each NeoPixel.

API

RGB Object

{
    "green": 0,
    "blue": 128,
    "red": 135
}

HSL Object

// this is missing and only internally used currently.
// RGB is convertible to HSL and it also works the other way around.

Animation Object

// animation.SUPPORTED = ["normal", "snake", "breath", "off", "manual"]
{
    "animation": "snake"
}

:: [GET,POST] /leds/?

Gets and sets all LEDs.

export ENDPOINT=127.0.2.1
curl -X GET "$ENDPOINT/leds"
{"error": "scraping data of all leds is not supported"}
export ENDPOINT=127.0.2.1
curl -d '{ "red": 0, "green": 255, "blue": 0}' -X POST "$ENDPOINT/leds"
{"green": 255, "blue": 0, "red": 0}

:: [GET,POST] /leds/{unit}/?

Gets and sets LED by unit.

export ENDPOINT=127.0.2.1
curl -X GET "$ENDPOINT/leds/0"
{"green": 255, "blue": 0, "red": 0}
export ENDPOINT=127.0.2.1
curl -d '{ "red": 0, "green": 255, "blue": 0}' -X POST "$ENDPOINT/leds/0"
{"green": 255, "blue": 0, "red": 0}

:: [GET] /lens/?

export ENDPOINT=127.0.2.1
curl -X GET "$ENDPOINT/lens"
{"first": 0, "last": 143}

:: [GET,POST] /animation/?

export ENDPOINT=127.0.2.1
curl -X GET "$ENDPOINT/animation"
{"animation": "manual"}
export ENDPOINT=127.0.2.1
curl -d '{"animation": "snake"}' -X POST "$ENDPOINT/animation"
{"animation": "snake"}

:: [GET,PUT] /animation/{Animation.SUPPORTED}/?

export ENDPOINT=127.0.2.1
curl -X GET "$ENDPOINT/animation/snake"
{"colour": {"green": 0, "blue": 128, "red": 135}, "steps": 1, "length": 53}
export ENDPOINT=127.0.2.1
curl -d {"steps": 2} -X PUT "$ENDPOINT/animation/snake"
{"colour": {"green": 0, "blue": 128, "red": 135}, "steps": 2, "length": 53}
curl -d {"steps": 2} -X PUT "$ENDPOINT/animation/snake"
{"error": "Nothing useful provided for update!"}