infoLED module

Description

Based on a Neopixel LED or LED chain a basic feedback element is created, making simple information like connection status or motor states accessible to users by color and sequence of the LEDs. Note that all timed patterns return to an off state by default in order to minimize disruption of optical experiments

Settings

setting	type	default	range	description
pin	integer	32	> 0	number of the pin the LED is connected to
pixel	integer	12	> 0	number of pixels the LED chain holds

Command Keys

key	type	range	description
hold	boolean	–	keep the LEDs on after a timed pattern has expired if set to true; false will instantly turn off all LEDs
color	String	–	specify the color to be displayed[1]
const	integer	≥ 0	turn on all LEDs for the specified time (in ms)
pulse	integer	≥ 0	all LEDs pulse in intensity for the specified time (in ms)
cycle	integer	–	successively turn on all LEDs; all LEDs are on after the specified time (in ms)[2]

1. ↑formated as HTML color string (e.g. #FF00FF represents magenta $\color{magenta}\blacksquare$). Colors are converted to HSV color space. Note that the value (brightness) is discarded and replaced with a default to obtain a uniform look and avoid overly bright LEDs
2. ↑ LED will cycle in positive direction (clockwise) if the duration is positive and in negative direction (counterclockwise) if negative

Status

This module does not provide a status.

Events

This module is passive and does not emit events.

Status LED

While the ESP32 is still establishing the connection to the server, all infoLED modules automatically display the current connection status:

color pattern	meaning
constant red $\color{red}\blacksquare$	WiFi disconnected
constant yellow $\color{orange}\blacksquare$	WiFi connected, socket.io disconnected
flashing yellow $\color{orange}\blacksquare$	socket.io connected, waiting for authentication
constant green $\color{green}\blacksquare$, then off	socket.io authenticated