ESP-LED-MQTT

ESP-LED-MQTT copied to clipboard

Overview

Allows the WiFi control of a WS8212 LED strip using an ESP8266 controller and an MQTT broker. Designed to work well with Home Assistant https://home-assistant.io/.

To use this code simply configure the PIN and NUMPIXELS variables in the NeoPixel section. You will also need to configure the credentials for your WiFi and MQTT broker, see <REDACTED> code. Lastly you can tailor the MQTT topics as required.

Features

• Works well with Home Assistant.
• Includes 9 animations.
• Basic control using simple MQTT commands (e.g. "1" to turn on, "0" to turn off).
• Advanced control using JSON MQTT commands.
• Tweak animation variables without needing to alter code.
• Utilizes a non-blocking reconnect function allowing animations to continue if MQTT or WiFi connection is lost.
• Automatic Recovery - All variables are published as a retained message to a recovery topic. If the ESP is restarted this message is used to return to the previous state.
• Retained Statuses - The state is published as a retained message allowing your hub (e.g. Home Assistant) to grab the current state if it is restarted.
• You can optionally enable ArduinoOTA to make uploading changes easier.

Change Log

19/06/2019

• Config is now in a separate file.
• 2 new animations added.

09/12/2018

• Added support for ArduinoOTA.
• Availability is now published every 30 seconds.

21/11/2018

• Removed brightness control WIP.
• Limited calls to pixels.show() as some were causing a WTD reset.
• Updated MQTT topic variable names in line with Home Assistant.

Dependencies

The following libraries are required and so must be present when compiling.

• Arduino
• ESP8266WiFi
• PubSubClient
• Adafruit_NeoPixel
• ArduinoJson
• ArduinoOTA.h (if ArduinoOTA enabled)
• WiFiUdp.h (if ArduinoOTA enabled)
• ESP8266mDNS.h (if ArduinoOTA enabled)

Transmission Codes

JSON Example

The message below would turn all LEDs to Blue (Mode = 1, rgbColourTwo = Blue). See tables below for message options.

{0:1,2:[0,0,255]}

Variables

Modes

Home Assistant Examples

light: Basic control of a light.

- platform: mqtt
  name: Lamp
  state_topic: "light/lamp/state"
  command_topic: "light/lamp"
  rgb_state_topic: "light/lamp/rgb/state"
  rgb_command_topic: "light/lamp/rgb"
  availability_topic: "light/lamp/availability"
  payload_not_available: "0"
  payload_available: "1"
  payload_off: "0"
  payload_on: "1"
  retain: false

Note: The recovery topic does not need to be used in the Home Assistant config.

input_select: UI to allow user to trigger an animation.

lamp:
    name: Lamp
    options:
      - "Select..."
      - "Warm Light"
      - "Strobe"
      - "Fire"
      - "Colour Phase"
      - "Sparkle"
      - "Shoot / Drip"
      - "Rain"
      - "Rainbow 1"
      - "Rainbow 2"
    initial: "Select..."

automation: Sends the appropriate MQTT command when a mode is selected and then returns the input select back to 'Select...'

- alias: "Lamp Mode"
  trigger:
    platform: state
    entity_id: input_select.lamp       
  action:
    - service: mqtt.publish
      data_template:
        topic: "switch/stairs"
        payload: >
          {% if trigger.to_state.state == 'Warm Light' %}
            {0:2,2:[255,147,41]}
          {% elif trigger.to_state.state == 'Strobe' %}
            {0:3}
          {% elif trigger.to_state.state == 'Fire' %}
            {0:4}
          {% elif trigger.to_state.state == 'Colour Phase' %}
            {0:5,3:15}
          {% elif trigger.to_state.state == 'Sparkle' %}
            {0:6,2:[50,50,50],3:0,4:5,5:0}
          {% elif trigger.to_state.state == 'Shoot / Drip' %}
            {0:7,2:[255,147,41],8:0,10:1,9:30, 5:0 ,4:255,3:0,12:5,7:0}
          {% elif trigger.to_state.state == 'Rain' %}
            {0:8,11:1100}
          {% elif trigger.to_state.state == 'Rainbow 1' %}
            {0:12}
          {% elif trigger.to_state.state == 'Rainbow 2' %}
            {0:13}
          {% else %}
            {}
          {% endif %}
        retain: false
    - service: input_select.select_option
      data:
        entity_id: input_select.stairlamp_mode
        option: 'Select...'

Contributers

Contributors are welcome.

Thanks to dajomas for spliting out the configuration and adding the Rainbow animations.