Shelly Cloud Custom Component for homeassistant

What this is:

This is a custom component to allow control of Shelly Cloud devices in Homeassistant using the official Shelly API in local network. Please note Shelly may cut off access or change the structure at anytime.

What it does:

Allows for control the states of Shelly Cloud products as home assistant sensors with the following features:

• Sensor System
• Sensor Wifi
• Sensor Mqtt
• Sensor Cloud
• Sensor Firmware
• MQTT Cover
• MQTT Switch

Configuration

Download python files

Reproduce the directory structure of the master branch in your config directory custom_components directory to create the folder shelly_cloud. Currently it should look like:

custom_components
  shelly_cloud
    __init__.py
    const.py
    sensor.py
    cover.py
    switch.py
    shelly_data.py

Configure HA

Once there you’ll need to update your config to include the following platform in configuration.yaml:

MQTT Cover will be created automatically only if shelly works in Roller Shutter mode and it is connetted via MQTT

shelly_cloud:
  enabled_components:
    - sensor
    - switch
    - cover
  devices:
    - ip_address: !secret shelly_ip_address

enabled_components
  (list)(Optional) Platorms to configure.
  Available values: sensor, switch, cover
  Default value: All keys

Configuration Variables Each device in devices may have the following settings:

ip_address
  (string)(Required)The IP address or hostname of the Shelly you want to track.

username
  (string)(Optional)Username configurated in _RESTRICT LOGIN_ section of shelly.

password
  (string)(Optional)Password configurated in _RESTRICT LOGIN_ section of shelly.

scan_interval
  (time)(Optional)Minimum time interval between updates. Supported formats: scan_interval: 'HH:MM:SS', scan_interval: 'HH:MM' and Time period dictionary (see example below).
  Default value: 2 minutes

monitored_conditions
  (list)(Optional)Sensors to display in the frontend.
  Default value: All keys
  
  system
    will be created sensor that will expose system informations like mac address, working mode, model name, etc..

  wifi
    will be created sensor that will expose wifi informations like wifi quality (%), ip address, SSID

  mqtt
    will be created sensor that will expose mqtt status

  cloud
    will be created sensor that will expose cloud status

  firmware
    will be created sensor that will expose firmware inofrmations like current and new firmware versione

Example

shelly_cloud:
  enabled_components:
    - sensor
    - switch
    - cover
  devices:
    - ip_address: !secret shelly_ip_address
      username: !secret shelly_username
      password: !secret shelly_password
      name: shelly
      scan_interval:
        - minutes: 2
      monitored_conditions:
        - SYSTEM
        - WIFI
        - MQTT
        - CLOUD
        - FIRMWARE

Configure custom_updater component

After installing the component, configure it as follows:

custom_updater:
  track:
    - components
  component_urls:
# Dev build (unstable)
#    - https://raw.githubusercontent.com/marcogazzola/custom_components/dev/custom_components.json
# Released build
    - https://raw.githubusercontent.com/marcogazzola/custom_components/master/custom_components.json

TIPS

Add the following automation for force MQTT status refresh:

- alias: 'Shelly force status update'
    initial_state: 'on'
    trigger:
      - platform: homeassistant
        event: start
    action:
      - service: mqtt.publish
        data:
          topic: "shellies/command"
          payload: "update"

Changelog

Complete changelog here.

Contribute

License

Apache-2.0. By providing a contribution, you agree the contribution is licensed under Apache-2.0. This is required for Home Assistant contributions.