MQTT
LED Control

LED Control

⚠️
NOTE: This part of the API is still under construction, yet the interface as described below is expected to be somewhat stable.

Control the RGB LEDs on the device via MQTT.

Topic

Publish to: api_client/<client_name>/<location_id>/<device_id>/led/set

Payload 

{
  "animation": "breathe",
  "red": 255,
  "green": 255,
  "blue": 255,
  "brightness": 255,
  "durationMilliseconds": 3000
}
  • animation: Type of animation to apply to the LEDs. Possible values include:
    • on: Turn on the LEDs regardless of rgb and brightness values.
    • off: Turn off the LEDs regardless of rgb and brightness values.
    • breathe: Smoothly cycles between min and max brightness. The brightness value is ignored in this mode.
  • red, green, blue: RGB values for the LED color, each ranging from 0 to 255.
  • brightness: Overall brightness of the LEDs, ranging from 0 to 255.
  • durationMilliseconds: Duration for which the LEDs should remain on, in milliseconds. Set to 0 for continuous illumination until the next command is received.
PowerVitals