Shelly for Home Assistant (built-in integration)

About

Shelly is a built-in integration that connects Shelly devices to Home Assistant over the local network. It is set up in the UI, and Home Assistant can discover devices on the network and offer to add them, or a host address can be entered by hand. Devices appear across many platforms, including sensors, binary sensors, switches, lights, covers, climate, valves, cameras and update entities. Button presses such as single, double, triple and long clicks are exposed as device triggers that can start automations. Two actions read and write values in a device's key-value storage. Repair notices appear for devices running outdated or unsupported firmware, and devices that are gone are removed automatically.

Automatic summary of Home Assistant's source code. Something wrong? Get in touch

Supports

Works locally Talks to your devices on your own network. No vendor cloud in between.
Set up in the UI Add it in Settings, Devices and services. Nothing to download.
Found by itself Home Assistant spots it on the network and offers to add it.
Device triggers Its devices can start automations directly.
Cleans up devices Devices that are gone are removed by themselves.
Change settings later Its connection settings can change without removing it.
Platinum quality Home Assistant's own rating of its code and setup experience.
Updated with Home Assistant Ships and updates with every Home Assistant release.

Provides

Lights
Climate
Covers
Valves
Cameras
Media
Switches
Sensors

Setting it up

Home Assistant usually finds it on the network and offers to add it. It can also be added by hand under Settings, Devices and services.

Connect

DeviceSelect a discovered device or enter an address manually.

Enter the address

HostThe hostname or IP address of the Shelly device to connect to.
PortThe TCP port of the Shelly device to connect to (Gen2+).
Verify SSL certificateVerify SSL/TLS certificate when connecting on HTTPS (port 443, Gen2+).

Also asked when changing the connection.

Provision Wi-Fi via Bluetooth

Disable Wi-Fi access point after provisioningFor improved security, disable the Wi-Fi access point after successfully connecting to your network.
Disable Bluetooth RPC after provisioningFor improved security, disable Bluetooth RPC access after Wi-Fi is configured. Bluetooth will remain enabled for BLE sensors and buttons.

Sign in

PasswordPassword for the device's web panel.
UsernameUsername for the device's web panel.

Also asked when signing in again.

Choose a Wi-Fi network

PasswordPassword for the Wi-Fi network.
Wi-Fi networkSelect a Wi-Fi network from the list or enter a custom SSID for hidden networks.

After setup

Bluetooth scanner modeThe scanner mode to use for Bluetooth scanning.

Texts from Home Assistant's source code, Apache License 2.0.

Entities

Binary sensorsCable unplugged, Calibration, Cloud, Door, External input, External power, Flood, Input, Mute, Occupancy, Output, Overcurrent, and 8 more
ButtonsCalibrate, Close, Mute alarm, Open, Self-test, Turn off the screen, Turn on the screen, Unmute alarm
NumbersCurrent limit, External temperature, Left slot intensity, Right slot intensity, Target humidity, Target temperature, Valve position
SelectsMode
SensorsADC, Analog, Analog value, Apparent power, Average temperature, Charger state, Current, Detected objects, Device temperature, Energy consumed, Energy returned, Energy, and 34 more
SwitchesPrivacy, Charging, Child lock, Away mode, Frost protection, Left slot, Left slot boost, Motion detection, Right slot, Right slot boost, Thermostat enabled, Valve opened
UpdatesBeta firmware, LoRa add-on firmware
ValvesValve

Actions

Get Shelly KVS valueGets a value from a Shelly device's Key-Value Storage.Fields: Device, Key
Set Shelly KVS valueSets a value in a Shelly device's Key-Value Storage.Fields: Device, Key, Value

Troubleshooting

DiagnosticsDownloads a diagnostics file to attach to a bug report.
Repair noticesNotices it can show in Settings, Repairs:Is running unsupported firmware, Is running outdated firmware