Skip to content

Latest commit

 

History

History
69 lines (47 loc) · 2.27 KB

README.md

File metadata and controls

69 lines (47 loc) · 2.27 KB

alt Header of the WLED RH plugin

Project Stage Project Maintenance License

About

This plugin makes it possible to control a WS2812B Matrix display with WLED, through the RotorHazard API events. Please note that this is still an alpha version.

Pre-requisites

  • This plugin only works with Python 3.11 or higher
  • You must install the additional packages in your virtual environment (venv) that are listed in the requirements.txt.

LED behaviour

Event LED behaviour
Start Green
Stop Red
Stage Pulsing blue
Lap Pilot seat color

Installation

  1. Install the WLED RH Plugin like any other plugin ([RH Plugin Documentation][rh-plugin-docs])
sh -c "$(curl -fsSL https://raw.githubusercontent.com/dutchdronesquad/rh-wled/main/tools/install.sh)"
  1. Install the extra PyPi packages from requirements.txt
  2. Restart RotorHazard

Development

To get started, you obviously need a working development environment from RotorHazard.

  1. Fork / Clone the repository
  2. Create a symlink to the wled folder in the RotorHazard plugin folder
ln -s ~/rh-wled/wled/ ~/RotorHazard/src/server/plugins/wled
  1. Start or restart RotorHazard
sudo systemctl restart rotorhazard.service
  1. Start developing 😄

License

Distributed under the MIT License. See LICENSE for more information.