mirrors
/
Tasmota
mirror of https://github.com/arendst/Tasmota.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Add Reset 6

blakadder 2019-02-18 22:23:05 +01:00
parent eadd7bacf8
commit 08316f59d7
1 changed files with 38 additions and 39 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

77
Commands.md

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