Skip to main content

MQTT control of OpenWRT LEDs with optional Home Assistant Discovery

Project description

MQTTLED

This package allows control of an OpenWRT device's LEDs over MQTT. Configured using UCI or YAML. No changes are made to the existing triggers. Uninstalling will revert to your normal LED triggers.

Config

Normal configuration is done through UCI. The configuration file is:

/etc/config/mqttled

The default configuration looks like this:

config mqtt 'mqtt'
    #MQTT Broker Address
    option host '192.168.1.1'
    option port '1883'
    #May work without this, should bind to all interfaces. Needs to be an interface matching in /etc/config/network
    option interface 'lan'
    option username ''
    option password ''
    #Not tested
    option tls '0'
    option cert ''
    option discovery 'homeassistant'
    #Set your topic here: e.g. OpenWRTleds/CustomDevice/led1
    option basetopic 'OpenWRTleds'
    option subtopic 'CustomDevice'
    #Reported in the 'device' page in Home Assistant
    option model 'OpenWRT Device'

config leds 'leds'
    #Setting this to 1 will ignore any includes
    option includeall '1'
    #excluded LEDs will allways be supressed
    list exclude 'mt76-phy0'
    list exclude 'rt2800soc-phy1::assoc'
    list exclude 'rt2800soc-phy1::quality'
    list exclude 'rt2800soc-phy1::radio'
    #list include 'blue:internet'

config trigger 'triggers'
    #Only triggers listed here will be presented to HA as 'effects'
    list triggers 'none'
    list triggers 'default-on'
    list triggers 'heartbeat'
    list triggers 'timer'

Changes should be made either with UCI e.g.

uci set mqttled.mqtt.host='192.168.1.254'
uci commit

or by editing the config file directly. You will then need to restart the service with

service mqttled restart

Info

Topics

This service will publish a retained message to the discoverytopic/light on start. This will point Homeassistant to the state and availability topics of your device set under basetopic/subtopic. The current state is reported on basetopic/subtopic/ledname/state. The daemon is subscribed to basetopic/subtopic/ledname/set for commands.

Attributes

The mqttled service will expose the LEDs as dimmable using the value set under /sys/class/leds/led#/brightness.

Local Changes

Changes made to LED state on the device are not polled. i.e. any changes you make to the LED states by any other means will not be reflected unless the service is restarted.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

mqttled-0.1.1.tar.gz (9.4 kB view details)

Uploaded Source

Built Distribution

mqttled-0.1.1-py3-none-any.whl (10.3 kB view details)

Uploaded Python 3

File details

Details for the file mqttled-0.1.1.tar.gz.

File metadata

  • Download URL: mqttled-0.1.1.tar.gz
  • Upload date:
  • Size: 9.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.9.13

File hashes

Hashes for mqttled-0.1.1.tar.gz
Algorithm Hash digest
SHA256 22e51c87797ccbd30860f5dff4db7c5d485eec66230a264d1d2066dbd2e1047d
MD5 0bd3217bb8a8be9df7e6154f882a6896
BLAKE2b-256 4caa7dd95b8f81fb86ad02376ca0fb0b08ab8d8efc94befe61b6e00cc1f1d477

See more details on using hashes here.

File details

Details for the file mqttled-0.1.1-py3-none-any.whl.

File metadata

  • Download URL: mqttled-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 10.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.9.13

File hashes

Hashes for mqttled-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 dd9b541d238fdd0a2899f799fddfff66770f5ad575abba1c20c725a65f7f0b63
MD5 db78afeedf60a7cd90ec822e29347618
BLAKE2b-256 9808292841e8569f2fa941ce4d377530cfab9170ae5a6bf2c8830874efb01512

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page