• How to Use Commands
• Device Control
• Management and Configuration
• Wi-Fi
• MQTT
• Rules
• Timers
• Sensors
• Power Monitoring
• Lights (PWM and addressable RGB LED lights)
• RF 433MHz Bridge
• IR Remote Control
• SetOption List
• Serial Bridge
• MP3 Player
• Domoticz
• KNX IP Protocol
• Displays

The Sonoff-Tasmota firmware 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>. 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://sonoff/cm?cmnd=Power%20TOGGLE
http://sonoff/cm?cmnd=Power%20On
http://sonoff/cm?cmnd=Power%20off
http://sonoff/cm?user=admin&password=joker&cmnd=Power%20Toggle

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://sonoff/cm?&user=put_username_here&password=put_password_here&cmnd=Power%20On

Console menu in 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, 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 the following:

• Sonoff Dual and the Sonoff RF Bridge where it is set to 19200 bps.
• Sonoff S31 where it is set to 4800 bps and the SerialLog is disabled.

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://sonoff/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.

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

To control a device locally 16 timers are programmable. They can be configured with the Timer<x> command following by a JSON string with optional parameters. For example:

Timer 1 will ENABLE output of POWER1 at exactly 2:23 every Tue/Wed and Sat

Timer1 {"Arm":1,"Time":"02:23","Window":0,"Days":"--TW--S","Repeat":1,"Output":1,"Action":1}

Timer 4 will TOGGLE output of POWER2 within a 30 minute window centered around 16:23 each Sunday, Monday, Thursday and Friday and will disable (disarm) after executing.

Timer4 {"Arm":1,"Time":"16:23","Window":15,"Days":"SM00TF0","Repeat":0,"Output":2,"Action":2}

When Mode 1 or Mode 2 is used, Latitude and Longitude become available. In that case the Time value is always used as an offset so make sure to set it to 00:00 if no offset is wanted.

Timer1 {"Arm":1,"Mode":2,"Time":"-2:23","Window":0,"Days":"11TW11S","Repeat":1,"Output":1,"Action":1}

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

See Linux Infrared Remote Control (LIRC) for more information.

Both Hardware and Software Serial Bridge are supported.

Hardware Serial Bridge uses GPIO1 (Tx) and GPIO3 (Rx) pins of your device. Software Serial Bridge can use any other GPIO to be selected with command GPIO<x> 67, GPIO<x> 68 or in Module options by setting GPIOs to SerBr Tx and SerBr Rx. Expect possible communication errors when additional sensors are configured.

The MP3 Player driver is based on the one from DF Robot. They named it DFPlayer mini. All MP3 Players with the identical Serial Control Command structure can be used.

The display driver is able to display predefined setups of text or user defined text. To display text using DisplayText set DisplayMode to 0 (also 1 for DisplayModel 3 (Dot-Matrix)).