• 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 and Power 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 issue Power off command and before you receive stat/%topic%/RESULT = {"POWER":"OFF"} message.

» v5.13.1

Note: Information on sensors documented below is transmitted in the Tasmota telemetry message

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.

» 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.

» v6.3.0

» v6.6.0.12

» v6.6.0.14

» v7.0.0.3