diff --git a/Commands.md b/Commands.md index a93d29b9..2777ff14 100644 --- a/Commands.md +++ b/Commands.md @@ -113,7 +113,7 @@ LedPower | LED power state as on or off
`0` = turn LED OFF and LedState OFF LedState | Manage LED state
`0` = disable use of LED as much as possible
`1` = show power state on LED (LED on when power on) *(inverted for Sonoff Touch/T1)*
`2` = show MQTT subscriptions as a LED blink
`3` = show power state and MQTT subscriptions as a LED blink
`4` = show MQTT publications as a LED blink
`5` = show power state and MQTT publications as a LED blink
`6` = show all MQTT messages as a LED blink
`7` = show power state and MQTT messages as a LED blink

`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` Power\ | Control Relay\ power state and also resetting PulseTime\
`0` / `off` = turn OFF
`1` / `on` = turn ON
`2` / `toggle` = if relay is `ON` switch to `OFF` and vice versa
`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)
`4` / `blinkoff` = stop blink sequence and return relay power to pre-blink state PowerOnState | Control relay state after _**powering up**_ the device. [More information](PowerOnState-Configuration)
`0` / `OFF` = keep relay(s) OFF after power up
`1` / `ON` = turn relay(s) ON after power up
`2` / `TOGGLE` = toggle relay(s) from last saved state
`3` = switch relay(s) to their last saved state *(default)*
`4` = turn relay(s) ON and disable further relay control
`5` = after a `PulseTime` period turn relay(s) ON (acts as inverted [`PulseTime`](Commands#pulsetime) mode) -PulseTime\ | Display the amount of `PulseTime` remaining on Relay\
`` Set the duration to keep Relay\ `ON` when `Power ON` command is issued. After this amount of time, the relay will be turned `OFF`.
  • `0` / `OFF` = disable use of PulseTime for Relay\
  • `1..111` = set PulseTime for Relay\ in 0.1 second increments
  • `112..64900` = set PulseTime for Relay\, 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)
+PulseTime\ | Display the amount of `PulseTime` remaining on Relay\
`` Set the duration to keep Relay\ `ON` when `Power ON` command is issued. After this amount of time, the relay will be turned `OFF`.
`0` / `OFF` = disable use of PulseTime for Relay\
`1..111` = set PulseTime for Relay\ in 0.1 second increments
`112..64900` = set PulseTime for Relay\, 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)
SwitchDebounce | User control over switch debounce timing
`40..1000` = set switch debounce time in ms. Default is `40` SwitchMode\ | [Switch mode](Buttons-and-Switches#switchmode)
`0` = toggle *(default)*
`1` = follow (0 = off, 1 = on)
`2` = inverted follow (0 = on, 1 = off)
`3` = pushbutton (default 1, 0 = toggle)
`4` = inverted pushbutton (default 0, 1 = toggle)
`5` = pushbutton with hold (default 1, 0 = toggle, Hold = hold)
`6` = inverted pushbutton with hold (default 0, 1 = toggle, hold = hold)
`7` = pushbutton toggle (0 = toggle, 1 = toggle) See also | [`SetOption11`](#SetOption11) - Swap pushbutton single and double press functionality
[`SetOption13`](#SetOption13) - Allow immediate action on single button press
[`SetOption26`](#SetOption26) - Use indexes even when only one relay is present
[`SetOption31`](#SetOption31) - Disable Wi-Fi LED status blinking
[`SetOption32`](#SetOption32) - Set hold interval before sending hold action @@ -203,7 +203,7 @@ StateText2|`` = set `ON` state text (10 chars max) StateText3|`` = set `TOGGLE` state text (10 chars max) StateText4|`` = set `HOLD` state text (10 chars max) SwitchRetain|`0` = disable use of MQTT retain flag *(default)*
`1` = enable MQTT retain flag on switch press -SwitchTopic\|`0` = disable use of MQTT switch topic
`1` = set MQTT switch topic to device MQTT ``
`2` = set MQTT switch topic to firmware default `MQTT_SWITCH_TOPIC`
  • _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._
`` = set MQTT switch topic (32 chars max) +SwitchTopic|`` = set MQTT switch topic (32 chars max)
`0` = disable use of MQTT switch topic
`1` = set MWTT switch topic to device `%topic%`
`2` = reset MQTT switch topic to firmware default (`MQTT_SWITCH_TOPIC`)_(default = `0`)_
[Read more](Buttons-and-switches) about this TelePeriod|`0` = disable telemetry messages
`1` = reset telemetry period to firmware default (`TELE_PERIOD`)
`10..3600` = set telemetry period in seconds *(default = `300`)* Topic|`1` = reset MQTT topic to firmware default (`MQTT_TOPIC`) and restart
`` = set MQTT topic (32 chars max) **and** `ButtonTopic` and restart See also | [`SetOption2`](#setoption2) - Add units to status messages
[`SetOption4`](#setoption4) - Return MQTT response as RESULT or %COMMAND% topic
[`SetOption10`](#setoption10) - Main topic change behaviour