Commands - RTurala/Sonoff-Tasmota GitHub Wiki

The Sonoff-Tasmota firmware provides three powerful man machine interfaces: MQTT, web and serial.

MQTT is the recommended interaction interface. You can find all relevant details regarding MQTT in the MQTT Essentials article series. You'll need an MQTT broker in place and should utilize an independent MQTT client for troubleshooting. Setting up the basic MQTT environment is out of the scope of this article.

Please check the specific MQTT Features wiki page to learn more.

Example:

A Sonoff-Tasmota module was configured with the FullTopic tasmota/%topic%/%prefix%/ and the topic setting "sonoff-mylight". We want to switch the light On and Off.

By looking at the commands table below we can learn about the Power command and the TOGGLE option. "Power1" represents the first relay.

• Status query:

  tasmota/sonoff-mylight/cmnd/Power1 ←      //empty message
     ↳ tasmota/sonoff-mylight/stat/RESULT → {"POWER1":"OFF"}
     ↳ tasmota/sonoff-mylight/stat/POWER1 → OFF

  We can see, that the module's first relay is currently turned off.

• Sending a command:

  tasmota/sonoff-mylight/cmnd/Power1 ← "TOGGLE"
     ↳ // Power for relay 1 is toggled
     ↳ tasmota/sonoff-mylight/stat/RESULT → {"POWER1":"ON"}
     ↳ tasmota/sonoff-mylight/stat/POWER1 → ON

  We've send the toggle command and received the new state confirmation.

Side Note: For many commands, an empty payload is a query. If you are using mosquitto_pub, you can issue an empty payload using the -n command line option. If your MQTT client cannot issue an empty payload, you can use the single character "?" instead.

Commands can be executed via 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

The serial interface is set to 115200 bps except for Sonoff Dual and the Sonoff RF Bridge where it is set to 19200 bps.

Starting with version 5.3.0 a backlog feature is available allowing to execute several commands in sequence (chaining). Maximum commands per request:

• Versions < 5.12.0i = 16/request
• Versions >= 5.12.0i = 30/request

Examples of this command are:

Backlog status 1; power 2; delay 20; power 2; status 4
Backlog ssid1 myssid; password1 mypassword
http://sonoff/cm?user=admin&password=joker&cmnd=Backlog%20Power%20Toggle;Power1%20off

The following command tables are available:

• Main
• Sensor
• Timers
• Management
• Wifi
• MQTT
• Serial Bridge
• SetOption Overview
• Logging
• Sonoff Pow, Sonoff S31, Shelly2 and Pzem004T specific
• WS2812, AiLight, Sonoff Led, B1, BN-SZ01, H801 and MagicHome
• WS2812 led string specific
• Sonoff RF Bridge 433
• Domoticz
• IR remote control
• MP3 Player

To control a device locally 16 Timers are available. They can be configured with the Timer<x> command following by a JSON string with optional parameters. Full command examples are:

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

When define USE_SUNRISE is enabled commands Latitude and Longitude together with parameter mode 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}

Each parameter will be documented below.

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 GPIOxx 67, GPIOxx 68 or Web Module Configuration options SerBr Tx and SerBr Rx.

Expect possible communication errors when additional sensors are configured.

Note: Beside results initiated by a command (synchronious) you can get asynchronious results initiated by rule trigger, telemetry event, and other changed device related values. See https://github.com/arendst/Sonoff-Tasmota/wiki/Sonoff-Pow-and-Pow-R2#push-result-using-telemetry for further descriptions.

MagicHome is also sold as Arilux.

With EFM8BB1 RF chip firmware update support (released 20180604) the following commands become useful when the firmware has been updated by the provided Portisch firmware in folder tools/fw_efm8bb1.

Posible values for the parameter OPTION:

Using IRsend as documented below it is possible to send the same IR code in decimal or hexadecimal notation using the 0x prefix:

IRsend {"Protocol":"NEC","Bits":32,"Data":2170978686}
IRsend {"Protocol":"NEC","Bits":32,"Data":0x8166817E}
IRsend 0,926,844,958,832,1798,868,902,848,900,870,900,852,908,918,958,794,934,874,928,1738,934,856,1764

See http://www.lirc.org/ for more info.

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.