home-assistant.io/source/_integrations/shelly.markdown

title, description, ha_category, ha_release, ha_codeowners, ha_iot_class, ha_domain, featured, ha_config_flow

title	description	ha_category	ha_release	ha_codeowners	ha_iot_class	ha_domain	featured	ha_config_flow
Shelly	Integrate Shelly devices	Binary Sensor Cover Light Sensor Switch	0.115	@balloob @bieniu @thecode	Local Push	shelly	true	true

Integrate Shelly devices into Home Assistant.

Configuration

To add a Shelly device to your installation, make sure they are connected to your Wi-Fi network first. Next, go to Configuration >> Integrations in the UI. If the new device is on the same network as Home Assistant, it is discovered automatically. Clicking "Configure" on the discovered device, adds it to Home Assistant. If your device isn't discovered automatically, click the button with + sign on the integrations page and from the list of integrations, select Shelly and follow the instructions shown.

Integration is communicating directly with the device; cloud connection is not needed.

Entity naming

The integration uses the following strategy to name its entities:

• If Device Name or Channel Name is set in the device, the integration will use them to generate the entities' name.
• If channel names are set, they will be used in the entity names. The device name will not be used.
• If only the device name is set, and the device has multiple channels, the channel number will be appended to the entity name (e.g., Channel 2).
• In case device name and channel names are not set, the entity name will be generated by the Device Type, Device ID and Channel Number.

Examples:

Device Name	Channel Name	Entity Name
Not set	Not Set	shellyswitch25-ABC123 Channel 1
Not set	Kids Room Bulb	Kids Room Bulb
Kitchen	Not Set	Kitchen Channel 1
Bedroom	Round Bulb	Round Bulb

Names are set from the device web page:

• Device name can be set in Settings >> DEVICE NAME
• Channel name for single-channel devices can be set in Settings >> CHANNEL NAME
• Channel name for multi-channel devices can be set in Settings >> CHANNEL NAME after selecting the channel, by clicking on the channel name.

Appliance type

Shelly device relays are added to the Home Assistant by default as switch entities. A relay can be added as a light entity if the device uses firmware version 1.9.0 or newer and the Settings >> APPLIANCE TYPE value is set to light.

Events

If the BUTTON TYPE of the switch connected to the device is set to momentary or detached switch, integration fires events when the switch is used. You can use these events in your automations.

Automation examples

- alias: "Toggle living room light"
  trigger:
    platform: event
    event_type: shelly.click
    event_data:
      device: shellyswitch25-AABBCC
      channel: 1
      click_type: single
  action:
    service: light.toggle
    entity_id: light.living_room

- alias: "Toggle living room lamp"
  trigger:
    platform: event
    event_type: shelly.click
    event_data:
      device: shellyswitch25-AABBCC
      channel: 2
      click_type: long
  action:
    service: light.toggle
    entity_id: light.lamp_living_room

Possible values for click_type

Shelly input event	Click Type
S	single
SS	double
SSS	triple
L	long
SL	single_long
LS	long_single

Not all devices support all input events. You can check on Shelly API Reference website what types of Shelly input events your device supports.

Known issues and limitations

• Only supports firmware 1.8 and later
• Support for RGB devices is limited
• Support for battery-powered devices is limited (also applies to USB powered Shelly H&T)