Control Sonoff Devices from Home Assistant

Home Assistant custom component for control Sonoff devices with eWeLink (original) firmware over LAN and/or Cloud.

New features in version 3.0

• support Integration UI, Devices and Zones
• support new eWeLink API
• support multiple eWeLink accounts and homes
• support many sensors for each device (include RFBridge)
• support thermostats for Sonoff TH ans NS Panel
• support preventing DB size growth
• support many new Hass features

Features from previous versions

• can manage both local and cloud control at the same time!
• support old devices wih 2.7 firmware (only cloud connection)
• support new device types: color lights, sensors, covers
• support eWeLink cameras with PTZ
• support unavailable device state for both local and cloud connection
• support sensors for Sonoff RF Bridge 433
• support ZigBee Bridge and Devices
• added new debug mode for troubleshooting

Pros

• work with original eWeLink / Sonoff firmware, no need to flash devices
• work over Local Network and/or Cloud Server
• work with devices without DIY-mode
• work with devices in DIY-mode
• support single and multi-channel devices
• support TH and Pow device sensors
• support Sonoff RF Bridge 433 for receive and send commands
• support Sonoff GK-200MP2-B Camera
• instant device state update with local Multicast or cloud Websocket connection
• load devices list from eWeLink Servers (with names and encryption keys) and save it locally
• (optional) change device type from switch to light

Component review from DrZzs

There is another great component by @peterbuga, that works with cloud servers.

Thanks to @beveradb and @mattsaxon for researching the local Sonoff protocol.
Thanks to @michthom and @EpicLPer for researching the local Sonoff Camera protocol.

Tested Devices

Almost any single or multi-channel Switch working in the eWeLink application will work with this Integration even if it is not on the list.

Tested (LAN and Cloud)

These devices work both on a local network and through the cloud.

• Sonoff Basic fw 3.0.1
• Sonoff Basic R2
• Sonoff Basic R3
• Sonoff RFR3
• Sonoff Mini (no need use DIY-mode) fw 3.3.0
• Sonoff TH (support Thermostat) fw 3.5.0
• Sonoff 4CH Pro R2 fw 3.3.0
• Sonoff 4CH Pro R3 fw 3.3.0
• Sonoff Pow R2 (show power consumption)
• Sonoff Micro fw 3.4.0
• Sonoff RF Bridge 433 (receive and send commands) fw 3.5.0
• Sonoff D1 (dimmer with brightness control) fw 3.4.0, 3.5.0
• Sonoff G1 fw 3.5.0
• Sonoff Dual
• Sonoff iFan02 (light and fan with speed control) fw 3.3.0
• Sonoff iFan03 and iFan04 (light and fan with speed control) fw 3.4.0
• Sonoff S20
• Sonoff S26
• Sonoff S31 (show power consumption)
• Sonoff S55
• Sonoff SV fw 3.0.1
• Sonoff T1
• Sonoff TX
• Sonoff T4EU1C
• Sonoff IW100/IW101
• Sonoff Slampher R2
• Sonoff 5V DIY
• Sonoff RE5V1C
• MiniTiger Wall Switch (I have 8 without zero-line) fw 3.3.0
• Smart Circuit Breaker
• Smart Circuit Breaker
• Smart Circuit Breaker
• Smart Timer Switch
• Eachen WiFi Smart Touch fw 3.3.0

Tested (only Cloud)

These devices only work through the cloud!

• Sonoff L1 (color, brightness, effects) fw 2.7.0
• Sonoff B1 (color, brightness, color temp) fw 2.6.0
• Sonoff SC (five sensors) fw 2.7.0
• Sonoff DW2
• King Art - King Q4 Cover (pause, position) fw 2.7.0
• KING-M4 (brightness) fw 2.7.0
• Eachen WiFi Door/Window Sensor
• Essential Oils Diffuser (fan and color light) fw 2.9.0
• Smart USB Mosquito Killer
• Smart Bulb RGB+CCT

Tested ZigBee (only Cloud)

• Sonoff ZigBee Bridge - turn on for pairing mode
• SONOFF SNZB-01 - Zigbee Wireless Switch
• SONOFF SNZB-02 - ZigBee Temperature and Humidity Sensor
• SONOFF SNZB-03 - ZigBee Motion Sensor
• SONOFF SNZB-04 - ZigBee Wireless door/window sensor

Tested Cameras (only LAN)

Maybe other eWeLink cameras also work, I don’t know.

• Camera GK-100CD10B (camera with PTZ)
• Sonoff GK-200MP2-B (camera with PTZ)

Installation

HACS > Integrations > Plus > SonoffLAN

Or manually copy sonoff folder from latest release to custom_components folder in your config folder.

Configuration

Configuration > Integrations > Add Integration > Sonoff

You can setup multiple integrations with different ewelink accounts.

Additional options

Configuration > Integrations > Sonoff > Configure

Mode

In auto mode component using both local and cloud connections to your devcies. If device could be reached via LAN - the local connection will be used. Otherwise the cloud connection will be used. This mode is recommended for most general user.

local mode or cloud mode will use only this type of connection.

Sometimes it can be difficult to get a local connection to work. You need a local network with working Multicast (mDNS/zeroconf) traffic between the Hass and your devices. Read about common problems.

Each time the integration starts, a list of user devices is loaded from cloud and saved locally (/config/.storage/sonoff/).

auto mode and local mode can work without Internet connection. If the integration fails to connect to the cloud - the component will use the previously saved list of devices and continue to work only in local mode. auto mode will continue trying to connect to the cloud.

local mode can't work without ewelink credentials because it needs devices encryption keys.

Devices in DIY mode can be used without ewelink credentials because their protocol unencrypted. But the average user does not need to use the devices in this mode.

Debug page

If you have any problems with Ingegration:

1. Check the number of online devices on the info page
2. Check warning and errors on the logs page
3. Enable Debug page option and check logs on the info page

Debug page shows only Integration logs and removes all private data. You can filter log and enable auto refresh (in seconds).

http://192.168.1.123:8123/api/sonoff/c8503fee-88fb-4a18-84d9-abb782bf0aa7?q=1000xxxxxx&r=2

Homes

By default component loads cloud devices only for current active Home in ewelink application. If there is only one Home in the account, it shouldn't be a problem. Otherwise you can select one or multiple Homes to load devices from.

Custom device_class

Important. DeviceID is always 10 symbols string from entity_id or eWeLink app.

You can convert all switches into light by default:

sonoff:
  default_class: light  # (optional), default switch

You can convert specific switches into light, fan or binary_sensor:

sonoff:
  devices:
    1000xxxxxx:
      device_class: light
      name: Sonoff Basic
    1000yyyyyy:
      device_class: fan
      name: Sonoff Mini

You can convert multi-channel devices (e.g. Sonoff T1 2C):

sonoff:
  devices:
    1000xxxxxx:
      device_class: [light, fan]
      name: Sonoff T1 2C
    1000yyyyyy:
      device_class: [switch, light]
      name: MiniTiger 2CH

You can convert multi-channel device (e.g. Sonoff T1 3C) into single light with brightness control:

sonoff:
  devices:
    1000xxxxxx:
      device_class:
        - light: [1, 2, 3]
      name: Sonoff T1 3C

You can control multiple light zones with single multi-channel device (e.g. Sonoff 4CH Pow):

sonoff:
  devices:
    1000xxxxxx:
      device_class:
        - switch: 1  # entity 1 (channel 1)
        - light: [2, 3]  # entity 2 (channels 2 and 3)
        - fan: 4  # entity 3 (channel 4)
      name: Sonoff 4CH Pow

You can change device_class for Binary Sensor:

sonoff:
  devices:
    1000xxxxxx:
      device_class: window

You can change device_class for Cover:

sonoff:
  devices:
    1000xxxxxx:
      device_class: shutter

Preventing DB size growth

Pow devices may send a lot of data every second. You can reduce the amount of processed data.

sonoff:
  devices:
    1000xxxxxx:
      reporting:
        power: [30, 3600, 1]  # min seconds, max seconds, min delta value
        current: [5, 3600, 0.1]
        voltage: [60, 3600, 5]

• if new value came before min seconds - it will be "delayed"
• if new value came between min and max seconds
  • if delta lower than delta value - it will be "delayed"
  • otherwise - it will be used
• if new value came after max seconds - it will be used
• any used value will erase "delayed" value
• new "delayed" value will overwrite old one
• "delayed" value will be checked for the above conditions every 30 seconds

Sonoff TH

Support optional Climate entity that controls Thermostat. You can control low and high temperature values and hvac modes:

• heat - lower temp enable switch, higher temp disable switch
• cool - lower temp disable switch, higher temp enable switch
• dry - change control by humidity with previous low/high switch settings

In dry mode, the Thermostat controls and displays Humidity. But the units are displayed as temperature (Hass limitation).

Thermostat can be controlled only with Cloud connection. Main switch and TH sensors support LAN and Cloud connections.

Sonoff Pow

Support power, current and voltage sensors via LAN and Cloud connections. Also support energy (consumption) sensor only with Cloud connection. Energy data loads from cloud every hour.

You can also setup a sensor, that will collect energy data locally by Hass:

sensor:
  - platform: integration
    source: sensor.sonoff_1000xxxxxx_power
    name: Dishwasher
    unit_prefix: k
    unit: kWh
    round: 2

Sonoff RF Bridge 433

Video HOWTO from @KPeyanski

Important. Integration v3 supports automatic creation of sensors for RF Bridge. All buttons will be created as Button entity. All sensors will be created as Binary entity.

Both button and binary sensor has last_triggered attribute with the time of the last signal received. You can use it in automations.

Binary sensor will stay in on state during 120 seconds by default. Each new signal will reset the timer.

You can read more about configuring and using this bridge in wiki.

Sonoff GK-200MP2-B Camera

Currently only PTZ commands are supported. Camera entity is not created now.

You can send left, right, up, down commands with sonoff.send_command service:

script:
  left:
    sequence:
      - service: sonoff.send_command
        data:
          device: '012345'  # use quotes, this is important
          cmd: left

device - this is the number from the camera ID EWLK-012345-XXXXX, exactly 6 digits (leading zeros - it is important).

Common problems in only LAN mode

auto mode and cloud mode users don't have these problems.

Devices are not displayed

• not all devices supports local protocol
• two routers
• docker with port forwarding
  • you must use: --network host
  • hassio users are okay
• virtual machine with port forwarding
  • you must use bridge virtual network mode (not NAT mode)
• Oracle VM VirtualBox
• linux firewall
• linux network driver
• incorrect network interface selected in Configuration > Settings > Global > Network

The devices publish their data through Multicast DNS (mDNS/zeroconf), read more.

Devices unavailable after reboot

All devices unavailable after each Home Assistant restart. Devices are automatically detected in the local network after each restart. Sometimes devices appear quickly. Sometimes after a few minutes. If this does not happen, there are some problems with the multicast / router.

Raw commands

The component adds the service sonoff.send_command to send low-level commands.

Example service params to single switch:

device: 1000xxxxxx
switch: 'on'

Example service params to multi-channel switch:

device: 1000xxxxxx
switches: [{outlet: 0, switch: 'off'}]

Example service params to dimmer:

device: 1000123456
cmd: dimmable
switch: 'on'
brightness: 50
mode: 0

Getting devicekey manually

The average user does not need to get the device key manually. The component does everything automatically, using the ewelink account.

1. Put the device in setup mode
2. Connect to the Wi-Fi network ITEAD-10000, password 12345678
3. Open in browser http://10.10.7.1/device
4. Copy deviceid and apikey (this is devicekey)
5. Connect to your Wi-Fi network and setup Sonoff via the eWeLink app

Useful Links

• https://github.com/peterbuga/HASS-sonoff-ewelink
• https://github.com/beveradb/sonoff-lan-mode-homeassistant
• https://github.com/mattsaxon/sonoff-lan-mode-homeassistant
• https://github.com/EpicLPer/Sonoff_GK-200MP2-B_Dump
• https://github.com/bwp91/homebridge-ewelink
• https://blog.ipsumdomus.com/sonoff-switch-complete-hack-without-firmware-upgrade-1b2d6632c01
• https://github.com/itead/Sonoff_Devices_DIY_Tools
• SONOFF DIY MODE API PROTOCOL
• No Tasmota And EWeLink Cloud To Control The SONOFF Device? YES!