Commands

Commands can be issued using MQTT, web requests, webUI console and serial

How to use~

Every command used without a parameter (payload) returns the current setting.

Power returns the status of first defined power output (usually Relay1)"

Instead of 0 you can use off or false and instead of 1 you can use on or true.

Power ON turns first defined power output (usually Relay1) on

Power1 1 also turns first defined power output (usually Relay1) on

Power1 True also turns first defined power output (usually 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 first defined power output (usually 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.

with MQTT~

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 article to find out more.

with Web Requests~

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

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=<username>&password=<password>&cmnd=Power%20On

in Console in the Web UI~

Console menu in the web UI is a convenient place to send commands and it behaves similar to a terminal connection via serial bridge.

over 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 Power of Backlog~

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 power control, using backlog like a script

Backlog Status 1; Power2 on; Delay 20; Power2 off; Status 4

When using web requests (Don't forget 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.

Commands List~

Control~

Management~

Wi-Fi~

MQTT~

Rules~

Timers~

Sensors~

Power Monitoring~

Light~

Device Groups~

SetOptions~

Command	Parameters
SetOption0	Save power state and use after restart (=SaveState) 0 = disable 1 = enable (default)
SetOption1	Set button multipress mode to 0 = allow all button actions (default) 1 = restrict to single to penta press and hold actions (i.e., disable inadvertent reset due to long press)
SetOption3	MQTT 0 = disable MQTT 1 = enable MQTT (default)
SetOption4	Return MQTT response as 0 = RESULT topic (default) 1 = %COMMAND% topic
SetOption8	Show temperature in 0= 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 functionality 0 = disabled (default) 1 = enabled
SetOption12	Configuration saving to flash option 0 = allow dynamic flash save slot rotation (default) 1 = use fixed eeprom flash slot
SetOption13	Allow immediate action on single button press 0 = 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 lights 0 = basic PWM control 1 = control with Color or Dimmer commands (default)
SetOption16	Set addressable LED Clock scheme parameter 0 = clock-wise mode (default) 1 = counter-clock-wise mode
SetOption17	Show Color string as 0 = hex string (default) 1 = comma-separated decimal string
SetOption18	Set status of signal light paired with CO2 sensor 0 = disable light (default) 1 = enable light The light will be green below CO2_LOW and red above CO2_HIGH (transition yellow/orange between). The default levels are: 800ppm for low and 1200ppm for high but these can be set in user_config_override.h.
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 on 0 = disabled (default) 1 = enabled
SetOption21	Energy monitoring when power is off 0 = disabled (default) 1 = enabled
SetOption24	Set pressure units 0 = hPa (default) 1 = mmHg
SetOption26	Use indexes even when only one relay is present 0 = messages use POWER (default) 1 = messages use POWER1
SetOption28	RF received data format 0 = hex (default) 1 = decimal
SetOption29	IR received data format 0 = hex (default) 1 = decimal
SetOption30	Enforce Home Assistant auto-discovery as light 0 = relays are announced as a switch and PWM as a light (default) 1 = both relays and PWM are announced as light
SetOption31	Set status LED blinking during Wi-Fi and MQTT connection problems. LedPower must be set to 0 for this feature to work 0 = Enabled (default) 1 = 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	Number of seconds for which the maximum power limit can be exceeded before the power is turned off 1..250 = set number of seconds (default = 5)
SetOption34	0..255 = set Backlog inter-command delay in milliseconds (default = 200)
SetOption36	Boot loop defaults restoration control. 0 = disable boot loop control 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: 1st restart: disable ESP8285 generic GPIOs interfering with flash SPI 2nd restart: disable rules causing boot loop 3rd restart: disable all rules 4th restart: reset user defined GPIOs to disable any attached peripherals 5th restart: reset module to Sonoff Basic (1)
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. 0 = disabled 1..119 = according to this table 120..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
SetOption39	Control handling of invalid power measurements. Read more... 0 = reset to default on next restart 1..255 = number of invalid power readings before reporting no load (default =128).
SetOption40	Stop detecting input change on the button GPIO. Solves #5449 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
SetOption41	0 = Disable ARP (default) <x> = Force sending gratuitous ARP (Wi-Fi keep alive) every <x> seconds (default = 0) If <x> is below 100 it is the number of seconds, if <x> is above 100, it is the number of minutes after substracting 100. Ex: 105 is every 5 minutes, while 90 is every 90 seconds.
SetOption42	0..255 = set over-temperature (Celsius only) threshold resulting in power off on all energy monitoring devices (default = 90)
SetOption43	Deprecated in favor of DimmerRange 0..255 = set maximum dimming value (details) (default = 100) Available for Tuya and PS_16_DZ dimmers
SetOption51	Enable GPIO9 and GPIO10 component selections in Module Configuration WARNING Do not use on ESP8266 devices! 0 = disable (default) 1 = enable
SetOption52	Control display of optional time offset from UTC in JSON payloads 0 = disable (default) 1 = enable
SetOption53	Display hostname and IP address in GUI 0 = disable (default) 1 = enable
SetOption54	Apply SetOption20 settings to commands from Tuya device 0 = disable (default) 1 = enable
SetOption55	mDNS service 0 = disable (default) 1 = enable
SetOption56	Wi-Fi network scan to select strongest signal on restart (network has to be visible) 0 = disable (default) 1 = enable
SetOption57	Wi-Fi network re-scan every 44 minutes with alternate to +10dB stronger signal if detected (only visible networks) 0 = disable (default) 1 = enable
SetOption58	IR Raw data in JSON payload 0 = 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. 0 = disable (default) 1 = enable
SetOption60	Set sleep mode 0 = dynamic sleep (default) 1 = normal sleep
SetOption61	Force local operation when ButtonTopic or SwitchTopic is set. 0 = disable (default) 1 = enable
SetOption62	Set retain on Button or Switch hold messages 0 = disable (default) 1 = don't use retain flag on HOLD messages
SetOption63	Set relay state feedback scan at restart (#5594, #5663) 0 = Scan power state at restart (default) 1 = Disable power state scanning at restart
SetOption64	Switch between - or _ as sensor name separator 0 = 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	Device recovery using fast power cycle detection 0 = enabled (default) 1 = disabled
SetOption66	Set publishing TuyaReceived to MQTT 0 = disable publishing TuyaReceived over MQTT (default) 1 = enable publishing TuyaReceived over MQTT
SetOption67	iFan03 Buzzer control 0 = disable Sonoff iFan03 buzzer (default) 1 = enable Sonoff iFan03 buzzer
SetOption68	Multi-channel PWM instead of a single light 0 = 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 By default Tuya dimmers won't dim below 10% because some don't function very well that way. 0 = disable Tuya dimmer 10% lower limit 1 = enable Tuya dimmer 10% lower limit (default)
SetOption71	Set DDS238 Modbus register for active energy 0 = set primary register (default) 1 = set alternate register
SetOption72	Set reference used for total energy 0 = use firmware counter (default) 1 = use energy monitor (e.g., PZEM-0xx, SDM120, SDM630, DDS238, DDSU666) hardware counter
SetOption73	Enable Buttons decoupling and send multi-press and hold MQTT messages 0 = disable decoupling (default) 1 = enable decoupling
SetOption74	Enable internal pullup for single DS18x20 sensor 0 = disabled (default) 1 = internal pullup enabled
SetOption75	Set grouptopic behaviour (#6779) 0 = GroupTopic using FullTopic replacing %topic% (default) 1 = GroupTopic is cmnd/%grouptopic%/
SetOption76	Bootcount incrementing when DeepSleep is enabled (#6930) 0 = disable bootcount incrementing (default) 1 = enable bootcount incrementing
SetOption77	Do not power off if a slider is moved to far left 0 = disabled (default) 1 = enabled
SetOption78	Version check on Tasmota upgrade 0 = enabled (default) 1 = disabled
SetOption79	Reset counters at TelePeriod time 0 = disabled (default) 1 = enabled
SetOption80	Blinds and shutters support 0 = disable blinds and shutters support (default) 1 = enable blinds and shutters support
SetOption81	Set PCF8574 component behavior for all ports 0 = set as regular state (default) 1 = set as inverted state
SetOption82	Reduce the CT range from 153..500 to 200.380 to accomodate with Alexa range 0 = CT ranges from 153 to 500 (default) 1 = CT ranges from 200 to 380 (although you can still set in from 153 to 500)
SetOption83	Uses Zigbee device friendly name instead of 16 bits short addresses as JSON key when reporting values and commands 0 = JSON key as short address 1 = JSON key as friendly name See ZbName <device>,<name>
SetOption84	(Experimental) When using AWS IoT, sends a device shadow update (alternative to retained) 0 = don't update device shadow (default) 1 = update device shadow Note: if the Topic contains '/' they are replaced with '_'
SetOption85	Device group support 0 = disabled (default) 1 = enabled
SetOption86	PWM Dimmer only! Turn brightness LED's off 5 seconds after last change 0 = disabled (default) 1 = enabled
SetOption87	PWM Dimmer only! Turn red LED on when powered off 0 = disabled (default) 1 = enabled
SetOption88	PWM Dimmer only! Buttons control remote devices 0 = disabled (default) 1 = enabled
SetOption89	Configure MQTT topic for Zigbee devices (also see SensorRetain) 0 = single tele/%topic%/SENSOR topic (default) 1 = unique device topic based on Zigbee device ShortAddr Example: tele/Zigbee/5ADF/SENSOR = {"ZbReceived":{"0x5ADF":{"Dimmer":254,"Endpoint":1,"LinkQuality":70}}}
SetOption90	Disable sending MQTT with non-JSON messages 0 = send all MQTT (default) 1 = send only MQTT messages with JSON payloads
SetOption91	Enable Fade at boot and power on. By default fading is not enabled at boot because of stuttering caused by wi-fi connection 0 = don't Fade at startup (default) 1 = Fade at startup
SetOption92	Alternative to Module 38: for Cold/Warm white bulbs, enable the second PWM as CT (Color Temp) instead of Warm White, as required for Philips-Xiaomi bulbs. 0 = normal Cold/Warm PWM (default) 1 = Brightness/CT PWM See PWM CT in Lights
SetOption93	Control caching of compressed rules 0 = Disable memory caching of uncompressed rules 1 = Keep uncompressed rules in memory to avoid CPU load of uncompressing at each tick (default)

Serial Bridge~

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. Note that changing serial logging (SerialLog 0) will disable the hardware 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.

RF Bridge~

IR Remote~

Displays~

Shutters~

Zigbee~

See Zigbee article for more information

Command	Parameters
<device>	As <device> in following commands you can use interchangeably: <shortaddr> = short address of the Zigbee device on the network, example: 0x1234 <longaddr> = permanent IEEE address of the Zigbee device (64 bits), example: 0x00158D00041160C5 <index> = number of the device in the internal list (starts at 1), ideal for enumerating devices, example: 3 for third device in the list <name> = friendly name. Only when previously set with ZbName
ZbBind	Binds one Zigbee device to another device or to a group. This allows one device to directly send commands (f.e. a remote to a bulb) without any action on the coordinator. Command structure: {"Device":"<device>", "Endpoint":<endpoint>, "Cluster":<cluster>, "ToDevice":"<to_device>", "ToEndpoint":<to_endpoint>, "ToGroup":<to_group> } <device> = device sending messages (mandatory) <endpoint> = source endpoint (mandatory) <cluster> = source cluster id (mandatory) <to_device> = target device (optional) <to_endpoint> = target endpoint  (optional if it can be inferred from ZbStatus3) <to_group> = target group id (optional) You must specify either "ToDevice" or "ToGroup" but not both Zigbee2Tasmota must know the IEEE address of target device, see ZbStatus2 to verify and ZbProbe to have Zigbee2Tasmota query the address
ZbConfig	display the current Zigbee configuration Example or result: {"ZbConfig":{"Channel":11,"PanID":"0x1A63","ExtPanID":"0xCCCCCCCCCCCCCCCC","KeyL":"0x0F0D0B0907050301","KeyH":"0x0D0C0A0806040200"}}
ZbConfig <json>	change the configuration and restart if any change was applied. Warning: change in configuration causes a reset of the CC2530 and requires devices to be re-paired. "Channel":<channel>: Zigbee radio channel (11-26) "PanID":<panid>: identifier of the Zigbee Network "ExtPanID":<extpanid>: unique identifier of the Zigbee Network (ExtPanID features are not supported in Z2T but this parameter needs to be set) "KeyL":<key_l>,"KeyH":<key_h>: 128 bits encryption key, split into 2 64 bits values (Low and High) All parameters are optional and only the ones specified are changed. The command always displays the complete configuration after the change Example of command: ZbConfig {"Channel":22,"PanID":"0x1A69","ExtPanID":"0xDDCCCCCCCCCCCCCC","KeyL":"0xFF0D0B0907050301","KeyH":"0xED0C0A0806040200"}
ZbForget	Used for devices that are unused but still visible in ZbStatus <device> = Remove a device from the Tasmota flash memory.
ZbLight	Sets or reads the light type to be emulated in Zigbee Hue Emulation with Alexa. <device>,<light_type> sets the light type using an integer 0..5 corresponding to the number of channels (from one channel (on/off) to 5 channel (RGBCCT) lights) <device>,-1 removes the device from Philips Hue emulation <device> displays the current status of the Light (Zigbee2Tasmota tracks all changes to the light)
ZbName	Sets or reads the Zigbee device friendly name (up to 32 characters). <device>,<name> sets the new friendly name <device>, (empty name) clears the friendly name <device> displays the current friendly name Also see SetOption83 1 to enable friendly names as JSON keys instead of ShortAddr.
ZbPermitJoin	Sets pairing mode for new device discovery 0 = disable pairing mode 1 = enable pairing mode for 60 seconds 99 = enable pairing until device reboots Leaving Zigbee network open to join will allow any Zigbee device to connect and retrieve your network encryption key. This can lead to a compromise of your Zigbee network.
ZbPing	<device> = test availability of Zigbee device. If the device is connected and not sleeping, you should receive a ZbPing message within the next second. Example: ZbPing 0x5ADF responds with: {"ZbPing":{"Device":"0x5ADF","IEEEAddr":"0x90FD9FFFFE03B051"}}
ZbSend	Command structure: {"Device":"<shortaddr>", "Endpoint":"<endpoint>", "Manuf":<manuf>, "Send":{"<sendcmd>":<sendparam>}} <shortaddr> = short address of the Zigbee device on the network <endpoint> = target endpoint on the device (understandig endpoints) <manuf> (optional) forces a specific ManufacturerId in the ZCL frame (required by some Xiaomi devices) "<sendcmd>":<sendparam> = command and parameters to send (Zigbee Device Commands) Use ZbZNPSend to send a raw form low-level message Example: ZigbeeSend { "Device":"0x1234", "Endpoint":"0x03", "Send":{"Power":"on"} }
ZbStatus<x>	Display Zigbee devices seen on the network since boot <device> (optional) = all devices This command provides three levels of increasing detail according to <x> ZbStatus1 Display Short Address, and Friendly Name ZbStatus2 Also include Manufacturer ID and Model ID ZbStatus3 Also include a list of endpoints and the clusterIds supported by each endpoint Example: ZbStatus3 1 requests all details for device number 1 Requested information may exceed 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.
ZbUnbind	Unbinds one Zigbee device from another or from a group. {"Device":"<device>", "Endpoint":<endpoint>, "Cluster":<cluster>, "ToDevice":"<to_device>", "ToEndpoint":<to_endpoint>, "ToGroup":<to_group> } <device> = the device sending the messages (mandatory) <endpoint> = the source endpoint (mandatory) <cluster> = the source cluster id (mandatory) <to_device> = the target device (optional) <to_endpoint> = the target endpoint (optional if it can be inferred from ZbStatus3) <to_group> = the target group id (optional) You must specify either "ToDevice" or "ToGroup" but not both Zigbee2Tasmota must know the IEEE address of the target device, use ZbStatus2 to verify and ZbProbe to query the address.

Zigbee Debug Functions

Do not use unless you know exactly what you are doing.

Command	Parameters
ZbModelId	Manually force the ModelId field of a Zigbee device. This is used to simulate devicesnot physically present on the network, for debugging only. <device>,<modelid> = set new ModelId <device>, = (empty modelid) clear ModelId <device> = display current ModelId (also displayed in ZbStatus2)
ZbProbe	<device>= probe a Zigbee device to get additional information including its IEEEaddress, vendor and model names, endpoints, and supported clusters per endpoint. Device probe is performed automatically when a new Zigbee device connects. Battery powered Zigbee devices can not be probed in general because they are usually in sleep mode.
ZbRead	Read Zigbee device attributes using command syntax: { "Device":"<shortaddr>", "Endpoint":"<endpoint>", "Cluster":"<cluster>", "Manuf":<manuf>, "Read":[<attrlist>] } <shortaddr> = short address of the Zigbee device on the network. <endpoint> = target endpoint on the device (understanding endpoints) <cluster> = cluster number of the attributes <manuf> = forces a specific ManufacturerId in the ZCL frame (required by some Xiaomi devices) (optional) <attrlist> = requested attributes array Example: ZbRead { "device":"0x69CF", "endpoint":"0x03", "cluster":"0x0006", "read":["0x0000"] }
ZbReset	1 = perform a factory reset and reconfiguration of the CC2530 chip. You will need to re-pair all Zigbee devices
ZbRestore	Restores a device configuration previously dumped with ZbStatus2. This command does not pair a device, but lets you get back device configuration like ModelId or IEEEAddress. <json> = json contains the fields dumped with ZbStatus2. <json> can contain multiple devices (if they fit).
ZbSave	Forces saving the Zigbee device information to Flash. Auto-saving happens 10 seconds after a new Device parameter was changed, this command is normally not useful
ZbZNPSend	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.
ZbZNPReceive	Simulates a received message <hex> = hex string of the simulated message, same format as ZbZNPReceived debug logs

Bluetooth~

Stepper Motors~

MP3 Player~

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.

Thermostat~

Domoticz~

KNX~