Commands - stodev-com-br/Tasmota GitHub Wiki
The Tasmota documentation has moved to https://tasmota.github.io/docs/#/Commands!
- How to Use Commands
- Control
- Management
- Wi-Fi
- MQTT
- Rules
- Timers
- Sensor
- Power Monitoring
- Light
- Sonoff RF Bridge
- IR Remote
- SetOption overview
- Serial Bridge
- MP3 Player
- Domoticz
- KNX
- Displays
- Stepper Motors
- Blinds, Shutters and Roller Shades
- Zigbee
Tasmota provides three powerful man machine interfaces:
MQTT, web and serial.
To send commands and view responses you'll need an MQTT client.
Commands over MQTT are issued by using cmnd/%topic%/<command> <parameter>
where %topic%
is the topic of the device you're sending the command to. If there is no <parameter>
(an empty MQTT message/payload), a query is sent for current status of the <command>
.
See MQTT wiki to find out more.
Commands can be executed via web (HTTP) requests, for example:
http://<ip>/cm?cmnd=Power%20TOGGLE
http://<ip>/cm?cmnd=Power%20On
http://<ip>/cm?cmnd=Power%20off
http://<ip>/cm?user=admin&password=joker&cmnd=Power%20Toggle
Any spaces or special characters must be replaced with their respective ASCII hex codes. You must precede the hex code with %
(e.g., ;
= %3B
).
If you have set a password for web user interface access, this must be included (in plaintext) in the URL of the HTTP request, like so:
http://<ip>/cm?&user=put_username_here&password=put_password_here&cmnd=Power%20On
Console menu in the web UI is a convenient place to send commands and it behaves similar to a terminal connection via serial bridge.
If you flashed the device via serial method you can connect to it with a terminal application (e.g. Termite or Arduino IDE Serial Monitor) to issue commands and follow responses. This is a practical way to do a Backlog
setup of your new device.
*The serial interface is set to 115200 bps except for devices that require a different baudrate.
Backlog
command allows executing up to 30 consecutive commands with a single command line. Each command is separated by a semicolon (";"). Backlog
is a useful feature to avoid numerous restarts when setting up a new device. You can use it to:
Set up both Wi-Fi AP's
Backlog ssid1 myssid; password1 mypassword; ssid2 myssid2; password2 mypassword2
Configure MQTT broker address, MQTT credentials, device topic and activate a few custom options
Backlog mqtthost <yourhost>; mqttuser <user>; mqttpassword <password>; topic <customtopic>; setoption53 1; powerretain on
For specific relay control, using backlog like a script
Backlog status 1; power 2 on; delay 20; power 2 off; status 4
When using web requests (You have to encode "space" as '%20' and ";" as '%3B')
http://<ip>/cm?user=admin&password=joker&cmnd=Backlog%20Power%20Toggle%3BPower1%20ff
A Backlog
command without an argument clears an possible existing Backlog
queue.
E.g. in case of command Backlog Power1 OFF; Delay 600; Power1 ON
the usage of an additional Backlog
command without any argument within the delay time of 1 minute will delete the whole queue Power1 OFF; Delay 600; Power1 ON
. Therefore Power1 ON
command will not be executed and the relay would remain off.
Unless noted otherwise, commands that do not indicate an introduction version are available since 5.10. If you're using an older 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 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
Instead of 0
you can use off
and instead of 1
you can use on
.
-
Power ON
turns Relay1 on -
Power1 1
also turns Relay1 on
Replace <x>
in a command with the appropriate index number. Leave it empty to use the first available.
-
Power1
andPower
both control Relay1
In commands with x..y
value parameters use a number from x
to y
range.
When a command mentions resetting to "firmware default" it means the setting will revert to the one in the flashed binary file. If you used user_config_override.h
at compile time it will revert to those.
Note: Beside results initiated by a command (synchronous) you can get asynchronous results initiated by rule trigger, telemetry event, commands from other source or changed device values. Simply put, other messages may precede messages published as a result of your commands.
- a
tele/%topic%/STATUS
message (sent every 300 seconds by default) may appear exactly after you issuePower off
command and before you receivestat/%topic%/RESULT = {"POWER":"OFF"}
message.
Command | Parameters |
---|---|
Backlog | List of commands to be executed in sequence separated by ; See Using Backlog for examples. |
BlinkCount | Number of relay toggles (blinks) (does not control the status LED)0 = blink many times before restoring power state 1..32000 = set number of blinks (default = 10 )
|
BlinkTime |
2..3600 set duration, in 0.1 second increments, to blink (i.e., toggle Power) for a relay (does not control the status LED)
|
ButtonDebounce | User control over button debounce timing »6.2.040..1000 = set button debounce time in milliseconds (default = 50 )
|
Buzzer |
0 = stop active buzzer cycle »6.6.0.18<count>,<beep>,<silence>,<tune> = read more...2,3 - Beep twice with 300 milliseconds duration and 100 milliseconds pause2,3,4 - Beep twice with 300 milliseconds duration and 400 milliseconds pause1,2,3,0xF54 (0000 0000 0000 0000 0000 1111 0101 0100). Each 1 bit beeps for 200 milliseconds and each bounded 0 bit pauses for 300 milliseconds |
FanSpeed | Fan speed control (iFan02/iFan03 only) »6.1.00 = turn fan OFF1..3 = set fan speed+ = increase fan speed - = decrease fan speed |
Interlock | Relay interlock mode and group selection. »6.5.00 = disable relay interlock for all relays (i.e., each relay is self-locking) (default)1 = set interlock mode for selected relays |
Add up to 8 relays in 1 to 4 interlock groups, each separated by a space. For example1,2 3,4 = Group Relay1 and Relay2 in group 1 and Relay3 and Relay4 in group 2 (note the space between the two group declarations) 1,2,3 = group Relay1, Relay2 and Relay3 in a single interlock group 1 3 2,4 = Relay1 is in group 1, Relay3 in group 2, Relay2 and Relay4 in group 3 |
|
LedMask | Set a bitmask specifiying which relays control the LED indicator. Read more... »6.6.0<bitmask> = bitwise value representing each relay. Values may be entered as either hexadecimal or decimal values (e.g., 0xFFFF = 65535).0xFFFF (= 1111 1111 1111 1111) All relays control the power LED (default)LedState must be enabled (i.e., != 0 ) in order for LedMask to take effect.
|
LedPower | LED power state as on or off 0 = turn LED OFF and set LedState 0 1 = turn LED ON and set LedState 8 2 = toggle LED and set LedState 0 (Use Backlog LedPower 0; SetOption31 1 to disable LED even when Wi-Fi or MQTT is not connected) |
LedPower<x> | LED<x> power state control. Enabled only when LedLink(i) is configured »6.6.00 = turn LED OFF and set LedState 0 1 = turn LED ON and set LedState 0 2 = toggle LED and set LedState 0
|
LedState | Manage LED state0 = disable use of LED as much as possible 1 = show power state on LED (LED on when power on) (default) (inverted for Sonoff Touch/T1)2 = show MQTT subscriptions as a LED blink3 = show power state and MQTT subscriptions as a LED blink4 = show MQTT publications as a LED blink5 = show power state and MQTT publications as a LED blink6 = show all MQTT messages as a LED blink7 = show power state and MQTT messages as a LED blink8 = 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
|
Power0 | Control the power state simultaneously for all relays on the device »6.6.0.90 / off = turn OFF 1 / on = turn ON 2 / toggle = if relay is ON switch to OFF and vice versa |
Power<x> | Control the corresponding Relay (enumerated) power state and also restart PulseTime<x>0 / off = turn OFF 1 / on = turn ON 2 / toggle = if relay is ON switch to OFF and vice versa3 / blink = toggle power for BlinkCount times each 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 when the device is powered up. More information0 / 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 mode) |
PulseTime<x> | Display the amount of PulseTime remaining on the corresponding Relay (enumerated)<value> Set the duration to keep the corresponding Relay ON when Power<x> ON command is issued. After this amount of time, the relay will be turned OFF .0 / OFF = disable use of PulseTime for the corresponding Relay1..111 = set PulseTime for the corresponding Relay in 0.1 second increments112..64900 = set PulseTime for the corresponding 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 »6.2.040..1000 = set switch debounce time in milliseconds (default = 50 )
|
SwitchMode<x> |
Switch mode 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 |
SetOption1 - Set button multipress modeSetOption11 - Swap pushbutton single and double press functionalitySetOption13 - Allow immediate action on single button pressSetOption26 - Use indexes even when only one relay is presentSetOption31 - Disable Wi-Fi LED status blinkingSetOption32 - Set hold interval before sending HOLD actionSetOption40 - Stop detecting any input change on button GPIOSetOption67 - Enable/Disable Buzzer |
Command | Parameters |
---|---|
Delay |
2..3600 = set delay between two backlog commands with 0.1 second increment |
DeepSleepTime | Time to enter deep sleep mode »6.6.0.180 = disable deep sleep mode (default)10..86400 = set deep sleep mode time period in seconds |
Emulation |
0 = disable emulation (default)1 = enable Belkin WeMo emulation for Alexa2 = enable Hue Bridge emulation for Alexa
|
FriendlyName<x> |
1 = Reset friendly name to firmware default<value> = set friendly name (32 char limit) |
Gpios | Show list of available components by name and index255 / All Show list of all components by name and index »6.6.0.12 |
Gpio | Show current component assignments of the Module's configurable GPIO255 / All Show component assignments for all the devices available GPIO »6.6.0.17 |
Gpio<x> |
<component> = assign <component> to Gpio<x> .For built-in Modules only. This command does not work for device's configured with a device Template. |
I2Cscan | Scan I2C bus and show addresses for found devices |
I2CDriver |
Enable / Disable I2C bus sensor drivers »7.0.0.3 |
LogHost |
1 = reset syslog host to firmware default (SYS_LOG_HOST )<value> = set syslog host (32 chars max) |
LogPort |
1 = reset syslog port to firmware default (SYS_LOG_PORT )2..32766 = set syslog port |
Modules | Show available modules by name and index |
Module | Displays active module by name and index<x> = switch to Module<x> and restart0 = switch to defined template and restart |
MqttLog |
0 = disable logging via MQTT (default)1 = show only error messages2 = show error and info messages3 = show error, info and debug messages4 = show error, info and more debug messsages |
NtpServer<x> | NTP server setup (x= 1..3 )0 = clear NtpServer<x> settings1 = reset NtpServer<x> settings to firmware defaults<value> = set NtpServer<x> host or IP address (32 char limit) |
OtaUrl | Display current OTA URL1 = Reset OtaUrl to firmware defaulturl = set address for OTA (100 char limit) |
Pwm<x> |
0..1023 = set PWM value for channel |
PwmFrequency |
1 = reset PWM frequency to 880Hz100..4000 = set PWM frequency (100Hz to 4kHz) |
PwmRange |
1 = reset maximum PWM range to 1023255..1023 = set maximum PWM range |
Reset |
1 = reset device settings to firmware defaults and restart2 = erase flash, reset device settings to firmware defaults and restart3 = erase System Parameter Area in flash (Wi-Fi calibration and related data) and restart4 = reset device settings to firmware defaults but retain Wi-Fi credentials and restart »6.3.05 = erase all flash and reset parameters to firmware defaults but keep Wi-Fi settings and restart6 = erase all flash and reset parameters to firmware defaults but keep Wi-Fi and MQTT settings and restart(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) 99 = reset device bootcount to zero »6.6.0.10 |
Restart |
1 = restart device99 = force restart device without configuration save |
SaveData |
0 = save parameter changes only manually1 = save parameter changes every second (default)2..3600 = save parameter changes every x second |
SerialLog | Disable hardware serial bridge and0 = disable serial logging1 = show only error messages2 = show error and info messages (default)3 = show error, info and debug messages4 = show error, info and more debug messagesSerialLog will be disabled automatically 10 minutes after the device reboots. |
Sleep |
0 = turn sleep off1..250 = set sleep duration in milliseconds to enable energy saving (default = 50 )
|
State | Display current device state and publish to %prefix%/%topic%/RESULT topic »5.12.0 |
Status |
= show abbreviated status information0 = show all status information (1 - 11)1 = show device parameters information2 = show firmware information3 = show logging and telemetry information4 = show memory information5 = show network information6 = show MQTT information7 = show time information8 = show connected sensor information9 = show power thresholds (only on modules with power monitoring)10 = same as Status 8 (retained for backwards compatibility)11 = show information equal to TelePeriod state message |
SysLog |
0 = disable syslog logging (default)1 = show only error messages2 = show error and info messages3 = show error, info and debug messages4 = show error, info and more debug messages |
Template | Show current Template »6.5.00 = create template from active modulex = create template from a supported module255 = merge current module and template settings into new template{ ... } = store template in a JSON payloadDoes not activate the template. To activate use Module 0 . |
Time |
0 = enable NTP (default) »6.6.0.11 = format JSON message timestamp in ISO format »6.6.0.102 = format JSON message timestamp in both ISO and Epoch format3 = format JSON message timestamp in Epoch format<value> = disable NTP and set UTC time as epoch value if greater than 1451602800 (January 1, 2016) »6.6.0.1 |
TimeSTD TimeDST |
Set policies for the beginning of daylight saving time (DST) and return back to standard time (STD) »5.14.00 = reset parameters to firmware defaultsH ,W ,M ,D ,h ,T 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 1 = sunday 7 = saturday)h = hour (0..23 )T = timezone (-780..780 ) (offset from UTC in MINUTES - 780min / 60min=13hrs)Example: TIMEDST 1,1,10,1,2,660
|
Timezone |
-13..+13 = set timezone offset from UTC in hours-13:00..+13:00 = set timezone offset from UTC in hours and minutes99 = use timezone configured with TimeDST and TimeSTD
|
TuyaMCU | Used to map functions in TuyaMCU »6.7.1<fnId>,<dpId> = read more...<fnId>,0 = remove setting for fnId |
Upgrade |
1 = download firmware from OtaUrl and restart<value> = download firmware from OtaUrl if <value> is higher than device version |
Upload |
1 = download firmware from OtaUrl and restart<value> = download firmware from OtaUrl if <value> is higher than device version |
WebLog |
0 = disable web logging1 = show only error messages2 = show error and info messages (default)3 = show error, info and debug messages4 = show error, info and more debug messages |
See also |
SetOption68 - PWM Channel controlSetOption76 - DeepSleep disable bootcount incrementing |
Command | Parameters |
---|---|
AP |
0 = switch to other Wi-Fi Access Point1 = select Wi-Fi Access Point 12 = select Wi-Fi Access Point 2 |
Hostname |
1 = reset hostname to MQTT_TOPIC-<4digits> and restart<value> = set hostname (32 char limit) and restart. If hostname contains % it will be reset to the default instead.If using MQTT to issue this command, if it is used with the device GroupTopic , the command will not be executed.
|
IPAddress<x> | Set networking IP (XXX.XXX.XXX.XXX ) addressesIPAddress1 = set device IP address0.0.0.0 = use dynamic IP address (DHCP)XXX.XXX.XXX.XXX = set static IP addressIPAddress2 = set gateway IP addressIPAddress3 = set subnet maskIPAddress4 = set DNS server IP addressfollow IPAddress commands with restart 1 to apply changes
|
Password<x> |
<x> = 1..2 <value> = set AP<x> Wi-Fi password and restart1 = reset AP<x> Wi-Fi password to firmware default (STA_PASS1 or STA_PASS2 ) and restartPasswords are limited to 64 characters. Do not use special characters or white spaces in the password. Note that Password and Password1 are equivalent commands.
|
Ssid<x> |
<x> = 1..2 <value> = set AP<x> Wi-Fi SSID and restart1 = reset AP<x> Wi-Fi SSID to firmware default (STA_SSID1 or STA_SSID2 ) and restartSSID are limited to 32 characters. Do not use special characters or white spaces in the SSID |
WebColor<x> | Configure Web GUI colors (x = 1..19 ) »6.6.0#RRGGBB = Set color for WebColor<x> 1 = Global text (Black)2 = Global background (White)3 = Form background (Greyish)4 = Input text (Black)5 = Input background (White)6 = Console text (Black)7 = Console background (White)8 = Warning text (Red)9 = Success text (Green)10 = Button text (White)11 = Button (Blueish)12 = Button hovered over (Darker blueish)13 = Restart/Reset/Delete button (Redish)14 = Restart/Reset/Delete button hover (Darker reddish)15 = Save button (Greenish)16 = Save button hover (Darker greenish)17 = Config timer tab text (White)18 = Config timer tab background (Light grey)19 = Module title and FriendlyName text (Whiteish)User themes |
WebPassword | Show current web server password0 = disable use of password for web UI1 = reset password to firmware default (WEB_PASSWORD )<value> = set web UI password (32 char limit) for user WEB_USERNAME (Default WEB_USERNAME = admin )
|
WebRefresh | Web page refresh »6.3.01000..10000 = set refresh time in milliseconds (default = 2345 )
|
WebSend | Send a command to Tasmota host over http. If a command starts with a \ it will be used as a link. »6.1.0[<host>:<port>,<user>:<password>] <command> <host> = hostname or IP address.<port> = port for the device if not the default 80 <user> = enter username of the device you're sending the command to<password> = enter password of the device you're sending the command to<command> = command and payloadexample: [<ip>] POWER1 ON sends http://<ip>/cm?cmnd=POWER1 ON
|
WebSensor<x> | Control display of sensor telemetry in the web UI »6.6.0.50 - Do not display sensor's telemetry1 - Display sensor's telemetry (default)<x> = number corresponding to the sensor - listed in the sns section of the supported sensor spreadsheet<x> = 3 Energy telemetryIssue a Status 4 to obtain a list of sensor types enabled in the firmware loaded on the device. |
WebServer |
0 = stop web server1 = start web server in user mode2 = start web server in admin mode |
WifiConfig |
0 - disable Wi-Fi Manager and reboot (used with alternate AP)2 = set Wi-Fi Manager as the current configuration tool and start Wi-Fi Manager (web server at 192.168.4.1) for 3 minutes, then reboot and try to connect Wi-Fi network4 = disable Wi-Fi Manager but retry the other AP without rebooting5 = disable Wi-Fi Manager and wait for the AP to be available again without rebooting6 = Wi-Fi parameters can only be entered via commands in the serial console7 = set Wi-Fi Manager (web server at 192.168.4.1) as the current configuration tool restricted with the only option to reset settings. »6.5.0This setting is recommended for devices without an external control/reset button. No longer supported » v6.6.0.21 1 = set SmartConfig (Android/iOS) as the current configuration tool, start SmartConfig for 3 minutes and reboot and try to connect to Wi-Fi3 = set WPS as configuration tool, try WPS for 3 minutes and reboot and try to connect to Wi-Fi |
WifiPower | set Wi-Fi transmit power level in decibel-milliwatts (dBm) (default = 17 )
|
See also |
SetOption55 - mDNS service controlSetOption56 - Wi-Fi network scan to select strongest signal on restartSetOption57 - Wi-Fi network re-scan, alternate AP |
Command | Parameters |
---|---|
ButtonRetain |
0 = disable use of MQTT retain flag (default)1 = enable MQTT retain flag on button press |
ButtonTopic |
<value> = set MQTT button topic (32 chars max)0 = disable use of MQTT button topic1 = set MQTT button topic to device %topic% 2 = reset MQTT button topic to firmware default (MQTT_BUTTON_TOPIC ) (default = 0 )If using MQTT to issue this command, if it is published to the device GroupTopic , the command will not be executed.
|
FullTopic |
1 = reset MQTT fulltopic to firmware default (MQTT_FULLTOPIC ) and restart<value> = set MQTT fulltopic (100 chars max) and restart. Use of optional %prefix%, %topic%, %hostname%, and %id% substitution tokens is allowed.If using MQTT to issue this command, if it is published to the device GroupTopic , you must ensure uniqueness of the resulting fulltopic on each destination device by using one or more of these substitution tokens.
|
GroupTopic |
1 = reset MQTT group topic to firmware default (MQTT_GRPTOPIC ) and restart<value> = set MQTT group topic (32 chars max) and restart |
MqttClient |
1 = reset MQTT client to firmware config (MQTT_CLIENT_ID ) and restart<value> = set MQTT client (32 chars max) and restart.You can use the %06X substitution token to replace with last six characters of MAC address.If using MQTT to issue this command, if it is used with the device GroupTopic , the command will not be executed.
|
MqttFingerprint |
TLS needs to be enabled in firmware for this command »5.13.1<value> = set current fingerprint as 20 space separated bytes (59 chars max) |
MqttHost |
0 = clear MQTT host field and allow mDNS to find MQTT host1 = reset MQTT host to firmware default (MQTT_HOST ) and restart<value> = set MQTT host (32 chars max) and restart (do NOT use .local ) |
MqttPassword |
0 = clear MQTT password1 = reset MQTT password to firmware default (MQTT_PASS ) and restart<value> = set MQTT password (32 chars max) and restart |
MqttPort |
1 = reset MQTT port to firmware default (MQTT_PORT ) and restart<value> = set MQTT port between 2 and 32766 and restart |
MqttRetry |
10..32000 = set MQTT connection retry timer in seconds (default = 10 )
|
MqttUser |
0 = clear MQTT user name1 = reset MQTT user name to firmware default (MQTT_USER ) and restart<value> = set MQTT user name (32 chars max) and restart |
PowerRetain | MQTT power retain state0 / off = disable MQTT power retain on status update (default) 1 / on = enable MQTT power retain on status update |
Prefix1 |
1 = reset MQTT command subscription prefix to firmware default (SUB_PREFIX ) and restart<value> = set MQTT command subscription prefix (10 chars max) and restart |
Prefix2 |
1 = reset MQTT status prefix to firmware default (PUB_PREFIX ) and restart<value> = set MQTT status prefix (10 chars max) and restart |
Prefix3 |
1 = Reset MQTT telemetry prefix to firmware default (PUB_PREFIX2 ) and restart<value> = set MQTT telemetry prefix (10 chars max) and restart |
Publish |
<topic> <payload> = MQTT publish any topic and optional payload »5.13.0 |
Publish2 |
<topic> <payload> = MQTT publish any topic and optional payload with retain flag »6.2.0 |
SensorRetain |
0 = disable use of sensor MQTT retain flag (default)1 = enable MQTT retain flag on message tele/%topic%/SENSOR
|
StateText1 |
<value> = set OFF state text (10 chars max) |
StateText2 |
<value> = set ON state text (10 chars max) |
StateText3 |
<value> = set TOGGLE state text (10 chars max) |
StateText4 |
<value> = set HOLD state text (10 chars max) |
SwitchRetain |
0 = disable use of MQTT retain flag (default)1 = enable MQTT retain flag on switch press |
Subscribe | Subscribes to an MQTT topic and assigns an Event name to it. »6.5.0<eventName>, <mqttTopic> [, <key>] = Read more... = list all topics currently subscribed |
SwitchTopic |
<value> = set MQTT switch topic (32 chars max)0 = disable use of MQTT switch topic1 = set MQTT switch topic to device %topic% 2 = reset MQTT switch topic to firmware default (MQTT_SWITCH_TOPIC ) (default = 0 )Read more about this. If using MQTT to issue this command, if it is used with the device GroupTopic , the command will not be executed.
|
TelePeriod |
0 = disable telemetry messages1 = 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<value> = set MQTT topic (32 chars max) and ButtonTopic and restart.If using MQTT to issue this command, if it is used with the device GroupTopic , the command will not be executed. (Mqtt Topic can't be equal to Mqtt Client)
|
Unsubscribe | Unsubscribe from topics subsribed to with Subscribe »6.5.0 = unsubscribe all topics<eventName> = unsubscribe from a specific MQTT topic |
See also |
SetOption4 - Return MQTT response as RESULT or %COMMAND% topicSetOption10 - Main topic change behavior |
Command | Parameters |
---|---|
Add<x> |
<value> = add value to Var<x> (example) »6.1.0 |
CalcRes | Current calculation resolution »6.4.00..7 = set number of decimal places to be used in Add , Sub , Mult and Scale
|
Event | Execute an event to trigger a rule as documented »5.13.0 |
Mem<x> | Manage up to 5 variables stored on flash (x = 1..5 ) »6.1.0Mem returns all current values. Mem<x> returns the variable's current value. »6.6.0.2<value> = store a string value in a variable" = clear stored value in Mem<x> |
Mult<x> |
<value> = multiply value to Var<x> (example) »6.1.0 |
Rule<x> | Rules. Read more... »6.1.00 = disable Rule<x>1 = enable Rule<x>2 = toggle Rule<x>4 = disable one-shot detection (perform commands as long as trigger is met)5 = enable one-shot (e.g., sometimes used for slow changing sensors like temperature) detection6 = toggle one-shot detection8 = disable stop-on-error after exception restart9 = enable stop-on-error after exception restart10 = toggle stop-on-error after exception restart<value> = define Rule<x>+<value> = append to Rule<x> = clear Rule<x> |
RuleTimer<x> | Up to eight timers to be used as countdown event (x = 1..8 ) »5.13.00..32766 = set countdown rule timer in seconds |
Scale<x> | Scale value from a low and high limit to another low and high limits and save in Var<x> (example) »6.1.0v = value: the number to scalefl = fromLow: the lower bound of the value’s current rangefh = fromHigh: the upper bound of the value’s current rangetl = toLow: the lower bound of the value’s target rangeth = toHigh: the upper bound of the value’s target range |
Sub<x> |
<value> = subtract value to Var<x> (example) »6.1.0 |
Var<x> | Manage up to 5 variables stored in memory (x = 1..5 ) »6.1.0Var returns all current values. Var<x> returns the variable's current value. »6.6.0.2<string> = store a string value in a variable" = clear stored value in Var<x> |
» v5.13.1
Command | Parameters |
---|---|
Latitude |
<value> = set latitude |
Longitude |
<value> = set longitude |
Timers | Timers control0 = disable all timers »6.2.01 = enable all timers2 = toggle all timers |
Timer<x> | Parameters for Timer<x> where x = 1..16 0 = clear parameters for Timer<x> »6.2.01..16 = copy Timer<y> parameters to Timer<x>{ "name":value ; .. } = set all or individual parameters using JSON payload with names and values of data pairs from the table
|
Note: Information on sensors documented below is transmitted in the Tasmota telemetry message
Command | Parameters |
---|---|
AdcParam | ADC0 analog input tuning parameters »6.6.0<sensor>, <param1>, <param2>, <param3> <sensor> 2 = Temperature Steinhart-Hart thermistor equation parameters:<param1> = NTC Voltage bridge resistor in Ohms (default = 32000 )<param2> = NTC Resistance in Ohms (default = 10000 )<param3> = NTC Beta Coefficient (default = 3350 )
3 = Light Lux equation parameters:<param1> = LDR Voltage bridge resistor in Ohms (default = 10000 )<param2> = LDR Lux Scalar (default = 12518931 )<param3> = LDR Lux Exponent (default = -1.4050 )
|
Altitude |
-30000..30000 - altitude in meters |
AmpRes | Current sensor resolution0..3 = maximum number of decimal places |
Counter<x> |
0 = reset Counter<x>1..64900 = preset Counter<x>-1..-64900 = decrease Counter<x>+1..+64900 = increase Counter<x>In order to define and use a Counter, you must configure one of the free device GPIO as Counter<x>
|
CounterDebounce |
0 = turn off counter debounce1..3200 = set counter debounce time in milliseconds |
CounterType<x> |
0 = set Counter<x> as pulse Counter1 = set Counter<x> as pulse Timer |
HumRes | Humidity sensor resolution0..3 = maximum number of decimal places |
PressRes | Pressure sensor resolution0..3 = maximum number of decimal places |
Sensor13 |
INA219 low voltage current sensor calibration mode0 = set INA219 calibration to max 32V and 2A1 = set INA219 calibration to max 32V and 1A2 = set INA219 calibration to max 16V and 0.4A |
Sensor15 |
Automatic Baseline Correction for MH-Z19B CO2 sensor0 = disabled1 = enabled (default)2 = disable and start manual calibration from 400 ppm of CO29 = reset sensor to factory defaults1000 = sets measurement range to 1000ppm CO22000 = sets measurement range to 2000ppm CO23000 = sets measurement range to 3000ppm CO25000 = sets measurement range to 5000ppm CO2
|
Sensor20 |
Nova Fitness SDS011 dust sensor. »6.5.0.3 1..255` = number of seconds before TelePeriod to poll the sensor |
Sensor27 |
APDS-9960 sensor commands0 = enable light level and proximity sensor / disable gestures (default) 1 = enable gesture mode/ disable light level and proximity sensor2 = enable gestures with half gain / disable light and proximity sensor3..255 = Set ATIME register for different integration times |
Sensor29 | MCP23008 / MCP23017 I2C GPIO Expander configuration (additional details)Reset<x> = reset all pinsx = 1..6 1 = INPUT mode, no reporting, no pull-up2 = INPUT mode, report on CHANGE, pull-up enabled3 = INPUT mode, report on LOW, pull-up enabled4 = INPUT mode, report on HIGH, pull-up enabled5 = OUTPUT mode (if enabled by #define USE_MCP230xx_OUTPUT )6 = inverted OUTPUT mode (if enabled by #define USE_MCP230xx_OUTPUT )pin,pinmode{,intpullup|outstate{,repmode}} Continue reading... |
Sensor34 | »6.6.0 HX711 load cell sensor calibration 1 = reset display to 02 = start calibration2 <value> = set reference weight in grams and start calibration3 = show reference weight in grams3 <value> = set reference weight in grams4 = show calibrated scale value4 <value> = set calibrated scale value5 = show max weight in gram5 <value> = set max weight in grams6 = show single item weight in grams6 <value> = set single item weight in grams. Once the item weight is set, when items are added to the scale, the telemetry message will report Count as the number of items on the scale7 = save current weight to be used as start weight on restart8 0/1 »6.6.0.130 = disable JSON message on weight change over 4 grams1 = enable JSON message on weight change over 4 grams |
Sensor50 |
PAJ7620 gesture sensor0 = sensor muted, no readings in Tasmota1 = gesture mode2 = proximity mode3 = corner mode4 = PIN mode5 = cursor mode |
Sensor53 |
Smart Meter Interfacer = reset the driver with a new descriptor specified with the Tasmota Scripting language.c<x> <value> = preset counter (x = 1..5 ) to value when the driver is set to counter moded<x> = disable data decoding and dump meter (x = 1..5 ) data to the Console. This is used to decipher the meter's data format to define the variable encoding in the meter's descriptor.d0 = disable data dump mode and revert to decoding mode. |
TempRes | Temperature sensor resolution0..3 = maximum number of decimal places |
TempOffset |
-12.7..12.7 = calibrate temperature sensor telemetry values »7.0.0.5This setting affects all temperature sensors on the device. |
VoltRes | Voltage sensor resolution0..3 = maximum number of decimal places |
WattRes | Power sensor resolution0..3 = maximum number of decimal places |
WeightRes | Load cell sensor resolution »6.3.00..3 = maximum number of decimal places |
See also |
SetOption8 - Show temperature in Celsius (default) or FahrenheitSetOption18 - Set status of signal light paired with CO2 sensorSetOption24 - Set pressure units |
Command | Parameters |
---|---|
AmpRes | Current sensor resolution0..3 = maximum number of decimal places |
CurrentCal | 1100..32767 (default = 3500 )Set calibration offset value for reported Current telemetry reading »6.4.1.6Allows finer calibration for HLW8012, HJL01, and BL0937 energy monitoring devices |
CurrentHigh |
0 = disable current high threshold (default)<value> = set current high threshold value in milliamps |
CurrentLow |
0 = disable current low threshold (default)<value> = set current low threshold value in milliamps |
CurrentSet |
<value> = calibrate current to target value in mA »5.12.0 |
EnergyRes | Energy sensor resolution0..5 = maximum number of decimal places |
EnergyReset<x> |
0..42500 (for 3 , Total, upper limit is 4250000 ) in watt-hours (Wh)x = 1..5 1 <value> = ((p)re)set values for Today2 <value> = ((p)re)set values for Yesterday3 <value> = ((p)re)set values for Total»6.6.0.13 4 <standard> {,<off-peak> } = ((p)re)set tariff period values for Totals5 <standard> {,<off-peak> } = ((p)re)set tariff period values for Exported |
FreqRes | Frequency sensor resolution »6.2.1.30..3 = maximum number of decimal places |
FrequencySet |
<value> = calibrate frequency to a target value in Hz »6.2.1.6 |
MaxPower |
0 - disable use maximum power monitoring<value> = set maximum allowed power in watts |
MaxPowerHold |
1 = set default time to 10 seconds to stay over MaxPower before power off<value> = set time in seconds to stay over MaxPower before power off |
MaxPowerWindow |
1 = set default time to 30 seconds to stay power off before re-applying power up to 5 times<value> = set time in seconds to stay power off before re-applying power up to 5 times |
ModuleAddress | Set the address of a PZEM module »6.6.0.121..3 = the last octet of the PZEM-004T serial address<address> = the last octet of the slave address on MODBUS PZEM energy monitoring modulesPrior to setting the module address, the PZEM must be connected to both RX and TX, and AC voltage. Connect one PZEM at a time and issue this command. Repeat for each PZEM to be connected for multi-phase monitoring. The command without an argument cannot be used to read the address of the connected PZEM. |
PowerCal | 4000..32767 (default = 12530 )Set calibration offset value for reported Power telemetry reading »6.4.1.6Allows finer calibration for HLW8012, HJL01, and BL0937 energy monitoring devices |
PowerDelta | Set maximum delta for energy monitoring devices to report on active power load change »5.13.00 = disable reporting on power change1..100 = set reporting on percentage power change to send an MQTT telemetry message101..32000 = set reporting on absolute power change to send an MQTT telemetry message (offset by 100, e.g., 101 =1W, 207 =107W) »6.6.0.19 |
PowerHigh |
0 = disable power high threshold (default)<value> = set power high threshold value in watts to send an MQTT telemetry message |
PowerLow |
0 = disable power low threshold (default)<value> = set power low threshold value in watts to send an MQTT telemetry message |
PowerSet |
<value> = calibrate power to a target value in watts »5.12.0 |
Status |
8 = show power usage9 = show power thresholds |
Tariff<x> | P1 Smart Meter tariff configuration »6.6.0.14 x = 1, 2, 9 1 STD,DST Start times for off-peak tariff2 STD,DST End times for off-peak tariff9 0/1 0 = use Start/End times also on weekends.1 = use off-peak tariff all weekend.STD and DST may be specified as:<hour> = 0..23 or<time> = 00:00..23:59 or<minutes> = 0..1439 (since midnight)If both Tariff1 STD and Tariff2 STD are equal, all tariffs are disabled. |
VoltageCal | Set calibration offset value for reported Voltage telemetry reading »6.4.1.61000..32767 (default = 1950 )Allows finer calibration for HLW8012, HJL01, and BL0937 energy monitoring devices |
VoltageHigh |
0 = disable voltage high threshold (default)<value> = set voltage high threshold value in V |
VoltageLow |
0 = disable voltage low threshold (default)<value> = set voltage low threshold value in V |
VoltageSet |
<value> = calibrate voltage to a target value in V »5.12.0 |
VoltRes | Voltage sensor resolution0..3 = maximum number of decimal places |
WattRes | Power sensor resolution0..3 = maximum number of decimal places |
See Also |
SetOption21 - Energy monitoring when power is offSetOption33 - Configure power monitoring Max_Power_Retry count number |
Command | Parameters |
---|---|
Channel<x> |
0..100 = set PWM channel dimmer value from 0 to 100% »5.13.0+ = increase by 10 »7.0.0.1- = decrease by 10 »7.0.0.1When SetOption68 is set to 1 , channel numbering begins with Relays first then PWM channels. Channel<x> will be aligned to Power<x> numbering.Example: 2 Relays and 3 PWM: Relay1 = Power1 Relay2 = Power2 PWM1 = Power3 and Channel3 PWM2 = Power4 and Channel4 PWM3 = Power5 and Channel5
|
Color<x> |
r,g,b = set color by decimal value (0..255 )#CWWW = set hex color value for CT lights #RRGGBB = set hex color value for RGB lights#RRGGBBWW = set hex color value for RGBW lights#RRGGBBCWWW = set hex color value for RGBCCT lights (5 PWM channels)x = 1..6 1 = Set color2 = Set color adjusted to current Dimmer value3 = Set clock seconds hand color (Scheme 5 only)4 = Set clock minutes hand color (Scheme 5 only)5 = Set clock hour hand color (Scheme 5 only)6 = Set clock hour marker colorWhite Blend Mode »6.3.0 |
Set color to1 = red2 = green3 = blue4 = orange5 = light green6 = light blue7 = amber8 = cyan9 = purple10 = yellow11 = pink12 = white (using RGB channels)+ = next color- = previous color |
|
CT |
153..500 = set color temperature from 153 (cold) to 500 (warm) for CT lights+ = increase CT value by 10- = decrease CT value by 10 |
Dimmer |
0..100 = set dimmer value from 0 to 100%+ = increase by 10- = decrease by 10 |
Dimmer<x> |
Commands available only when SetOption37 >= 128 (#6819) »7.0.0.1<value> same as in Dimmer Dimmer0 <value> - set dimming for all channelsDimmer1 <value> - set dimming for RGB channelsDimmer2 <value> - set dimming for white channels |
DimmerRange | Change dimming range »6.6.0.18<dimmerMin>,<dimmerMax> = set dimming range from minimum to maximum value Does not change Dimmer command behaviorWorks only with TuyaMCU and PS_16_DZ serial dimmers. |
Fade |
0 = do not use fade (default) 1 = use fade |
HsbColor |
<hue>,<sat>,<bri> = set color by hue, saturation and brightness |
HsbColor1 |
0..360 = set hue |
HsbColor2 |
0..100 = set saturation |
HsbColor3 |
0..100 = set brightness |
Led<x> |
#RRGGBB = set hex color value where <x> is the pixel number of the LED(applies only to addressable LEDs) |
LedTable |
0 = do not use LED gamma correction (default «6.5.0.9)1 = use gamma correction (default »6.5.0.9)
|
Pixels |
1..512 = set amount of pixels in strip or ring and reset Rotation (applies only to addressable LEDs)
|
RGBWWTable | Control compensation of unbalanced PWM channels or White Blend Mode »6.2.1.10PWM1,PWM2,PWM3,PWM4,PWM5 = channel range with values 0..255 (default =255,255,255,255,255 )Range adjustment is computed after Gamma correction. |
Rotation |
<value> = set amount of pixels to rotate (up to Pixels value) (applies only to addressable LEDs)
|
Scheme | Light effects+ = next scheme- = previous scheme0 = single color for LED light (default)1 = start wake up sequence (same as Wakeup )2 = cycle up through colors using Speed option3 = cycle down through colors using Speed option4 = random cycle through colors using Speed and Fade |
The following schemes are usable only with addressable LEDs, e.g. WS281X, Neopixel5 = clock mode (example)6 = candlelight pattern7 = RGB pattern8 = Christmas pattern9 = Hanukkah pattern10 = Kwanzaa pattern11 = rainbow pattern12 = fire pattern |
|
Speed |
1..20 = set fade speed from fast 1 to very slow 20 + = increase speed- = decrease speed |
Wakeup | Start wake up sequence from OFF to stored Dimmer value0..100 = Start wake up sequence from OFF to provided Dimmer value |
WakeupDuration |
1..3000 = set wake up duration in seconds |
White | »6.4.01..100 = set white channel brightness in single white channel lights (single W or RGBW lights) |
Width<x> | x = 1..4 1 - 0..4 = LED group width (Scheme 6..12 only)2 - 0..32 = seconds hand width (Scheme 5 only)3 - 0..32 = minutes hand width (Scheme 5 only)4 - 0..32 = hour hand width (Scheme 5 only)
|
See also |
SetOption15 , SetOption16 , SetOption17 , SetOption20 , SetOption37 and SetOption68
|
Command | Parameters |
---|---|
RfCode | Show last sent 24-bit user code1..8388607 = send 24-bit user code#1..#7FFFFF = send 24-bit hexadecimal user code using RfSync, RfLow and RfHigh timing |
RfHigh |
1 = reset high pulse time to 840 microseconds2..32767 = set high pulse time in microseconds#2..#7FFF = set high pulse time in hexadecimal microseconds |
RfHost | Show 16-bit host part of user code1 = reset 16-bit host part of user code to 11802 (#2E1A)2..32767 = set 16-bit host part of user code#2..7FFF = set 16-bit host part of user code in hexadecimal |
RfKey<x> | Send learned or default RF data for RfKey<x> (x = 1 – 16 )1 = send default RF data for RfKey<x> using RfSync, RfLow, RfHigh and RfHost parameters2 = learn RF data for RfKey<x>3 = unlearn RF data for RfKey<x>4 = save RF data using RfSync, RfLow, RfHigh and last RfCode parameters5 = show default or learned RF data6 = send learned RF data |
RfLow |
1 = reset low pulse time to 270 microseconds2..32767 = set low pulse time in microseconds#2..#7FFF = set low pulse time in hexadecimal microseconds |
RfRaw | »6.1.0 This command only works when the firmware has been updated with Portisch firmware. Refer to the Portisch wiki for details. Learning and Decoding RF Codes with Portisch Firmware 0 = Set iTead default firmware support and messages (default on restart)1 = set Portisch firmware support and messages166 or AAA655 = start sniffing/reading RF signals disabling iTead default RF handling167 or AAA755 = stop sniffing/reading RF signals enabling iTead default RF handling168 or AAA855 = transmitting iTead default RF protocols169 or AAA955 = start sniffing and learning predefined protocols176 or AAB055 = bucket Transmitting using command 0xB0177 or AAB155 = start Bucket sniffing using command 0xB1192 or AAC000C055 = beep (00C0 is the length of the sound)255 or AAFF55 = show Rf firmware version<value> = hexadecimal data to be sent to RF chip. This must be immediately followed by the RfRaw 0 command (e.g., Backlog RfRaw <value>; RfRaw 0
|
RfSync |
1 = reset start sync pulse time to 8470 microseconds2..32767 = set start sync pulse time in microseconds#2..#7FFF = set start sync pulse time in hexadecimal microseconds |
See also |
SetOption28 - Set RF received data format |
Command | Parameters |
---|---|
IRsend<x>
|
Send an IR remote control code as a decimal or hexadecimal string in a JSON payload. In order to send IR data, you must configure one of the free device GPIO as IRsend (8) . GPIO01 nor GPIO03 can be used.<x> [optional] = number of times the IR message is sent. If not specified or 0..1 , the message is sent only once (i.e., not repeated) (default)>1 = emulate a long-press on the remote control, sending the message <x> times, or sending a repeat message for specific protocols (like NEC){"Protocol":"<value>","Bits":<value>,"Data":<value>} "Protocol" (select one of the following):
"Bits":1..32 = required number of data bitsfor PANASONIC protocol this parameter is the the address, not the number of bits "Data":1..(2^32)-1 = data frame as 32 bit decimal.e.g., IRsend {"Protocol":"NEC","Bits":32,"Data":2170978686} or "Data":0x1..0xFFFFFFFF = data frame as 32 bit hexadecimal.e.g., IRsend {"Protocol":"NEC","Bits":32,"Data":0x8166817E} Alternatively, you can send IR remote control codes using RAW command encoding. Information on Receiving Infrared Data |
IRhvac | Send HVAC IR remote control code as JSON payload{"Vendor":"<value>","Power":<value>,"Mode":”<value>”, "FanSpeed":”<value>”,"Temp":<value>} "Vendor":"Toshiba"|"Mitsubishi"|"LG"|"Fujitsu" "Power":0|1 "Mode":"Hot"|"Cold"|"Dry"|"Auto" "FanSpeed":"1"|"2"|"3"|"4"|"5"|"Auto"|"Silence" "Temp":17..30
|
See also |
SetOption29 - Set IR received data formatSetOption38 - Set IR received protocol sensitivitySetOption58 - IR Raw data in JSON payload
|
Command | Parameters |
---|---|
SetOption0 | Save power state and use after restart (=SaveState)0 = disable1 = enable (default)
|
SetOption1 | Set button multipress mode to0 = allow all button actions (default)1 = restrict to single, double and hold actions (i.e., disable inadvertent reset due to long press) |
SetOption3 |
MQTT 0 = disable MQTT1 = enable MQTT (default)
|
SetOption4 | Return MQTT response as0 = RESULT topic (default)1 = %COMMAND% topic |
SetOption8 | Show temperature in0 = Celsius (default)1 = Fahrenheit |
SetOption10 | When the device MQTT topic changes 0 = remove retained message on old topic LWT (default)1 = send "Offline" to old topic LWT |
SetOption11 | Swap button single and double press functionality0 = disabled (default)1 = enabled |
SetOption12 | Configuration saving to flash option0 = allow dynamic flash save slot rotation (default)1 = use fixed eeprom flash slot |
SetOption13 | Allow immediate action on single button press0 = single, multi-press and hold button actions (default)1 = only single press action for immediate response (i.e., disable multipress detection). Disable by holding for 4 x button hold time (see SetOption32 ). |
SetOption15 | Set PWM control for LED lights0 = basic PWM control1 = control with Color or Dimmer commands (default)
|
SetOption16 | Set addressable LED Clock scheme parameter0 = clock-wise mode (default)1 = counter-clock-wise mode |
SetOption17 | Show Color string as0 = hex string (default)1 = comma-separated decimal string |
SetOption18 | Set status of signal light paired with CO2 sensor0 = disable light (default)1 = enable light |
SetOption19 |
Home Assistant automatic discovery. WARNING On version 6.4.1.x enabling may cause a watchdog reset if used on a device with a configured sensor 0 = disabled (default)1 = enabled and also sets SetOption59 = 1 If you enable and then disable SetOption19 , doing so does not set SetOption59 = 0 and does not revert to default %prefix%/%topic%/ FullTopic
|
SetOption20 | Update of Dimmer/Color/CT without turning power on0 = disabled (default)1 = enabled |
SetOption21 | Energy monitoring when power is off0 = disabled (default)1 = enabled |
SetOption24 | Set pressure units »6.4.00 = hPa (default)1 = mmHg |
SetOption26 | Use indexes even when only one relay is present0 = messages use POWER (default)1 = messages use POWER1 |
SetOption28 | RF received data format »6.1.00 = hex (default)1 = decimal |
SetOption29 | IR received data format »6.1.00 = hex (default)1 = decimal |
SetOption30 | Enforce Home Assistant auto-discovery as light »6.1.00 = 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. »6.2.0LedPower 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.1..100 to set button hold time (default = 40 ). This option also affects the time required to perform a firmware defaults reset (10x HOLD action time) |
SetOption33 | Max power limit can be exceeded by number of seconds before the relay is turned off1..250 = set number of seconds (default = 5 )
|
SetOption34 |
0..255 = set Backlog inter-command delay in milliseconds (default = 200 ) »6.6.0.17 |
SetOption36 | Boot loop defaults restoration control. »6.6.0.170 = disable boot loop control1..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:
|
SetOption37 | Color remapping for led channels, also provides an option for allowing independent handling of RGB and white channels. Setting changes require a device reboot. »6.5.00 = disabled1..119 = according to this table120..127 = invalid (results in same as 0 )128..255 = same as 0..127 but with independent channel handling enabled |
SetOption38 |
6..255 = set IRReceive protocol detection sensitivity minimizing UNKNOWN protocols »6.6.0 |
SetOption39 | Control handling of invalid power measurements. Read more... »6.6.00 = reset to default on next restart1..255 = number of invalid power readings before reporting no load (default =128 ). |
SetOption40 | Stop detecting input change on the button GPIO. Solves #5449 »6.6.0 Active only when SetOption1 1 and SetOption13 0 . This disables all long press functionality.0..250 = button hold time in 0.1 seconds after which button functionality is disabled.(default =1 ) Example: Backlog SetOption1 1; SetOption13 0; SetOption40 10 - discard any button press over 1 second |
SetOption42 |
0..255 = set over-temperature (Celsius only) threshold resulting in power off on all energy monitoring devices (default = 90 ) »6.6.0.1 |
SetOption43 |
Deprecated in favor of DimmerRange »6.6.0.180..255 = set maximum dimming value (details) (default = 100 )Available for Tuya (» v6.6.0.7) and PS_16_DZ (» v6.6.0.14) dimmers |
SetOption51 | Enable GPIO9 and GPIO10 component selections in Module Configuration »6.1.1.14 🚨 WARNING Do not use on ESP8266 devices! 🚨 0 = disable (default)1 = enable |
SetOption52 | Control display of optional time offset from UTC in JSON payloads »6.2.1.20 = disable (default)1 = enable |
SetOption53 | Display hostname and IP address in GUI »6.2.1.200 = disable (default)1 = enable |
SetOption54 | Apply SetOption20 settings to commands from Tuya device »6.3.0.40 = disable (default)1 = enable |
SetOption55 | mDNS service »6.4.1.40 = disable (default) 1 = enable |
SetOption56 | Wi-Fi network scan to select strongest signal on restart (network has to be visible) »6.3.0.100 = disable (default)1 = enable |
SetOption57 | Wi-Fi network re-scan every 44 minutes with alternate to +10dB stronger signal if detected (only visible networks) »6.3.0.100 = disable (default)1 = enable |
SetOption58 |
IR Raw data in JSON payload »6.3.0.110 = disable (default)1 = enable |
SetOption59 | Send tele/%topic%/STATE in addition to stat/%topic%/RESULT for commands: State , Power and any command causing a light to be turned on. »6.3.0.130 = disable (default)1 = enable |
SetOption60 | Enable normal sleep instead of dynamic sleep »6.3.0.150 = dynamic sleep (default)1 = sleep |
SetOption61 | Force local operation when ButtonTopic or SwitchTopic is set. »6.3.0.160 = disable (default)1 = enable |
SetOption62 | Set retain on Button or Switch hold messages »6.4.1.190 = disable (default)1 = don't use retain flag on HOLD messages |
SetOption63 | Set relay state feedback scan at restart (#5594, #5663) »6.5.0.90 = Scan relay power feedback state at restart (default)1 = Disable relay power feedback state scanning at restart |
SetOption64 | Switch between - or _ as sensor name separator »6.5.0.120 = sensor name index separator is - (hyphen) (default)1 = sensor name index separator is _ (underscore)Affects DS18X20, DHT, BMP and SHT3X sensor names in tele messages |
SetOption65 | Control fast power cycle detection device recovery »6.7.10 = detection is active (default)1 = detection is inactive
|
SetOption66 | Set publishing TuyaReceived to MQTT »6.7.00 = disable publishing TuyaReceived over MQTT (default)1 = enable publishing TuyaReceived over MQTT |
SetOption67 | iFan03 Buzzer control »6.6.0.20 = disable Sonoff iFan03 buzzer (default)1 = enable Sonoff iFan03 buzzer |
SetOption68 | Multi-channel PWM instead of a single light »6.6.0.30 = Treat PWM as a single light (default)1 = Treat PWM as separate channels. In this mode, use Power<x> to turn lights on and off, and Channel<x> to change the value of each channel.Color still works to set all channels at once.Requires restart after change |
SetOption69 |
Deprecated in favor of DimmerRange »6.6.0.18 By default Tuya dimmers won't dim below 10% because some don't function very well that way. »6.6.0.5 0 = disable Tuya dimmer 10% lower limit1 = enable Tuya dimmer 10% lower limit (default)
|
SetOption71 | Set DDS238 Modbus register for active energy »6.6.0.140 = set primary register (default)1 = set alternate register |
SetOption72 | Set reference used for total energy »6.6.0.150 = use firmware counter (default)1 = use energy monitor (e.g., PZEM-0xx, SDM120, SDM630, DDS238, DDSU666) hardware counter |
SetOption73 | Set HTTP Cross-Origin Resource Sharing (CORS) »7.0.0.10 = disable CORS (default)1 = enable CORS |
SetOption74 | Enable internal pullup for single DS18x20 sensor »7.0.0.10 = disabled (default)1 = internal pullup enabled |
SetOption75 | Set grouptopic behaviour (#6779) »7.0.0.10 = GroupTopic using FullTopic replacing %topic% (default)1 = GroupTopic is cmnd/%grouptopic%/
|
SetOption76 | Bootcount incrementing when DeepSleep is enabled (#6930) »7.0.0.40 = disable bootcount incrementing (default)1 = enable bootcount incrementing |
SetOption80 |
Blinds and shutters support »6.6.0.140 = disable blinds and shutters support (default)1 = enable blinds and shutters support |
SetOption81 | Set PCF8574 component behavior for all ports »6.6.0.140 = set as regular state (default)1 = set as inverted state |
Both hardware and software Serial Bridge are supported.
Hardware Serial Bridge uses GPIO1 (Tx)
and GPIO3 (Rx)
or GPIO13 (Tx)
and GPIO15 (Rx)
pins of your device.
Software Serial Bridge can use any other GPIO to be configured as components Serial Tx
and Serial Rx
(or SerBr Tx
and SerBr Rx
). If Tx
and Rx
components are not assigned in the Template or Module, GPIO1
and GPIO3
will be used. You must disable serial logging (SerialLog
0) when using Serial Bridge.
Information received by Tasmota over the serial bridge is captured automatically. Before data will be received, a properly formatted SerialSend<x>
or SSerialSend<x>
command must be executed. This must be done any time the device restarts (e.g., via a System#Boot
triggered rule). This command is required in order to set how the expected serial data will be formatted and interpreted (i.e., which <x> option). A {"SSerialReceived":{"Data":"<string>"}}
message will be posted. You can use a rule to process the string which will be contained in SSerialReceived#Data
.
Expect possible communication errors when additional sensors are configured.
Command | Parameters |
---|---|
Baudrate |
1 = set hardware serial bridge to default baud rate of 115200 bps<value> = set baud rate. The set rate will be a multiple of 300. The maximum baud rate possible is 19,660,500. |
SBaudrate |
1 = set software serial bridge to default baud rate of 9600 bps<value> = set baud rate. The set rate will be a multiple of 300. The maximum baud rate possible is 19,660,500. |
SerialDelimiter |
<value> = set serial delimiter to escape character code or ASCII character 1..127 = set serial delimiter to decimal ASCII128 = only allow ASCII characters 32 to 127 in response text129..255 = disable serial delimiter |
SerialSend<x> |
<string> Disable serial logging and send using hardware serial x = 1..5 1 = send appending \n (newline) ()2 = send3 = replace escape characters and send »6.5.04 = send as binary. Data in serial response messages is encoded as hex strings »6.2.05 = send as hex. Data in serial response messages is encoded as hex strings »6.3.0 |
SSerialSend<x> |
<string> Send using software serial protocol x = 1..5 1 = send appending \n (newline) ()2 = send3 = replace escape characters and send »6.5.04 = send as binary data. Data in serial response messages is encoded as hex strings5 = send as hex. Data in serial response messages is encoded as hex strings »6.5.0 |
TuyaSend<x> | Send data to MCU with TuyaMCU » v7.0.0.1 x = 1..4 TuyaSend1 <dpId>,<boolean> = send boolean (0 /1 ) data type to dpId (1 byte max length)TuyaSend2 <dpId>,<int> = send integer data to dpId (4 bytes max length)TuyaSend2 <dpId>,<0xAABBCCDD> = send 4 byte data to dpId (4 bytes max length)TuyaSend3 <dpId>,<value> = send any data type to dpId (unknown max length)TuyaSend4 <dpId>,<enum> = send enumerated (0 /1 /2 /3 /4 /5 ) data type to dpId (1 byte max length) |
» v6.6.0
The MP3 Player driver is based on the one from DFRobot. They named it DFPlayer mini. All MP3 Players with the identical Serial Control Command structure can be used.
Command | Parameters |
---|---|
MP3DAC |
0 = DAC on (default)1 = DAC off |
MP3Device | Specify playback device1 = USB2 = SD Card (default (also defaults on reset or power cycle))
|
MP3EQ | Set equalizer mode:0 = normal1 = pop2 = rock3 = jazz4 = classic5 = bass) |
MP3Pause | Pause |
MP3Play | Play, works as a normal play on a real MP3 Player, starts at first MP3 file |
MP3Reset | Reset the MP3 player to defaults |
MP3Stop | Stop |
MP3Track |
x = play track <x> |
MP3Volume |
0..100 = set Volume |
Command | Parameters |
---|---|
DomoticzIdx<x> | Show Domoticz Relay idx <x> (x = 1..4 )0 = disable use of Relay idx <x> (default)<value> = Show Relay idx <x> |
DomoticzKeyIdx<x> | Show Domoticz Key idx <x> (x = 1..4 )0 = disable use of Key idx <x> (default)<value> = Show Key idx <x> (to use enable ButtonTopic) |
DomoticzSensorIdx<x> | Show Domoticz Sensor idx <x> (x = 1..5 )0 = disable use of Sensor idx <x> (default)<value> = Show Sensor idx <x> |
DomoticzSwitchIdx<x> | Show Domoticz Switch idx <x> (x = 1..4 )0 = disable use of Switch idx <x> (default)<value> = Show Switch idx <x> (to use enable SwitchTopic) |
DomoticzUpdateTimer | Show current update timer value in seconds0 = disable sending interim Domoticz status (default)1..3600 = send status to Domoticz in defined intervals |
Command | Parameters |
---|---|
KnxTx_Cmnd<x> |
0 or 1 = send command using slot <x> set in KNX Menu at KNX_TX |
KnxTx_Val<x> |
<value> = send float value using slot <x> set in KNX Menu at KNX_TX |
KNX_ENABLED | Status of KNX Communications0 = set to Disable1 = set to Enable |
KNX_ENHANCED | Status of Enhanced mode for KNX Communications0 = set to Disable1 = set to Enable |
KNX_PA | KNX Physical Address0.0.0 = address not setx.x.x = set the device address (example 1.1.0 ) |
KNX_GA | Return the amount of Group Address to Send Data/Commands configured |
KNX_GA<x> | Setup Group Address to Send Data/Commands (<x> = KNX Group Address number)1 = return configuration of GA<x><option>, <area>, <line>, <member> to set configuration of GA<x><option> = see table below for OPTION list<area>, <line>, <member> = KNX Address to Send Data/Commands |
KNX_CB | Return the amount of Group Address to Receive Data/Commands configured |
KNX_CB<x> | Setup Group Address to Receive Data/Commands 1 = return configuration of CB<x><option>, <area>, <line>, <member> to set configuration of CB<x><option> = see table below for OPTION list<area>, <line>, <member> = KNX Address to Receive Data/Commands |
» v6.3.0
Command | Parameters |
---|---|
Display | Show current display setting as a JSON payload |
DisplayAddress |
0..255 Set display module address |
DisplayDimmer |
0 Turn the display off1..100 Turn the display on0..100 Set display luminosity (only on 8x8 Dot-Matrix displays)
|
DisplayMode |
0..5 Set to display predefined content according to display type |
DisplayModel | Set display model:1 = I2C LCD Display (default addresses 0x27 , 0x3F )2 = SSD1306 OLED 128x32/128x64 (default I2C addresses 0x3C , 0x3D )3 = HT16K33 8x8 Dot-Matrix4 = ILI9341 TFT LCD5 = 2.9 inch E-Paper Display 296x128 (software 3-wire SPI)6 = 4.2 inch E-Paper Display 400x300 (software 3-wire SPI)7 = SH1106 OLED 128x64 (default I2C address 0x3c )8 = ILI9488 TFT 480x320 (capacitive touch, hardware 3-wire SPI)9 = SSD1351 color OLED 128x128 (hardware 3-wire SPI)10 = RA8867 TFT LCD 1024x600 (capacitive touch, hardware 4-wire SPI) |
DisplayRefresh |
1..7 Set time in seconds to update predefined content when using DisplayMode ≠ 0
|
DisplaySize |
1..4 Set display scale-up size (SSD1306 and ILI9341 only)
|
DisplayRotate | Set rotation angle0 = 0°1 = 90°2 = 180°3 = 270° |
DisplayText |
<value> - See DisplayText use
|
DisplayCols |
1..44 Set number of display columns (for display modes>0)
|
DisplayRows |
1..32 Set number of display rows (for display modes>0)
|
DisplayFont | Specify the current font0 use classic GFX font1 = 122 = 243 = 8 (opt)7 use RA8876 internal font |
DisplayWidth | Specify the display width in pixels (SSD1306 only) »6.6.0.2 |
DisplayHeight | Specify the display height in pixels (SSD1306 only) »6.6.0.2 |
» v6.6.0.12
Command | Parameters |
---|---|
MotorMIS |
1,2,4,8,16 Set micro stepping increment - 1/1 (full steps) to 1/16 (default = 1 )
|
MotorSPR |
integer Set the number of steps the given motor needs for one revolution (default = 200 )This is dependent on the type of motor and micro stepping. Most common motors are 1.8° per step. |
MotorRPM |
1..300 Set revolutions per minute (default = 30 )
|
MotorMove |
integer Move the motor the given number of steps (positive values: clockwise, negative values: counterclockwise) |
MotorRotate |
integer Rotate the motor the given number of degrees (positive values: clockwise, negative values: counterclockwise) |
MotorTurn |
float Spin the motor the given number of turns (positive values: clockwise, negative values: counterclockwise) |
» v6.6.0.14
Command (x = 1..4 ) |
Parameters |
---|---|
ShutterCalibration<x> | Granular shutter position calibration. Real position in cm must be put in at 30 50 70 90 percent |
ShutterCloseDuration<x> |
1..255 (default = 10 )Define the time, in seconds, it takes to fully close the shutter. A fraction of a second can be specified (e.g. 45.7 ). |
ShutterClose<x> | Engage the relay to close the shutter. This action can be requested at any time. |
ShutterInvert<x> |
0 = use default shutter positioning1 = invert shutter positioning |
ShutterMotorDelay<x> |
0.00 .. 12.75 (default = 0 )Define the time, in seconds, that it takes the motor to start moving once power is turned on. |
ShutterOpenDuration<x> |
1..255 (default = 10 )time, in seconds, to fully open the shutter. Fraction of a second can be specified (e.g. 45.7 ). |
ShutterOpen<x> | Engage the relay to open the shutter. This action can be requested at any time. |
ShutterPosition<x> |
0..100 , UP , DOWN , STOP 0 = Closed, 100 = OpenIf the shutter is inverted (e.g., if used with KNX), 100 = Closed, 0 = OpenA shutter position change can be requested at any time. The shutter will stop and revert or update to the requested position. The shutter's actual position will be saved after the movement is completed. In this case, the position will be restored during reboot. An interruption during shutter movement (e.g., a device restart) will lose the current position. |
ShutterRelay<x> |
<value> 0 = disable this and all higher numbered shutters1,3,5,7,... (must be an odd number) = define the Relay<value> component used to open the shutter. This relay's mate, the next higher numbered relay, closes the shutter. Depending on the shutter mode, the relays may need to be interlocked using the Interlock command.The ShutterRelay command must be executed first before any other shutter commands for Shutter<x> can be executed.
|
ShutterSetClose<x> | Set the shutter closed position. ShutterPosition will be reset to fully closed value (e.g., 0 when ShutterInvert = 0 , 100 otherwise). |
ShutterSetHalfway<x> |
0..100 (default = 50 )Define shutter half open position (in percent) |
ShutterStop<x> | Disengage the relays to stop the shutter |
See also |
SetOption80 - Enable shutter support |
» v7.0.0.3
Command | Parameters |
---|---|
ZigbeePermitJoin | Sets new device pairing mode0 = disable pairing1 = enable pairing for 60 seconds99 = enable pairing until device reboot |
ZigbeeProbe | Probe a Zigbee device to get additional information including its IEEEaddress, vendor and model names, endpoints, and supported clusters per endpoint.<shortaddr> (e.g., 0x1234 )A device probe is performed automatically when a new Zigbee device connects. A probe may be needed after a Tasmota reboot. Battery powered Zigbee devices can generally not be probed because they are in sleep mode most of the time. |
ZigbeeRead | Read Zigbee device attributes{ "Device":"<shortaddr>", "Endpoint":"<endpoint>", "Cluster":"<cluster>", "Read":[<attrlist>] } <shortaddr> the short address of the Zigbee device on the network.<endpoint> the target endpoint on the device (identifying endpoints)<cluster> the cluster number of the attributes<attrlist> requested attributes arrayEx: ZigbeeRead { "device":"0x69CF", "endpoint":"0x03", "cluster":"0x0006", "read":["0x0000"] }
|
ZigbeeReset |
1 = perform a factory reset and reconfiguration of the CC2530 chip.You will need to re-pair all Zigbee devices |
ZigbeeSend |
{ "Device":"<shortaddr>", "Endpoint":"<endpoint>", "Send":{"<sendcmd>":<sendparam>} } <shortaddr> the short address of the Zigbee device on the network.<endpoint> the target endpoint on the device (identifying endpoints)"<sendcmd>":<sendparam> the command and parameters to send (Zigbee Device Commands)Note: Use ZigbeeZCLSend to send a raw form low-level messageEx: ZigbeeSend { "Device":"0x1234", "Endpoint":"0x03", "Send":{"Power":"on"} }
|
ZigbeeStatus<x> | Display Zigbee devices seen on the network since boot<device> (optional) = device number (enumerated beginning with 1) = all devicesThis command provides three levels of increasing detail according to <x> ZigbeeStatus1 Display Short Address, and Friendly NameZigbeeStatus2 Also include Manufacturer ID and Model IDZigbeeStatus3 Also include a list of endpoints and the clusterIds supported by each endpointEx: ZigbeeStatus3 1 requests all details for device number 1The information requested may exceed the maximum result size allowed by Tasmota. In this case, the output will be truncated. To get all of the desired information, request results for a specific device individually. |
ZigbeeZCLSend | Send a raw ZCL message to a Zigbee device. This is a low-level command, and requires to manually build the ZCL parameters. Most common usage will be provided as high-level functions. |