Important note

This repository is maintained on Codeberg only and will be left as is today (Mar 31, 2025).

Firmware for Gosund SP1, Sonoff S26 (R2) and Maxcio W-DE004 smart plugs

This is a standalone firmware for the named smart plugs/sockets, supporting:

Philips Hue hub V1 emulation (courtesy of github.com/vintlabs/fauxmoESP, TCP port 80) to enable Alexa speech control
Telnet monitor for plug operations (TCP port 23)
16 programmable timer events
OTA flashing of new firmware
Modbus server (TCP port 502) for
- run time statictics
- timer programming
- power metering (Gosund SP1 only)
- event monitoring

No app, no cloud service, no data transfers outside your home network

First-time use

After flashing the firmware to a device, it will be uninitialized. If you will plug it in, it will be in configuration mode. Note: to later get into configuration mode again, press the button within the first 3 seconds after plugging the device. To indicate this time, the signal LED will continuously flash in short intervals.

Configuration

The signal LED will flash three times, then pause a beat, then start again to signal configuration mode has been activated. To get to the configuration page, you need to connect to the temporary WiFi network the device has set up. The network is named (SSID is) "Socket_XXXXXX", with "XXXXXX" as the last 6 hexadecimal digits of the device's chip ID. The password is "Maelstrom" unless you have changed it in the source. Once you have made a successful connection to that network and received an IP address, open your browser to http://192.168.4.1. Now the configuration page will be displayed:

Fill in your WiFi network SSID and password. Then give the device a unique name it will be using as host name, OTA name etc. Finally choose an OTA password to secure your future OTA firmware transfers.

Clicking on Save will store your data in EEPROM.

Finally click on Reset to restart the device and apply your configurations.

Usage

Plug in the device, then wait some seconds for it to settle. The signal LED will flash in quick succession first to allow you to press the button for configuration mode. After that, the device will try to connect to your WiFi network with the data you gave at the configuration. This is indicated by a slow blink of the signal LED: Finally a short blink will signal it has read the configuration data and is ready.

Manual switching

Press the device's button firmly for a short time, then release it to switch the socket on and off. The power LED will light in ON state.

Telnet monitor

(This of course will only apply if you configured TELNET_LOG 1 in the source code!)

Use a terminal program (like the recommended putty on Windows) to connect to the device on TCP port 23. You may use the device name you configured, or the device's IP address. The terminal program should be set to "Add a CR to every LF" to have clean line breaks. Terminal output will be like

Welcome to 'Socket_F9AD5B'!
Millis since start: 78116166
Free Heap RAM: 29640
Server IP: 192.168.178.54
----------------------------------------------------------------
 ON for    21:41:30   Run time    21:41:30    ON time    17:50:35
   | 230.00 V|     0.00 W|  0.01 A|  9482.34 Wh|
 ON for    21:41:35   Run time    21:41:35    ON time    17:50:40
   | 230.17 V|     0.00 W|  0.01 A|  9482.34 Wh|
 ON for    21:41:40   Run time    21:41:40    ON time    17:50:40
   | 230.17 V|     0.00 W|  0.00 A|  9482.34 Wh|

Note: the Telnet output is read-only, you may not enter any command here!

Programmable timers 1..16

(only available if you compiled with the TIMERS flag set to 1!)

There are 16 programmable timers available, that independently can switch the socket ON or OFF, based on the day of week, hour and minute. Timers are controlled by their Modbus register values.

Register	MSB	LSB
First	Bit - Meaning	Bit - Meaning
	0 - 1=SUNDAY	0 - 1=switch to ON, else OFF
	1 - 1=MONDAY	1 - reserved
	2 - 1=TUESDAY	2 - reserved
	3 - 1=WEDNESDAY	3 - reserved
	4 - 1=THURSDAY	4 - reserved
	5 - 1=FRIDAY	5 - reserved
	6 - 1=SATURDAY	6 - reserved
	7 - 1=timer active, else inactive	7 - reserved
Second	Hour to fire the timer 0..23	Minute to fire the timer 0..59

The timers are checked every 30s only, so expect inaccuracy up to that time span.

There is a Linux utility called Smartdose in the "Extras" folder of this repository. You may use that to remotely control all socket functions. See the README file there for detailed information.

To deactivate all 16 timers you can press the socket's button and hold it down for 1s. A new activation can only be done by Modbus requests.

Modbus register reference

The Modbus server running on the smart plus will give out internal values as "holding registers", hence function code 0x03 READ_HOLD_REGISTER can be used to retrieve these values. Register addresses 1 to 8 are available on any device, regardless of type, whereas registers 9 and onward are only valid for Gosund SP1 devices.

Register	Contents	write enabled?
1	State of switch. 0=OFF, 1-255=ON	Yes
2	Control flags:	Yes (0x0001)
	0x0001 - default ON after boot
	0x0800 - Timers enabled
	0x1000 - Fauxmo/Alexa enabled
	0x2000 - Modbus server enabled
	0x4000 - Telnet server enabled
	0x8000 - is a Gosund SP1 device
3	Hours since boot
4	Minutes/seconds since boot 0xMMSS
5	Hours in current state ON or OFF
6	Min/sec in current state
7	Hours of ON state since boot
8	Min/sec of ON state since boot
----------	---------------------------------	----------------
9, 10	accumulated power consumption(W)	Yes (0 value)
11, 12	Voltage correction factor	(Yes, see below)
13, 14	Current correction factor	(Yes, see below)
15, 16	Power correction factor	(Yes, see below)
17, 18	Current current level (A)
19, 20	Current voltage level (V)
21, 22	Current power consumption (W)
----------	---------------------------------	----------------
23, 24	Timer 1 data (see above)	Yes
25, 26	Timer 2 data	Yes
27, 28	Timer 3 data	Yes
29, 30	Timer 4 data	Yes
31, 32	Timer 5 data	Yes
33, 34	Timer 6 data	Yes
35, 36	Timer 7 data	Yes
37, 38	Timer 8 data	Yes
39, 40	Timer 9 data	Yes
41, 42	Timer 10 data	Yes
43, 44	Timer 11 data	Yes
45, 46	Timer 12 data	Yes
47, 48	Timer 13 data	Yes
49, 50	Timer 14 data	Yes
51, 52	Timer 15 data	Yes
53, 54	Timer 16 data	Yes
----------	---------------------------------	----------------
55	Number of event slots
56..	Event slots (see below)

Note: all measurement values are sent as an IEEE754 float number in MSB-first byte sequence. The 4 bytes of that float will use two consecutive registers.

The registers 1, 2, 9 and 10 marked as write enabled can be set with the 0x06 WRITE_HOLD_REGISTER function code. The timer registers 23..54 can only be written with function code 0x10 WRITE_MULT_REGISTERS.

Since the Gosund built-in meters are somewhat inaccurate, you may modify the measured results with a constant factor at least. So if f.i. the voltage is off by about 3%, you can set a voltage correction factor of 1.03 to have that adjusted. You will need a good meter to measure the values at the smart plug outlet.

Please be careful not to touch any powered parts to avoid electrical shock - rather leave all as is if you do not exactly know what you are doing!

The correction factors are modified as follows:

use function code 0x43 USER_DEFINED_43 to send a correction factor. The first byte has to be one of 0=voltage, 1=current or 2=power, followed by a 4-byte IEEE754 float value with the factor.

Event slot data

Each 16 bit register value is split into 3 parts:

bits 0..5 : minutes or month, depending on event
bits 6..10 : hours or day of month, depending on event
bits 11..15 : event type

The event type is one of

-  0 : NO_EVENT
-  1 : DATE_CHANGE
-  2 : BOOT_DATE
-  3 : BOOT_TIME
-  4 : DEFAULT_ON
-  5 : BUTTON_ON
-  6 : BUTTON_OFF
-  7 : MODBUS_ON
-  8 : MODBUS_OFF
-  9 : TIMER_ON
- 10 : TIMER_OFF
- 11 : FAUXMO_ON
- 12 : FAUXMO_OFF

eModbus/Smartdose

ErrorLooks like something went wrong!

About

Topics

Resources

Uh oh!

Stars

Watchers

Forks

Releases

Packages 0

Uh oh!

Languages

Error
Looks like something went wrong!

Packages