diff --git a/Commands.md b/Commands.md index 7a50bc85..ff0cbfe6 100644 --- a/Commands.md +++ b/Commands.md @@ -378,46 +378,45 @@ WebLog | 4 | Show all messages ### SetOption Overview +### Management Command | Description with options -:---: | ---------------------------------------------------------------------------- - SetOption0 | Save power state and use after restart
`0` = disable
`1` = enable *(default)* - SetOption1 | Set [button multipress](Control-other-devices) mode to
`0` = allow all button actions *(default)*
`1` = restrict to single, double and hold actions - SetOption2 | Add units to status messages
`0` = disabled *(default)*
`1` = enabled - SetOption3 | [MQTT](#mqtt)
`0` = disable MQTT
`1` = enable MQTT *(default)* - SetOption4 | return MQTT response as
`0` = RESULT topic *(default)*
`1` = %COMMAND% topic - SetOption8 | Show temperature in
`0`= Celsius *(default)*
`1` = Fahrenheit - SetOption10 | On topic change send
`0` = empty message and delete old topic LWT *(default)*
`1` = Offline to old topic LWT - SetOption11 | Swap pushbutton single and double press functionality
`0` = disabled *(default)*
`1` = enabled - SetOption12 | Configuration saving to flash option
`0` = allow dynamic flash save slot rotation *(default)*
`1` = use fixed eeprom flash slot - SetOption13 | Allow immediate action on single button press
`0` = single, multi-press and hold button actions *(default)*
`1` = only single press action for immediate response. Disable by holding for 4 x key hold time (see SetOption32). - SetOption15 | Set PWM control for RGB(CT) LEDs
`0` = basic PWM control
`1` = control with [`Color`](#Color) or [`Dimmer`](#Dimmer) commands - SetOption16 | Set addressable LED Clock scheme parameter
`0` = clock-wise mode *(default)*
`1` = counter-clock-wise mode - SetOption17 | Show [`Color`](#Color) string as
`0` = hex string *(default)*
`1` = comma-separated decimal string - SetOption18 | Set status of signal light paired with CO2 sensor
`0` = disable light *(default)*
`1` = enable light - SetOption19 | [Home Assistant](Home-Assistant) automatic discovery
`0` = disabled *(default)*
`1` = enabled - SetOption20 | Update of Dimmer/Color/CT without turning power on
`0` = disabled *(default)*
`1` = enabled - SetOption21 | Energy monitoring when power is off
`0` = disabled *(default)*
`1` = enabled - SetOption24 | Show pressure unit in
`0` = hPa *(default)*
`1` = mmHg - SetOption26 | Use indexes even when only one relay is present
`0` = messages use POWER *(default)*
`1` = messages use POWER1 - SetOption28 | RF received data format
`0` = hex *(default)*
`1` = decimal - SetOption29 | IR received data format
`0` = hex *(default)*
`1` = decimal - SetOption30 | Enforce Home Assistant autodiscovery as light
`0` = relays are announced as a switch and PWM as a light *(default)*
`1` = both relays and PWM are announced as light - SetOption31 | Disable status LED blinking during Wi-Fi and MQTT connection problems.[`LedPower`](#LedPower) must be set to `0` for this feature to work.
`0` = LED blinking enabled *(default)*
`1` = LED blinking disabled - SetOption32 | Number of 0.1 seconds to hold button before sending `hold˙ action message. Introduced in 6.4.1.14
`1..100` to set Key Hold Time from 0.1 seconds to 10 seconds *(default =`40` (4 seconds))* - SetOption33 | Configure power monitoring Max_Power_Retry count number
`1..250` = set number of retries *(default = `5`)* - SetOption34 | Set [Tuya dimmer device id](https://github.com/arendst/Sonoff-Tasmota/pull/4095)
`0..255' = device id - SetOption36 | Boot loop control. Introduced in 6.4.1.13
`0` = disable boot loop control *(default)*
`1..200` = set number of boot loops before restoring default settings - SetOption51 | View extra pins for ESP8285 in Module Config
**WARNING** Do not use on ESP8266 devices!!!
`0` = disable *(default)*
`1` = enable - SetOption52 | Control display of optional time offset from UTC in JSON messages
`0` = disable *(default)*
`1` = enable - SetOption53 | Display hostname and IP address in GUI
`0` = disable *(default)*
`1` = enable - SetOption54 | Apply [`SetOption20`](#SetOption20) settings to commands from Tuya device
`0` = disable *(default)*
`1` = enable - SetOption55 | mDNS service
`0` = disable *(default)*
`1` = enable - SetOption56 | Wi-Fi network scan to select strongest signal on restart
`0` = disable *(default)*
`1` = enable - SetOption57 | Wi-Fi network re-scan every 44 minutes with switch to +10dB stronger signal if detected
`0` = disable *(default)*
`1` = enable - SetOption58 | [IR Raw data in JSON message](https://github.com/arendst/Sonoff-Tasmota/issues/2116#issuecomment-440716483)
`0` = disable *(default)*
`1` = enable - SetOption59 | Send `tele/%topic%/STATE` in addition to `stat/%topic%/RESULT` for commands: [`State`](#State), [`Power`](#Power) and any command causing a light to be turned on.
`0` = disable *(default)*
`1` = enable - SetOption60 | Enable normal sleep instead of [dynamic sleep](Dynamic%20Sleep)
`0` = dynamic sleep *(default)*
`1` = sleep - SetOption61 | Force [local operation](https://github.com/arendst/Sonoff-Tasmota/pull/4562#issuecomment-446230001) when [`ButtonTopic`](#ButtonTopic) or [`SwitchTopic`](#SwitchTopic) is set. Introduced in 6.4.1.17
`0` = disable *(default)*
`1` = enable +---: | ----------------------------------------------------------------------------------------- + Backlog | List of commands to be executed in sequence separated by `;`
See [Using Backlog](#using-backlog) for examples. + Delay | `2..3600` = set delay between two backlog commands with 0.1 second increment + Emulation | `0` = disable emulation
`1` = enable Belkin WeMo emulation for Alexa
`2` = enable Hue Bridge emulation for Alexa + Event | Execute an event to trigger a rule as [documented](Rules) + FriendlyName\ | `1` = Reset friendly name to user_config(_override).h value
`` = set friendly name (32 char limit) + Gpios | Show list of available sensors and devices by name and index + Gpio | Show current GPIO usage for current module + Gpio\ | `` = configure [sensor](https://github.com/arendst/Sonoff-Tasmota/blob/0658ae19599e88432bbb20348f1d49279276acd7/sonoff/sonoff_template.h#L192) to Gpio\ + I2Cscan | Scan I2C bus and show addresses for found devices + Mem\ | Manage up to 5 variables stored on flash (x = `1..5`)
`` = store a string value in a variable
`"` = clear stored value in Mem\ + Modules | Show available modules by name and index + Module | Displays active module by name and index
`` = switch to Module\ and restart + OtaUrl | Display current OTA URL
`1` = Reset OtaUrl to user_config(_override).h value
`url` = set address for OTA (100 char limit) + Pwm | Display current PWM setting for enabled channels
+ Pwm\ | `0..1023` = set PWM\ channel to value + PwmFrequency | `1` = reset PWM frequency to 880Hz
`100..4000` = set PWM frequency (100Hz to 4kHz) + PwmRange | `1` = reset maximum PWM range to 1023
`255..1023` = set maximum PWM range + Reset | `1` = reset sonoff parameters to user_config(_override).h values and restart
`2` = erase flash, reset sonoff parameters to user_config(_override).h values and restart
`3` = erase flash SDK parameters and restart
`4` = reset sonoff parameters to user_config(_override).h values but retain Wi-Fi credentials and restart
`5` = erase all flash and reset parameters to firmware defaults but keep Wi-Fi settings and restart
`6` = erase all flash and reset parameters to firmware defaults but keep Wi-Fi and MQTT settings and restart *(from 6.4.1.18)*
*(Erase of flash can take a few seconds to complete and there is no output during the erase process on the serial or web console)* + Restart | `1` = restart device
`99` = force restart device without configuration save + Rule\ | Create up to 3 [rules](Rules) with a 511 character limit (x = `1..3`)
`0` = disable Rule\
`1` = enable Rule\
`2` = toggle Rule\
`3` = disable one-shot detection
`5` = enable one-shot detection
`6` = toggle one-shot detection
`8` = disable stop-on-error after exception restart
`9` = enable stop-on-error after exception restart
`10` = toggle stop-on-error after exception restart
`` = define [Rule\](Rules)
`+` = append to [Rule\](Rules)
`"` = clear Rule\ + RuleTimer\ | Up to eight timers to be used as countdown event (x = `1..8`)
`0..32766` = set countdown rule timer in seconds + Template | Show current [Template](Templates)
`0` = create template from active module
`1..69` = create template from a supported module
`{..}` = create a template with a [JSON string](Templates#explanation-of-template-properties) + SaveData | `0` = save parameter changes only manually
`1` = save parameter changes every second *(default)*
`2..3600`= save parameter changes every x second + Sleep | `0` = turn sleep off
`1..250` = set sleep duration in mSec to enable energy saving *(default = `50`)* + State | Show current device state in `%prefix%/%topic%/RESULT` topic + Status | Show abbreviated [status information](JSON-Status-Responses#basic-response)
`0` = show basic status information
`1` = show more status information
`2` = show firmware information
`4` = show memory information
`5` = show network information
`6` = show MQTT information
`7` = show time information
`8` = show connected sensor information
`9` = show power thresholds *(only on modules with power monitoring)*
`10` = same as `Status 8` *(kept for backwards compatibility)*
`11` = show information equal to `TelePeriod` state message + Timezone | `-13..13` = set timezone
`99` = use timezone configured with `TimeDST` and `TimeSTD` + TimeSTD
TimeDST | Set standard (STD) and daylight saving (DST) timezones
`0` = reset timezone parameters to user_config(_override).h values
`H` = hemisphere (`0` = northern hemisphere / `1` = southern hemisphere)
`W` = week (`0` = last week of month, `1..4` = first .. fourth)
`M` = month (`1..12`)
`D` = day of week (`1..7` = sunday saturday saturday
`h` = hour (`0..23`)
`T` = timezone (`-780..780`)(offset from UTC in **MINUTES** - 780min/60min=13hrs) + Upgrade | `1` = download firmware from `OtaUrl` and restart
`` = download firmware from `OtaUrl` if \ is higher than device version + Upload | `1` = download firmware from `OtaUrl` and restart
`` = download firmware from `OtaUrl` if \ is higher than device version + Var\ | Manage up to 5 variables stored in memory (x = `1..5`)
`` = store a string value in a variable
`"` = clear stored value in Var\ + Add\ | `` = add value to Var\ + Sub\ | `` = subtract value to Var\ + Mult\ | `` = multiply value to Var\ + Scale\ | Scale value from a low and high limit to another low and high limits and save in Var\
`v` = value: the number to scale
`fl` = fromLow: the lower bound of the value’s current range
`fh` = fromHigh: the upper bound of the value’s current range
`tl` = toLow: the lower bound of the value’s target range
`th` = toHigh: the upper bound of the value’s target range + CalcRes | `0..7` = set number of decimals to be used in `Add`, `Sub`, `Mult` and `Scale` ### Power monitoring specific Command | Payload | Description | Min. Version