Skip to content

Commit daf313d

Browse files
authored
Update Sonoff-SPM.md
Command name case to match source code
1 parent 2940df6 commit daf313d

File tree

1 file changed

+11
-11
lines changed

1 file changed

+11
-11
lines changed

docs/Sonoff-SPM.md

+11-11
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ In addition to installing the ``tasmota32.bin`` image some configuration might b
4646

4747
### Relay mapping
4848

49-
After a restart the ARM firmware starts to scan for available 4Relay modules. Every module has a unique id which is send to Tasmota in random order. For a user to pinpoint a physical set of four relays it is therefor needed to "map" the scanned modules once. Tasmota stores the id's in a mapping table build using the command ``SspmMap <scanned module number>,<scanned module number>,..`` where the first entry will map to physical relays 1 to 4, the second entry will map to physical relays 5 to 8 etc. The scanned module information needed is displayed on the console during restart or on request by executing command ``SspmScan`` with a ``weblog 2`` setting.
49+
After a restart the ARM firmware starts to scan for available 4Relay modules. Every module has a unique id which is send to Tasmota in random order. For a user to pinpoint a physical set of four relays it is therefor needed to "map" the scanned modules once. Tasmota stores the id's in a mapping table build using the command ``SSPMMap <scanned module number>,<scanned module number>,..`` where the first entry will map to physical relays 1 to 4, the second entry will map to physical relays 5 to 8 etc. The scanned module information needed is displayed on the console during restart or on request by executing command ``SSPMScan`` with a ``weblog 2`` setting.
5050

5151
!!! Note
5252
Scanning takes over 20 seconds so be patient
@@ -61,20 +61,20 @@ Look for the below information during a restart for a two 4Relay module system:
6161
13:54:05.401 SPM: 4Relay 2 (mapped to 1) type 130 version 1.0.0 found with id 6B7E3237393734134B353637
6262
```
6363

64-
In this case the two modules are mapped using command ``SspmMap 2,1``. As Tasmota does store the ids of the 4Relay modules a future hussle of the received modules will keep the physical mapping correct.
64+
In this case the two modules are mapped using command ``SSPMMap 2,1``. As Tasmota does store the ids of the 4Relay modules a future hussle of the received modules will keep the physical mapping correct.
6565

6666
## Commands List
6767

6868
The following SPM specific commands are supported.
6969

7070
Command|Parameters
7171
:---|:---
72-
SspmDisplay<a class="cmnd" id="SspmDisplay"></a>|Change GUI display between rotating display of all scanned relays, of all scanned relays that are powered on or select a group of four relays using a tab<BR>`0` = Display all relays<BR>`1` = Display powered on relays<BR>`2` = Provide user selectable tabs to display four relays within a 4Relay module
73-
SspmEnergyTotal<x\><a class="cmnd" id="SspmEnergyTotal"></a>|(P)reset total energy in kWh without today's energy for relay <x\><BR>`0` = preset with total of history<BR>`0.01..262143.99` = set value in kWh
74-
SspmEnergyYesterday<x\><a class="cmnd" id="SspmEnergyYesterday"></a>|(P)reset energy yesterday in kWh for relay <x\><BR>`0.01..262143.99` = set value in kWh
75-
SspmHistory<x\><a class="cmnd" id="SspmHistory"></a>|Show daily energy for relay <x\> of up to 180 days
76-
SspmIAmHere<x\><a class="cmnd" id="SspmIAmHere"></a>|Blink SPM-4Relay module error light containing relay <x\>
77-
SspmLog<x\><a class="cmnd" id="SspmLog"></a>|Show relay <x\> power state change and cause
78-
SspmMap<a class="cmnd" id="SspmMap"></a>|Map scanned SPM-4Relay modules to physical location. Use unique numbers for all fields<BR>`0` = rescan modbus for SPM-4Relay modules and reset mapping to default. This takes at least 20 seconds<BR>`3,4,1,2` = map scanned module 1 to physical module 3 containing relays 9 to 12, module 2 to 4 with relays 13 to 16, module 3 to 1 with relays 1 to 4 and module 4 to 2 with relays 5 to 8
79-
SspmOverload<x\><a class="cmnd" id="SspmOverload"></a>|Set overload detection criteria for relay <x\> <BR>`0` = reset and disable overload detection to scanned module criteria<BR>`<delay>,<min_power>,<max_power>,<min_voltage>,<max_voltage>,<max_current>` = set any or all overload detection criteria<BR>`0,0.10,4400.00,0.10,240.00,20.00` = enable overload detection with default values<BR>`9,0,22.1` = enable max_power over 22.1W detection after 9 seconds<BR>`0,0,0,0,235.2` = enable immediate max_voltage over 235.2V detection
80-
SspmScan<a class="cmnd" id="SspmScan"></a>|Rescan modbus for SPM-4Relay modules. This takes at least 20 seconds
72+
SSPMDisplay<a class="cmnd" id="SspmDisplay"></a>|Change GUI display between rotating display of all scanned relays, of all scanned relays that are powered on or select a group of four relays using a tab<BR>`0` = Display all relays<BR>`1` = Display powered on relays<BR>`2` = Provide user selectable tabs to display four relays within a 4Relay module
73+
SSPMEnergyTotal<x\><a class="cmnd" id="SspmEnergyTotal"></a>|(P)reset total energy in kWh without today's energy for relay <x\><BR>`0` = preset with total of history<BR>`0.01..262143.99` = set value in kWh
74+
SSPMEnergyYesterday<x\><a class="cmnd" id="SspmEnergyYesterday"></a>|(P)reset energy yesterday in kWh for relay <x\><BR>`0.01..262143.99` = set value in kWh
75+
SSPMHistory<x\><a class="cmnd" id="SspmHistory"></a>|Show daily energy for relay <x\> of up to 180 days
76+
SSPMIAmHere<x\><a class="cmnd" id="SspmIAmHere"></a>|Blink SPM-4Relay module error light containing relay <x\>
77+
SSPMLog<x\><a class="cmnd" id="SspmLog"></a>|Show relay <x\> power state change and cause
78+
SSPMMap<a class="cmnd" id="SspmMap"></a>|Map scanned SPM-4Relay modules to physical location. Use unique numbers for all fields<BR>`0` = rescan modbus for SPM-4Relay modules and reset mapping to default. This takes at least 20 seconds<BR>`3,4,1,2` = map scanned module 1 to physical module 3 containing relays 9 to 12, module 2 to 4 with relays 13 to 16, module 3 to 1 with relays 1 to 4 and module 4 to 2 with relays 5 to 8
79+
SSPMOverload<x\><a class="cmnd" id="SspmOverload"></a>|Set overload detection criteria for relay <x\> <BR>`0` = reset and disable overload detection to scanned module criteria<BR>`<delay>,<min_power>,<max_power>,<min_voltage>,<max_voltage>,<max_current>` = set any or all overload detection criteria<BR>`0,0.10,4400.00,0.10,240.00,20.00` = enable overload detection with default values<BR>`9,0,22.1` = enable max_power over 22.1W detection after 9 seconds<BR>`0,0,0,0,235.2` = enable immediate max_voltage over 235.2V detection
80+
SSPMScan<a class="cmnd" id="SspmScan"></a>|Rescan modbus for SPM-4Relay modules. This takes at least 20 seconds

0 commit comments

Comments
 (0)