¶ Integration Note
|
Manufacturer |
Sonoff |
|
Model |
See Below with Firmware 3.4 or Higher |
|
Driver Name |
SonoffLighting |
|
Driver Version |
24.06.10.00 |
|
Document / Driver Revision |
June 10, 2024 |
|
Core Min / Max Tested |
8.6.11 / 8.6.522 |
¶ Overview
This is a two-way driver to control and get feedback from supported Sonoff smart lighting products that support LAN Mode or the EweLink App. The driver has been updated to take advantage of Elan’s 8.6 OS lighting enhancements. The driver is fast and supports LAN mode feedback with cloud control.
¶ Supported Features
Note about supported devices.
The driver generally supports devices that are discoverable and controllable by the EWELink app. There are known exceptions highlighted below. However for the most part if is a lighting device, it should be supported. If a device is not listed, test it first.
- This Driver supports
- Auto Discovery of Sonoff devices. See the devices section for supported units.
- Two-way control and feedback of all supported lighting devices
- Multi-unit driver installation
- LAN / Cloud hybrid mode operation – Lighting fast command and feedback
- Supports username and password for secure communication
- Auto-discovery of sensors
- Auto installation of sensors
- Ongoing detection of sensors
- Battery levels for all supported sensors
- Event Maps and Numeric triggers based on sensor type
¶ Supported Devices
| Lighting Firmware 3.4 or higher | ||
|
Sonoff Basic Sonoff Basic R2 Sonoff Basic R3 Sonoff RFR3 Sonoff Mini Sonoff TH (W/ temperature and humidity) Sonoff Slampher R2 Sonoff 5V DIY Sonoff RE5V1C Sonoff 4CH Pro R2 |
Sonoff 4CH Pro R3 Sonoff Pow R2 (No power consumption) Sonoff Micro Sonoff D1 (dimmer) Sonoff G1 Sonoff Dual Sonoff S20 Sonoff S26 Sonoff S31 (No power consumption) Sonoff S55 |
Sonoff SV Sonoff T1 Sonoff TX Sonoff T4EU1C Sonoff IW100/IW101 MiniTiger Wall Switch / Dimmer KingArt Wall Switch / Dimmer DW2 WiFi door/window sensor Any General EWELink lighting device that is similar in operation to the above items. |
THE FOLLOWING OPTIONS are not supported:
The driver does not support energy monitoring. The driver does not support Zigbee products. RGB light bulbs are not supported.
¶ Device Configuration
- Set up your Sonoff devices as instructed by the Sonoff User Manual using the router/switches app. Pay attention as each device is configured differently.
- The driver uses UDP multicasting as well as Internet-based cloud connections. Make sure your router / switches support it. If you have VLANS, make sure VLANS can pass UDP and multicasting to different segments.
- Make sure you have a persistent internet connection. If the internet is down, the driver will not operate the devices.
- Use an email to set up your EWELink account. The driver does not support phone number login names.
- Enable LAN Mode on all devices. If the device doesn’t support LAN mode, test that the driver will support it.
¶ Driver Configuration
¶ Installation Process
Unzip the driver downloaded into the driver installation library.
- Open Lighting, Lighting Interface, Add New Lighting Interface, and check the box that says Show Unsupported Devices. Scroll to the bottom and choose SonoffLighting (the picture below might show a different version number than the driver installed.)
- You’ll receive a warning that this is not a Native Elan driver, click OK
- The Driver will automatically go into trial mode for 30 days. Wait for about 10 seconds and the Status will turn Green.
- Fill in the activation code
- Enter the EWELink mobile app username and password here.
NOTE: The driver can only use email and password login. It CAN NOT use a phone number login
NOTE: Make sure devices are all online (they don’t need to be on) just online and visible to the app. If the device is greyed out in the EWELink app, the driver will install it but it will not operate from the driver.
- The driver will populate all devices found on the network. The driver will use the names of the devices assigned in the EWELink app as the name of the device. Change according to preference. If you click on Install, the names will be reset to the names in the Mobile App.
- The driver will discover and install supported lighting devices and install them with the proper capabilities under lighting
- Multiple outlet or control devices such as the 4CHR3, 4CHPROR3, PWR2, DUAL, TX will be installed as separate devices with each outlet with its own controls.
- Dimmable devices are installed with dimming capabilities.
¶ Configuration Details
The following table provides settings used in Configurator …Please refer to the Configurator Reference Guide for more details.
In the table below:
- “<User Defined>”, etc. Type in the desired name for the item.
- “<Auto Detect>”, etc. The system will auto detect this variable.
| Devices | Variable Name | Settings | Comments |
| Lighting | Name | User Defined (Default: SonoffLighting) | |
| System # | <Auto Detect> | ||
| Device Type | Ethernet | ||
| Driver Name | SonoffLighting | ||
| Driver Version | <Auto Detect> | ||
| Driver Vendor | Innovo | ||
| Activation KEY | <User Defined> | ||
| IP Address | <User Defined> | ||
| Display Name | <User Defined> (Default: SonoffLighting) | ||
| System # | <Auto Detect> |
¶ Using the Driver
Lighting Interface
Add an interface to control the lights from Lighting Custom Pages
Create the necessary controls, such as dimmer or button
Create Text Feedback for Sensor Values
¶ Troubleshooting
- Driver not Activated.
- Wait 15 seconds after Apply
- Driver not discovering devices.
- Try discovery again. Make sure broadcasting / Multicast is enabled on the network
- Enable LAN mode on the device
- Driver not controlling light but it’s working from Sonoff.
- Make sure the IP address doesn’t change. Assign DHCP reservations for the devices.
- The lighting driver will not display the proper name of the Sonoff device but instead it will show the device type and it’s MAC address such as. To work around this, rename the device in the driver after discovery is finished.