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

Replace Lights `Channel` anchor due to `Brightness` being commented

Michael Ingraham 2019-05-08 09:10:07 -04:00
parent 9663a60137
commit 3f56bb57d7
1 changed files with 10 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
Commands.md

@ -77,7 +77,7 @@ E.g. in case of command _`Backlog Power1 OFF; Delay 600; Power1 ON`_ the usage o
# How to Use Commands
**Commands listed are available from version 6.5.0.** Later introduced commands have their minimum version noted. If you're using an older Tasmota version some of the commands might not work. Note that availability of some features and their associated commands is dependent on the options selected during the firmware compilation. Please consult the [builds](https://github.com/arendst/Sonoff-Tasmota/wiki/Builds) table for a reference of which features are available for each pre-compiled firmware binary variant.
**Commands listed are available from version 6.5.0.** Later introduced commands have their minimum version noted. If you're using an older Tasmota version some of the commands might not work. Note that availability of some features and their associated commands is dependent on the options selected during the firmware compilation. Please consult the [builds](Builds) table for a reference of which features are available for each pre-compiled firmware binary variant.
Every command **used without a parameter (payload) returns the current setting**.
* `Power` will return the status of Relay1
@ -154,7 +154,7 @@ Upgrade|`1` = download firmware from `OtaUrl` and restart<BR>`<value>` = downloa
Upload|`1` = download firmware from `OtaUrl` and restart<BR>`<value>` = download firmware from `OtaUrl` if \<value\> is higher than device version<a id="WebLog"></a>
WebLog|`0` = disable web logging<BR> `1` = show only error messages<BR> `2` = show error and info messages<BR>`3` = show error, info and debug messages<BR>`4` = show all messages
### [Wi-Fi](https://github.com/arendst/Sonoff-Tasmota/wiki/Troubleshooting#Wi-Fi-issues-arduino-core-versions-and-espressif-sdk)
### [Wi-Fi](Troubleshooting#Wi-Fi-issues-arduino-core-versions-and-espressif-sdk)
|Command | Parameters
|:--- | :---
@ -280,7 +280,7 @@ VoltRes | Voltage sensor resolution<BR>`0..3` = maximum number of decimal points
WattRes | Power sensor resolution<BR>`0..3` = maximum number of decimal points
See also | [`SetOption8`](#SetOption8) - Show temperature in Celsius *(default)* or Fahrenheit<BR>[`SetOption18`](#SetOption18) - Set status of signal light paired with CO<sub>2</sub> sensor
### [Power Monitoring](https://github.com/arendst/Sonoff-Tasmota/wiki/Sonoff-Pow-and-Pow-R2)
### [Power Monitoring](Sonoff-Pow-and-Pow-R2)
|Command | Parameters
|:--- | :---
@ -311,11 +311,12 @@ WattRes | Power sensor resolution<BR>`0..3` = maximum number of decimal points
See Also | [`SetOption21`](#SetOption21) - Energy monitoring when power is off<BR>[`SetOption33`](#SetOption33) - Configure power monitoring Max_Power_Retry count number<BR>
### [Light](Lights)
<!--- <a id="Brightness>"></a>Brightness|`0..255` = set brightness value from 0 to 255 (intoduced in 6.5.0.9)<a id="Channel"></a> -->
<!--- <a id="Brightness>"></a>Brightness|`0..255` = set brightness value from 0 to 255 (introduced in 6.5.0.9)<a id="Channel"></a>
Channel\<x\>|`0..100` = set PWM channel dimmer value from 0 to 100%<a id="Color"></a> -->
|Command | Parameters
|:--- | :---
Channel\<x\>|`0..100` = set PWM channel dimmer value from 0 to 100%<a id="Color"></a>
<a id="Channel"></a>Channel\<x\>|`0..100` = set PWM channel dimmer value from 0 to 100%<a id="Color"></a>
Color | Show color setting (hex or decimal depending on [`SetOption17`](#SetOption17))<BR> `r,g,b` = set color by decimal value (`0..255`)<BR>`#CWWW` = set hex color value for CT lights <BR>`#RRGGBB` = set hex color value for RGB lights<BR>`#RRGGBBWW` = set hex color value for RGBW lights<BR>`#RRGGBBCCWW` = set hex color value for RGBCCT lights (5 PWM channels)
| | Set color to<BR>`1` = red<BR>`2` = green<BR>`3` = blue<BR>`4` = orange<BR>`5` = light green<BR>`6` = light blue<BR>`7` = amber<BR>`8` = cyan<BR>`9` = purple<BR>`10` = yellow<BR>`11` = pink<BR>`12` = white (using RGB channels)<BR>`+` = next color<BR>`-` = previous color<a id="Color2"></a>
Color2 | Same as `Color` but adjust to current `Dimmer` value<a id="Color3"></a>
@ -380,7 +381,7 @@ SetOption3|[MQTT](mqtt) <BR>`0` = disable MQTT<BR> `1` = enable MQTT *(default)*
SetOption4|Return MQTT response as<BR> `0` = RESULT topic *(default)*<BR> `1` = %COMMAND% topic<a id="SetOption8"></a>
SetOption8|Show temperature in<BR> `0`= Celsius *(default)*<BR> `1` = Fahrenheit<a id="SetOption10"></a>
SetOption10|When the device MQTT topic changes <BR> `0` = remove retained message on old topic LWT *(default)*<BR> `1` = send "Offline" to old topic LWT<a id="SetOption11"></a>
SetOption11|Swap button single and double press [functionality](https://github.com/arendst/Sonoff-Tasmota/wiki/Control-other-devices#double-press--hold)<BR> `0` = disabled *(default)*<BR> `1` = enabled<a id="SetOption12"></a>
SetOption11|Swap button single and double press [functionality](Control-other-devices#double-press--hold)<BR> `0` = disabled *(default)*<BR> `1` = enabled<a id="SetOption12"></a>
SetOption12|Configuration saving to flash option<BR>`0` = allow dynamic flash save slot rotation *(default)*<BR>`1` = use fixed eeprom flash slot <a id="SetOption13"></a>
SetOption13|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`](#setoption32)).<a id="SetOption15"></a>
SetOption15|Set PWM control for LED lights<BR>`0` = basic PWM control<BR>`1` = control with [`Color`](#Color) or [`Dimmer`](#Dimmer) commands<a id="SetOption16"></a>
@ -400,7 +401,7 @@ SetOption32|Number of 0.1 seconds to hold button before sending `hold` action me
SetOption33|Max power limit can be exceeded by number of seconds before the relay is turned off<BR> `1..250` = set number of seconds *(default = `5`)*<a id="SetOption34"></a>
SetOption34|Set [Tuya dimmer device id](https://github.com/arendst/Sonoff-Tasmota/pull/4095)<BR> `0..255` = device id<a id="SetOption36"></a>
SetOption36|Boot loop defaults restoration control.<BR>`0` = disable boot loop control<BR> `1..200` = set number of boot loops (a restart caused by any exception or watchdog timer within less than `BOOT_LOOP_TIME` (default 10) seconds) before beginning to restore settings *(default = `1`)*. Once this number is reached, subsequent restarts will:<ul><li>1st restart: disable ESP8285 generic GPIOs interfering with flash SPI</li><li>2nd restart: disable rules causing boot loop</li><li>3rd restart: disable all rules</li><li>4th restart: reset user defined GPIOs to disable any attached peripherals</li><li>5th restart: reset module to Sonoff Basic (1)</li></ul><a id="SetOption37"></a>
SetOption37|Color remapping for led channels, also provides an option for allowing independent handling of RGB and white channels.<BR>`0` = disabled<br>`1..119` = according to [this table](https://github.com/arendst/Sonoff-Tasmota/wiki/SetOption37---Color-channel-mapping)<br>`120..127` = invalid (results in same as `0`)<br>`128..255` = same as `0..127` but with independent channel handling enabled <a id="SetOption51"></a>
SetOption37|Color remapping for led channels, also provides an option for allowing independent handling of RGB and white channels.<BR>`0` = disabled<br>`1..119` = according to [this table](SetOption37---Color-channel-mapping)<br>`120..127` = invalid (results in same as `0`)<br>`128..255` = same as `0..127` but with independent channel handling enabled <a id="SetOption51"></a>
SetOption51|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"></a>
SetOption52|Control display of optional time offset from UTC in JSON messages<BR>`0` = disable *(default)*<BR> `1` = enable<a id="SetOption53"></a>
SetOption53|Display hostname and IP address in GUI<BR>`0` = disable *(default)*<BR> `1` = enable<a id="SetOption54"></a>
@ -454,7 +455,7 @@ MP3Stop | Stop<a id="MP3Track"></a>
MP3Track|`x` = play track \<x\><a id="MP3Volume"></a>
MP3Volume|`0..100` = set Volume
### [Domoticz](https://github.com/arendst/Sonoff-Tasmota/wiki/Domoticz)
### [Domoticz](Domoticz)
|Command | Parameters
|:--- | :---
@ -496,7 +497,7 @@ OPTION| OPTION Value| OPTION| OPTION Value
15| Button 7| 255| EMPTY
16| Button 8 |
### [Displays](https://github.com/arendst/Sonoff-Tasmota/wiki/Displays)
### [Displays](Displays)
|Command | Parameters
|:--- | :---