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.2.tar.gz (9.4 kB view details)

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: mqttled-0.1.2.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.2.tar.gz
Algorithm Hash digest
SHA256 eb94af853605f4f1ea3c34b66e2f84f3d9845d795529ae8429feb954e74876d7
MD5 7c5b8e7c18651e463e831784a63d3901
BLAKE2b-256 bd261215ac76bcae38631ad3de0a68bfe813004dec275d26021b28b509ece075

See more details on using hashes here.

Provenance

File details

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

File metadata

  • Download URL: mqttled-0.1.2-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.2-py3-none-any.whl
Algorithm Hash digest
SHA256 64b99d1988b3a757a3117c5f9e3520dda9780d88527cd4e4ae7433df7bc4c27f
MD5 dd9e1d07b764f3fd32ecaeb1da496ffe
BLAKE2b-256 2464054a5804f55ce24ef9a21630a72a407bfef6539edc17f2c84608c9fdfdfc

See more details on using hashes here.

Provenance

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