Skip to content

Latest commit

 

History

History
79 lines (67 loc) · 2.8 KB

DOCS.md

File metadata and controls

79 lines (67 loc) · 2.8 KB
Raw

Requirements

In order to use this addon you'll need a few things.

MQTT Server

We use the Mosquitto broker from Home Assistants Official add-ons. You can find this in your Supervisors Add-on Store. You'll need to configure a username and password for MQ Light Show to use.

Tasmota Enabled Lights

Many types of hardware can be flashed with the Tasmota firmware. You can find bulbs that already have Tasmota on Amazon or Aliexpress. https://www.aliexpress.com/wholesale?SearchText=tasmota

Installation

Go to your Home Assistant Supervisor then go to the Add-on Store tab. From there you can click the drop down on the top right and select 'Repositories'. Add this repository: https://github.com/lovesway/hassio-addons

Once you've added the repository you should be able to scroll down and find the MQ Light Show application under the Love's Way Home Assistant Add-ons. Go inside the addon and click install. After it installs you'll need to click the configuration tab and enter your details. You should then be able to start the application and open the web UI to see the interface.

In the interface you'll need add your devices, create at least one scene and finally create a light show including one or more scenes.

Examples

Adding LightShows to Home Assistant

This is example code that would go into the configuration.yaml

switch:
  - platform: mqtt
    name: "Light Show Full Ranch Fade"
    state_topic: "mqlightshow/show/full_ranch_fade/stat"
    command_topic: "mqlightshow/show/full_ranch_fade/cmnd"
    payload_on: "ON"
    payload_off: "OFF"
    state_on: "ON"
    state_off: "OFF"
    optimistic: false
    qos: 0
    retain: true
  - platform: mqtt
    name: "Light Show Predator"
    state_topic: "mqlightshow/show/predator/stat"
    command_topic: "mqlightshow/show/predator/cmnd"
    payload_on: "ON"
    payload_off: "OFF"
    state_on: "ON"
    state_off: "OFF"
    optimistic: false
    qos: 0
    retain: true

The Entities card configuration example would look like this.

entities:
  - entity: switch.light_show_full_ranch_fade
  - entity: switch.light_show_predator
show_header_toggle: false
title: Light Shows
type: entities

Known Limitations

Currently there is only support for Tasmota commands, but the device types are abstracted so that other firmware types/commands could be added.

MQTT configuration only supports %topic%/%prefix%/ vs %prefix%/%topic%/. This could be changed, but at this point it is a known limitation.

There is no support for importing/exporting or backing up the database. This is partially due to each isntallation having different devices, but I'm sure there are solutions for all of that. What is possible, is backing up ther sqlite.db manually or even accessing it via cli sqlite. This file is likely located somewhere in /usr/share/hassio/addons/data.