Updated Commands (markdown)

blakadder 2019-05-02 09:43:13 +02:00
parent 3c081b0f8e
commit 2ddc48d337
1 changed files with 2 additions and 2 deletions

@ -113,7 +113,7 @@ LedPower | LED power state as on or off <BR> `0` = turn LED OFF and LedState OFF
LedState | Manage LED state<BR> `0` = disable use of LED as much as possible <BR> `1` = show power state on LED (LED on when power on) *(inverted for Sonoff Touch/T1)*<BR> `2` = show MQTT subscriptions as a LED blink<BR> `3` = show power state and MQTT subscriptions as a LED blink<BR> `4` = show MQTT publications as a LED blink<BR> `5` = show power state and MQTT publications as a LED blink<BR> `6` = show all MQTT messages as a LED blink<BR> `7` = show power state and MQTT messages as a LED blink<BR><BR>`8` = LED on when Wi-Fi and MQTT are connected. ***Cannot be issued directly*** and is only activated when `LedPower` is switched from `0` to `1`<a id="Power"></a>
Power\<x\> | Control Relay\<x\> power state and also resetting PulseTime\<x\><BR> `0` / `off` = turn OFF <BR> `1` / `on` = turn ON <BR> `2` / `toggle` = if relay is `ON` switch to `OFF` and vice versa<BR> `3` / `blink` = toggle power for [BlinkCount](#blinkcount) times each [BlinkTime](#blinktime) duration (at the end of `blink`, relay power is returned to pre-blink state)<BR> `4` / `blinkoff` = stop blink sequence and return relay power to pre-blink state<a id="PowerOnState"></a>
PowerOnState | Control relay state after _**powering up**_ the device. [More information](PowerOnState-Configuration)<BR> `0` / `OFF` = keep relay(s) OFF after power up <BR> `1` / `ON` = turn relay(s) ON after power up <BR> `2` / `TOGGLE` = toggle relay(s) from last saved state <BR> `3` = switch relay(s) to their last saved state *(default)* <BR> `4` = turn relay(s) ON and disable further relay control <BR> `5` = after a `PulseTime` period turn relay(s) ON (acts as inverted [`PulseTime`](Commands#pulsetime) mode)<a id="PulseTime"></a>
PulseTime\<x\> | Display the amount of `PulseTime` remaining on Relay\<x><BR>`<value>` Set the duration to keep Relay\<x\> `ON` when `Power<x> ON` command is issued. After this amount of time, the relay will be turned `OFF`.<ul><li>`0` / `OFF` = disable use of PulseTime for Relay\<x\></li><li>`1..111` = set PulseTime for Relay\<x\> in 0.1 second increments</li><li>`112..64900` = set PulseTime for Relay\<x\>, offset by 100, in 1 second increments. Add 100 to desired interval in seconds, e.g., `PulseTime 113` = 13 seconds and `PulseTime 460` = 6 minutes (i.e., 360 seconds)</li></ul><a id="SwitchDebounce"></a>
PulseTime\<x\> | Display the amount of `PulseTime` remaining on Relay\<x><BR>`<value>` Set the duration to keep Relay\<x\> `ON` when `Power<x> ON` command is issued. After this amount of time, the relay will be turned `OFF`.<BR>`0` / `OFF` = disable use of PulseTime for Relay\<x\><BR>`1..111` = set PulseTime for Relay\<x\> in 0.1 second increments<BR>`112..64900` = set PulseTime for Relay\<x\>, offset by 100, in 1 second increments. Add 100 to desired interval in seconds, e.g., `PulseTime 113` = 13 seconds and `PulseTime 460` = 6 minutes (i.e., 360 seconds)<BR><a id="SwitchDebounce"></a>
SwitchDebounce | User control over switch debounce timing <BR> `40..1000` = set switch debounce time in ms. Default is `40`<a id="SwitchMode"></a>
SwitchMode\<x\> | [Switch mode](Buttons-and-Switches#switchmode) <BR> `0` = toggle *(default)* <BR> `1` = follow (0 = off, 1 = on) <BR> `2` = inverted follow (0 = on, 1 = off) <BR> `3` = pushbutton (default 1, 0 = toggle) <BR> `4` = inverted pushbutton (default 0, 1 = toggle) <BR> `5` = pushbutton with hold (default 1, 0 = toggle, Hold = hold) <BR> `6` = inverted pushbutton with hold (default 0, 1 = toggle, hold = hold) <BR> `7` = pushbutton toggle (0 = toggle, 1 = toggle)
See also | [`SetOption11`](#SetOption11) - Swap pushbutton single and double press functionality<BR>[`SetOption13`](#SetOption13) - Allow immediate action on single button press<BR>[`SetOption26`](#SetOption26) - Use indexes even when only one relay is present<BR>[`SetOption31`](#SetOption31) - Disable Wi-Fi LED status blinking<BR>[`SetOption32`](#SetOption32) - Set hold interval before sending hold action
@ -203,7 +203,7 @@ StateText2|`<value>` = set `ON` state text (10 chars max)<a id="StateText3"></a>
StateText3|`<value>` = set `TOGGLE` state text (10 chars max)<a id="StateText4"></a>
StateText4|`<value>` = set `HOLD` state text (10 chars max)<a id="SwitchRetain"></a>
SwitchRetain|`0` = disable use of MQTT retain flag *(default)*<BR>`1` = enable MQTT retain flag on switch press<a id="SwitchTopic"></a>
SwitchTopic\<x>|`0` = disable use of MQTT switch topic<BR>`1` = set MQTT switch topic to device MQTT `<topic>`<BR>`2` = set MQTT switch topic to firmware default `MQTT_SWITCH_TOPIC`<ul><li>_Typically `MQTT_SWITCH_TOPIC` is set to `0` unless you compile your own firmware and change this value in `user_config_override.h`. If `MQTT_SWITCH_TOPIC` is set to a string, then this command will have the same behavior as outlined below._</li></ul>`<value>` = set MQTT switch topic (32 chars max)<a id="TelePeriod"></a>
SwitchTopic|`<value>` = set MQTT switch topic (32 chars max)<BR>`0` = disable use of MQTT switch topic<BR>`1` = set MWTT switch topic to device `%topic%`<BR>`2` = reset MQTT switch topic to firmware default (`MQTT_SWITCH_TOPIC`)_(default = `0`)_<BR>[Read more](Buttons-and-switches) about this<a id="TelePeriod"></a>
TelePeriod|`0` = disable telemetry messages<BR>`1` = reset telemetry period to firmware default (`TELE_PERIOD`)<BR>`10..3600` = set telemetry period in seconds *(default = `300`)*<a id="Topic"></a>
Topic|`1` = reset MQTT topic to firmware default (`MQTT_TOPIC`) and restart<BR>`<value>` = set MQTT topic (32 chars max) **and** `ButtonTopic` and restart
See also | [`SetOption2`](#setoption2) - Add units to status messages<BR>[`SetOption4`](#setoption4) - Return MQTT response as RESULT or %COMMAND% topic<BR>[`SetOption10`](#setoption10) - Main topic change behaviour