This script adds MQTT discovery support for Shellies. It works with Shelly1, Shelly1PM, Shelly2, Shelly2.5, Shelly4Pro, Shelly Plug, Shelly Plug S, Shelly H&T, Shelly Smoke, Shelly Sense, Shelly RGBW2 (color and white mode) and without configuration it adds entities to Home Assistant.
Download: https://github.com/bieniu/home-assistant-config/blob/master/python_scripts/shellies_discovery.py
How to install python_script: https://www.home-assistant.io/components/python_script/
This is screenshots with Home Assistant Integrations:
Arguments:
-
discovery_prefix- discovery prefix in HA, default âhomeassistantâ, optional -
id- Shelly ID (required) -
mac- Shelly MAC address (required) -
fw_ver- Shelly firmware version (optional) -
temp_unit- C for Celsius, F for Farenhait, default C (optional) - list of shelies id relays and components for them
Default configuration:
Automations:
- id: shellies_announce
alias: 'Shellies Announce'
trigger:
- platform: homeassistant
event: start
action:
service: mqtt.publish
data:
topic: shellies/command
payload: announce
- id: 'shellies_discovery'
alias: 'Shellies Discovery'
trigger:
- platform: mqtt
topic: shellies/announce
action:
service: python_script.shellies_discovery
data_template:
id: '{{ trigger.payload_json.id }}'
mac: '{{ trigger.payload_json.mac }}'
fw_ver: '{{ trigger.payload_json.fw_ver }}'
If you want the relay to be a other component than the switch in the Home
Assistant, you have to add a description of the relay and its function to the
script configuration.
For example:
- id: 'shellies_discovery'
alias: 'Shellies Discovery'
trigger:
- platform: mqtt
topic: shellies/announce
action:
service: python_script.shellies_discovery
data_template:
id: '{{ trigger.payload_json.id }}'
mac: '{{ trigger.payload_json.mac }}'
fw_ver: '{{ trigger.payload_json.fw_ver }}'
qos: 2
shellyswitch25-001122-relay-0: 'light'
shellyswitch25-001122-relay-1: 'fan'
shellyswitch-334455: 'cover'
shellyrgbw2-AABB22: 'white'
shellyrgbw2-CC2211: 'rgbw'
qos - maximum QoS level of the topics, this is optional argument, default is 0 (integer)
shellyswitch25-001122-relay-0: 'light' - means that relay 0 of shellyswitch25-001122 will use light component in Home Assistant. You can use switch, light or fan.
shellyswitch25-001122-relay-1: 'fan' - means that relay 0 of shellyswitch25-001122 will use fan component in Home Assistant. You can use switch, light or fan.
shellyswitch-334455: 'cover' - means that Shelly2 works in roller mode and use cover component in Home Assistant.
shellyrgbw2-AABB22: 'white' - means that Shelly RGBW2 works in white-mode
shellyrgbw2-CC2211: 'rgbw' - means that Shelly RGBW2 works in color-mode (default)
If you already have Shellies configuration before using the script, you should delete it. After installing the script and adding automations, run Shellies Announce automation or restart Home Assistant.
If you change the component type for the relay you have to remove the old entities in Settings -> Entity Registry and restart the Home Assistant.
Script supports custom_updater component. Add this to your configuration and
stay up-to-date.
custom_updater:
track:
- python_scripts
python_script_urls:
- https://raw.githubusercontent.com/bieniu/home-assistant-config/master/python_scripts/python_scripts.json
