Files
OpenBK7231T_App/docs/commands.md
Tom cb39120560 Documentation Update (#843)
* Fixed one typo in the battery commands, also added description for Map command.

* Generated the doc files to see if my changes worked.

* Sorted commands array to make it easier to find command information

* Fixed some command descriptions. Sorted commands in docs list.

* Fixed command sorting to be case-insensitive

* Removed extra comments on SendPost added by docs script.
2023-06-02 15:05:46 +02:00

33 KiB

Commands

Here is the latest, up to date command list. This file was autogenerated by running 'node scripts/getcommands.js' in the repository. All descriptions were taken from code.

Please remember that some commands might require starting a related driver first, so, for example, you must first do 'startDriver DoorSensor' and then 'DSEdge 1'. Also remember that commands can be put in autoexec.bat to run at startup (see Web Application->LittleFS tab).

Do not add anything here, as it will overwritten with next rebuild.

Command Arguments Description
AB_Map [int] Sets margines for ADC button codes. For given N margins, there are N+1 possible ADC button values (one should be reserved for 'no button')
AddChangeHandler [Variable][Relation][Constant][Command] This can listen to change in channel value (for example channel 0 becoming 100), or for a voltage/current/power change for BL0942/BL0937. This supports multiple relations, like ==, !=, >=, < etc. The Variable name for channel is Channel0, Channel2, etc, for BL0XXX it can be 'Power', or 'Current' or 'Voltage'
AddChannel [ChannelIndex][ValueToAdd][ClampMin][ClampMax][bWrapInsteadOfClamp] Adds a given value to the channel. Can be used to change PWM brightness. Clamp min and max arguments are optional.
addClockEvent [Time] [WeekDayFlags] [UniqueIDForRemoval][Command] Schedule command to run on given time in given day of week. NTP must be running. Time is a time like HH:mm or HH:mm:ss, WeekDayFlag is a bitflag on which day to run, 0xff mean all days, 0x01 means sunday, 0x02 monday, 0x03 sunday and monday, etc, id is an unique id so event can be removede later
AddEventHandler [EventName][EventArgument][CommandToRun] This can be used to trigger an action on a button click, long press, etc
addI2CDevice_LCD_PCF8574 Adds a new I2C device - PCF8574
addI2CDevice_LCM1602 Adds a new I2C device - LCM1602
addI2CDevice_MCP23017 Adds a new I2C device - MCP23017
addI2CDevice_TC74 Adds a new I2C device - TC74
addRepeatingEvent [IntervalSeconds][RepeatsOr-1][CommandToRun] Starts a timer/interval command. Use 'backlog' to fit multiple commands in a single string.
addRepeatingEventID [IntervalSeconds][RepeatsOr-1][UserID][CommandToRun] as addRepeatingEvent, but with a given ID. You can later cancel it with cancelRepeatingEvent.
e.g.:addRepeatingEventID 2 -1 123 Power0 Toggle
add_dimmer [Value][AddMode] Adds a given value to current LED dimmer. AddMode 0 just adds a value (with a clamp to [0,100]), AddMode 1 will wrap around values (going under 0 goes to 100, going over 100 goes to 0), AddMode 2 will ping-pong value (going to 100 starts going back from 100 to 0, and again, going to 0 starts going up).
add_temperature [DeltaValue][bWrapAroundInsteadOfHold] Adds a given value to current LED temperature. Function can wrap or clamp if max/min is exceeded.
alias [Alias][Command with spaces] add an aliased command, so a command with spaces can be called with a short, nospaced alias
aliasMem Internal usage only. See docs for 'alias' command.
backlog [string of commands separated with ;] run a sequence of ; separated commands
Battery_cycle [int] change cycle of measurement by default every 10 seconds
e.g.:Battery_cycle 60
Battery_Setup [minbatt][maxbatt][V_divider][Vref][AD Bits] measure battery based on ADC.
req. args: minbatt in mv, maxbatt in mv.
optional: V_divider(2), Vref(default 2400), ADC bits(4096)
e.g.:Battery_Setup 1500 3000 2 2400 4096
BP1658CJ_Current [MaxCurrentRGB][MaxCurrentCW] Sets the maximum current limit for BP1658CJ driver.
BP1658CJ_Map [Ch0][Ch1][Ch2][Ch3][Ch4] Maps the RGBCW values to given indices of BP1658CJ channels. This is because BP5758D channels order is not the same for some devices. Some devices are using RGBCW order and some are using GBRCW, etc, etc. Example usage: BP1658CJ_Map 0 1 2 3 4
BP1658CJ_RGBCW [HexColor] Don't use it. It's for direct access of BP1658CJ driver. You don't need it because LED driver automatically calls it, so just use led_basecolor_rgb
BP5758D_Current [MaxCurrentRGB][MaxCurrentCW] Sets the maximum current limit for BP5758D driver, first value is for rgb and second for cw
BP5758D_Map [Ch0][Ch1][Ch2][Ch3][Ch4] Maps the RGBCW values to given indices of BP5758D channels. This is because BP5758D channels order is not the same for some devices. Some devices are using RGBCW order and some are using GBRCW, etc, etc. Example usage: BP5758D_Map 0 1 2 3 4
BP5758D_RGBCW [HexColor] Don't use it. It's for direct access of BP5758D driver. You don't need it because LED driver automatically calls it, so just use led_basecolor_rgb
BridgePulseLength [FloatValue] Setup value for bridge pulse len
cancelRepeatingEvent [UserIDInteger] Stops a given repeating event with a specified ID
Ch [InputValue] An alternate command to access channels. It returns all used channels in JSON format. The syntax is ChINDEX value, there is no space between Ch and channel index. It can be sent without value to poll channel values.
CHT_Calibrate Calibrate the CHT Sensor as Tolerance is +/-2 degrees C.
e.g.:SHT_Calibrate -4 10
CHT_Cycle [int] This is the interval between measurements in seconds, by default 1. Max is 255.
e.g.:CHT_Cycle 60
ClampChannel [ChannelIndex][Min][Max] Clamps given channel value to a range.
clearAll Clears config and all remaining features, like runtime scripts, events, etc
clearAllHandlers This clears all added event handlers
clearClockEvents Removes all set clock events
clearConfig Clears all config, including WiFi data
clearIO Clears all pins setting, channels settings
ClearNoPingTime Command for ping watchdog; it sets the 'time since last ping reply' to 0 again
clearRepeatingEvents Clears all repeating events.
Color [HexValue] Puts the LED driver in RGB mode and sets given color.
ConsumptionThreshold [FloatValue] Setup value for automatic save of consumption data [1..100]
crashNull Causes a crash
CT [TempValue] Same as led_temperature
CTRange [MinRange][MaxRange] This sets the temperature range for display. Default is 154-500.
CurrentSet Current Measure the real Current with an external, reliable power meter and enter this Current via this command to calibrate. The calibration is automatically saved in the flash memory.
DeepSleep [Seconds] Starts deep sleep for given amount of seconds. Please remember that there is also a separate command, called PinDeepSleep, which is not using a timer, but a GPIO to wake up device.
delay_ms [ValueMS] Script-only command. Pauses current script thread for given amount of ms.
delay_s [ValueSeconds] Script-only command. Pauses current script thread for given amount of seconds.
DGR_SendBrightness [GroupName][Brightness] Sends a Brightness message to given Tasmota Device Group with no reliability. Requires no prior setup and can control any group, but won't retransmit.
DGR_SendFixedColor [GroupName][TasColorIndex] Sends a FixedColor message to given Tasmota Device Group with no reliability. Requires no prior setup and can control any group, but won't retransmit.
DGR_SendPower [GroupName][ChannelValues][ChannelsCount] Sends a POWER message to given Tasmota Device Group with no reliability. Requires no prior setup and can control any group, but won't retransmit.
DGR_SendRGBCW [GroupName][HexRGBCW] Sends a RGBCW message to given Tasmota Device Group with no reliability. Requires no prior setup and can control any group, but won't retransmit. You can use this command in two ways, first is like DGR_SendRGBCW GroupName 255 255 0, etc, second is DGR_SendRGBCW GroupName FF00FF00 etc etc.
Dimmer [Value] Alias for led_dimmer
DimmerDelta [DeltaValue] This sets the delta value for SmartDimmer/SmartButtonForLEDs hold event. This determines the amount of change of dimmer per hold event.
DSEdge [edgeCode] DeepSleep (PinDeepSleep) wake configuration command. 0 means always wake up on rising edge, 1 means on falling, 2 means if state is high, use falling edge, if low, use rising. Default is 2
DSTime [timeSeconds] DoorSensor driver configuration command. Time to keep device running before next sleep after last door sensor change. In future we may add also an option to automatically sleep after MQTT confirms door state receival
echo [Message] Sends given message back to console. This command expands variables, so writing $CH12 will print value of channel 12, etc. Remember that you can also use special channel indices to access persistant flash variables and to access LED variables like dimmer, etc.
EnergyCntReset Resets the total Energy Counter, the one that is usually kept after device reboots. After this commands, the counter will start again from 0.
exec [Filename] exec - run autoexec.bat or other file from LFS if present
fakeTuyaPacket [HexString] This simulates packet being sent from TuyaMCU to our OBK device.
flags [IntegerValue] Sets the device flags
FriendlyName [Name] Sets the full name of the device
FullBootTime [Value] Sets time in seconds after which boot is marked as valid. This is related to emergency AP mode which is enabled by powering on/off device 5 times quickly.
GetChannel [ChannelIndex] Prints given channel value to console.
GetReadings Prints voltage etc readings to console.
goto [LabelStr] Script-only command. IF single argument is given, then goes to given label from within current script file. If two arguments are given, then jumps to any other script file by label - first argument is file, second label
HSBColor [H][S][B] Tasmota-style colour access. Hue in 0-360 range, saturation in 0-100 and brightness in 0-100 range.
HSBColor1 [Hue] Tasmota-style colour access. Sets hue in 0 to 360 range.
HSBColor2 [Saturation] Tasmota-style colour access. Set saturation in 0 to 100 range.
HSBColor3 [Brightness] Tasmota-style colour access. Sets brightness in 0 to 100 range.
if [Condition]['then'][CommandA]['else'][CommandB] Executed a conditional. Condition should be single line. You must always use 'then' after condition. 'else' is optional. Use aliases or quotes for commands with spaces
IREnable [Str][1or0] Enable/disable aspects of IR. IREnable RXTX 0/1 - enable Rx whilst Tx. IREnable [protocolname] 0/1 - enable/disable a specified protocol
IRSend [PROT-ADDR-CMD-REP] Sends IR commands in the form PROT-ADDR-CMD-REP, e.g. NEC-1-1A-0
json_test cmnd_json_test
lcd_clear Clears the LCD
lcd_clearAndGoto Clears LCD and go to pos
lcd_goto Go to position on LCD
lcd_print Prints a string on the LCD
lcd_printFloat Prints a float on the LCD
lcd_printInt Prints an omt on the LCD
led_basecolor_rgb [HexValue] Puts the LED driver in RGB mode and sets given color.
led_basecolor_rgbcw set PWN color using #RRGGBB[cw][ww]
led_colorMult [Value] Internal usage.
led_dimmer [Value] set output dimmer 0..100
led_enableAll [1or0orToggle] Power on/off LED but remember the RGB(CW) values
led_finishFullLerp This will force-finish LED color interpolation. You can call it after setting the colour to skip the interpolation/smooth transition time. Of course, it makes only sense if you enabled smooth colour transitions.
led_gammaCtrl sub-cmd [par] control LED Gamma Correction and Calibration
e.g.:led_gammaCtrl on
led_hue [Value] This is an alternate way to set the LED color.
led_lerpSpeed [LerpSpeed] Sets the speed of colour interpolation, where speed is defined as a number of RGB units per second, so 255 will lerp from 0 to 255 in one second
led_nextColor Sets the next color from predefined colours list. Our list is the same as in Tasmota.
led_saturation [Value] This is an alternate way to set the LED color.
led_saveInterval [IntervalSeconds] This determines how often LED state can be saved to flash memory. The state is saved only if it was modified and if the flag for LED state save is enabled. Set this to higher value if you are changing LED states very often, for example from xLights. Saving too often could wear out flash memory too fast.
led_temperature [TempValue] Toggles LED driver into temperature mode and sets given temperature. It using Home Assistant temperature range (in the range from 154-500 defined in homeassistant/util/color.py as HASS_COLOR_MIN and HASS_COLOR_MAX)
lfs_append [FileName][String] Appends a string to LFS file
lfs_appendFloat [FileName][Float] Appends a float to LFS file
lfs_appendInt [FileName][Int] Appends a Int to LFS file
lfs_appendLine [FileName][String] Appends a string to LFS file with a next line marker
lfs_format Unmount and format LFS. Optionally add new size as argument
lfs_mount Mount LFS
lfs_remove [FileName] Deletes a LittleFS file
lfs_size [MaxSize] Log or Set LFS size - will apply and re-format next boot, usage setlfssize 0x10000
lfs_test1 [FileName] Tests the LFS file reading feature.
lfs_test2 [FileName] Tests the LFS file reading feature.
lfs_test3 [FileName] Tests the LFS file reading feature.
lfs_unmount Un-mount LFS
lfs_write [FileName][String] Resets a LFS file and writes a new string to it
lfs_writeLine [FileName][String] Resets a LFS file and writes a new string to it with newline
linkTuyaMCUOutputToChannel [dpId][varType][channelID][bDPCache-Optional] Used to map between TuyaMCU dpIDs and our internal channels. Last argument is optional and 0 by default. You can set it to 1 for battery powered devices, so a variable is set with DPCache, for example a sampling interval for humidity/temperature sensor. Mapping works both ways. DpIDs are per-device, you can get them by sniffing UART communication. Vartypes can also be sniffed from Tuya. VarTypes can be following: 0-raw, 1-bool, 2-value, 3-string, 4-enum, 5-bitmap. Please see Tuya Docs for info about TuyaMCU. You can also see our TuyaMCU Analyzer Tool
listClockEvents Print the complete set clock events list
listEventHandlers Prints full list of added event handlers
listRepeatingEvents lists all repeating events
listScripts Lists all running scripts.
logdelay [Value] Value is a number of ms. This will add an artificial delay in each log call. Useful for debugging. This way you can see step by step what happens.
logfeature [Index][1or0] set log feature filter, as an index and a 1 or 0
loglevel [Value] Correct values are 0 to 7. Default is 3. Higher value includes more logs. Log levels are: ERROR = 1, WARN = 2, INFO = 3, DEBUG = 4, EXTRADEBUG = 5. WARNING: you also must separately select logging level filter on web panel in order for more logs to show up there
logport [Index] Allows you to change log output port. On Beken, the UART1 is used for flashing and for TuyaMCU/BL0942, while UART2 is for log. Sometimes it might be easier for you to have log on UART1, so now you can just use this command like backlog uartInit 115200; logport 1 to enable logging on UART1..
logtype [TypeStr] logtype direct
Map [TargetChannel][InputValue][InMin][InMax][OutMin][OutMax] Used to convert a value from one range into a proportional value of another range.
MapRanges [TargetChannel][InputValue][RangeVal0][RangeVal1][RangeValN] This will set given channel to an index showing where given input value is within given range sections. For example, MapRanges 10 0.5 0.3 0.6 0.9 will set channel 10 to 1 because 0.5 value is between 0.3 and 0.6
MAX72XX_Print DRV_MAX72XX_Print
MAX72XX_Scroll DRV_MAX72XX_Scroll
MAX72XX_Setup [Value] Sets the maximum current for LED driver.
MCP23017_MapPinToChannel Maps port expander bit to OBK channel
MqttClient [ValueString] Sets the MQTT client. Command keeps Tasmota syntax
MqttHost [ValueString] Sets the MQTT host. Command keeps Tasmota syntax
MqttPassword [ValueString] Sets the MQTT pass. Command keeps Tasmota syntax
MqttUser [ValueString] Sets the MQTT user. Command keeps Tasmota syntax
mqtt_broadcastInterval [ValueSeconds] If broadcast self state every 60 seconds/minute is enabled in flags, this value allows you to change the delay, change this 60 seconds to any other value in seconds. This value is not saved, you must use autoexec.bat or short startup command to execute it on every reboot.
mqtt_broadcastItemsPerSec [PublishCountPerSecond] If broadcast self state (this option in flags) is started, then gradually device info is published, with a speed of N publishes per second. Do not set too high value, it may overload LWIP MQTT library. This value is not saved, you must use autoexec.bat or short startup command to execute it on every reboot.
ntp_info Display NTP related settings
ntp_setServer [ServerIP] Sets the NTP server
ntp_timeZoneOfs [Value] Sets the time zone offset in hours. Also supports HH:MM syntax if you want to specify value in minutes. For negative values, use -HH:MM syntax, for example -5:30 will shift time by 5 hours and 30 minutes negative.
obkDeviceList Generate the SSDP list of OpenBeken devices found on the network.
OpenAP Temporarily disconnects from programmed WiFi network and opens Access Point
ota_http [HTTP_URL] Starts the firmware update procedure, the argument should be a reachable HTTP server file. You can easily setup HTTP server with Xampp, or Visual Code, or Python, etc. Make sure you are using OTA file for a correct platform (getting N platform RBL on T will brick device, etc etc)
Password1 [ValueString] Sets the Pass of target WiFi. Command keeps Tasmota syntax
PinDeepSleep Starts a pin deep sleep (deep sleep that can be interrupted by external IO events like a button press)
PingHost [IPStr] Sets the host to ping by IP watchdog
PingInterval [IntegerSeconds] Sets the interval between ping attempts for ping watchdog mechanism
power [OnorOfforToggle] Tasmota-style POWER command. Should work for both LEDs and relay-based devices. You can write POWER0, POWER1, etc to access specific relays.
powerAll set all outputs
PowerMax BL0937_PowerMax
PowerSave [Optional 1 or 0, by default 1 is assumed] Enables dynamic power saving mode on BK and W600. You can also disable power saving with PowerSave 0.
PowerSet Power Measure the real Power with an external, reliable power meter and enter this Power via this command to calibrate. The calibration is automatically saved in the flash memory.
publish [Topic][Value] Publishes data by MQTT. The final topic will be obk0696FB33/[Topic]/get. You can use argument expansion here, so $CH11 will change to value of the channel 11
publishAll Starts the step by step publish of all available values
publishBenchmark
publishChannel [ChannelIndex] Forces publish of given channel
publishChannels Starts the step by step publish of all channel values
publishFloat [Topic][Value] Publishes data by MQTT. The final topic will be obk0696FB33/[Topic]/get. You can use argument expansion here, so $CH11 will change to value of the channel 11. This version of command publishes an float, so you can also use math expressions like $CH10*0.0, etc.
publishInt [Topic][Value] Publishes data by MQTT. The final topic will be obk0696FB33/[Topic]/get. You can use argument expansion here, so $CH11 will change to value of the channel 11. This version of command publishes an integer, so you can also use math expressions like $CH10*10, etc.
reboot Same as restart. Needed for bkWriter 1.60 which sends 'reboot' cmd before trying to get bus
removeClockEvent [ID] Removes clock event wtih given ID
resetSVM Resets all SVM and clears all scripts.
restart Reboots the module
return Script-only command. Currently it just stops totally current script thread.
SafeMode Forces device reboot into safe mode (open ap with disabled drivers)
scanI2C
scheduleHADiscovery [Seconds] This will schedule HA discovery, the discovery will happen with given number of seconds, but timer only counts when MQTT is connected. It will not work without MQTT online, so you must set MQTT credentials first.
sendGet [TargetURL] Sends a HTTP GET request to target URL. May include GET arguments. Can be used to control devices by Tasmota HTTP protocol. Command supports argument expansion, so $CH11 changes to value of channel 11, etc, etc.
sendPOST CMD_SendPOST
setButtonColor [ButtonIndex][Color] Sets the colour of custom scriptable HTTP page button
setButtonCommand [ButtonIndex][Command] Sets the command of custom scriptable HTTP page button
setButtonEnabled [ButtonIndex][1or0] Sets the visibility of custom scriptable HTTP page button
setButtonHoldRepeat [Value] Sets just the hold button repeat time, given value is times 100ms, so write 1 for 100ms, 2 for 200ms, etc
setButtonLabel [ButtonIndex][Label] Sets the label of custom scriptable HTTP page button
setButtonTimes [ValLongPress][ValShortPress][ValRepeat] Each value is times 100ms, so: SetButtonTimes 2 1 1 means 200ms long press, 100ms short and 100ms repeat
SetChannel [ChannelIndex][ChannelValue] Sets a raw channel to given value. Relay channels are using 1 and 0 values. PWM channels are within [0,100] range. Do not use this for LED control, because there is a better and more advanced LED driver with dimming and configuration memory (remembers setting after on/off), LED driver commands has 'led_' prefix.
SetChannelFloat [ChannelIndex][ChannelValue] Sets a raw channel to given float value. Currently only used for LED PWM channels.
SetChannelLabel [ChannelIndex][Str][bHideTogglePrefix] Sets a channel label for UI. If you use 1 for bHideTogglePrefix, then the 'Toggle ' prefix from button will be omitted
setChannelType [ChannelIndex][TypeString] Sets a custom type for channel. Types are mostly used to determine how to display channel value on GUI
SetChannelVisible [ChannelIndex][bVisible] This allows you to force-hide a certain channel from HTTP gui. The channel will still work, but will not show up as a button, or a toggle, etc...
SetFlag [FlagIndex][0or1] Sets given flag
SetPinChannel [PinIndex][ChannelIndex] This allows you to set a channel linked to pin from console. Usually it's easier to do this through WWW panel, so you don't have to use this command.
SetPinRole [PinRole][RoleIndexOrName] This allows you to set a pin role, for example a Relay role, or Button, etc. Usually it's easier to do this through WWW panel, so you don't have to use this command.
SetStartValue [Channel][Value] Sets the startup value for a channel. Used for start values for relays. Use 1 for High, 0 for low and -1 for 'remember last state'
SetupEnergyStats [Enable1or0][SampleTime][SampleCount][JSonEnable] Setup Energy Statistic Parameters: [enable<0
SetupTestPower NULL
SGP_cycle [int] change cycle of measurement by default every 10 seconds 0 to deactivate
e.g.:SGP_Cycle 60
SGP_GetBaseline SGP Get baseline
e.g.:SGP_GetBaseline
SGP_GetVersion SGP : get version
e.g.:SGP_GetVersion
SGP_SoftReset SGP i2C soft reset
e.g.:SGP_SoftReset
ShortName [Name] Sets the short name of the device.
showChannelValues log channel values
showgpi NULL log stat of all GPIs
SHT_Calibrate Calibrate the SHT Sensor as Tolerance is +/-2 degrees C.
e.g.:SHT_Calibrate -4 10
SHT_ClearStatus Clear Sensor Status
e.g.:SHT_ClearStatusCmd
SHT_cycle [int] This is the interval between measurements in seconds, by default 10. Max is 255.
e.g.:SHT_Cycle 60
SHT_GetStatus Get Sensor Status
e.g.:SHT_GetStatusCmd
SHT_Heater Activate or Deactivate Heater (0 / 1)
e.g.:SHT_Heater 1
SHT_LaunchPer [msb][lsb] Launch/Change periodical capture for SHT Sensor
e.g.:SHT_LaunchPer 0x23 0x22
SHT_Measure Retrieve OneShot measurement for SHT
e.g.:SHT_Measure
SHT_MeasurePer Retrieve Periodical measurement for SHT
e.g.:SHT_Measure
SHT_ReadAlert Get Sensor alert configuration
e.g.:SHT_ReadAlertCmd
SHT_SetAlert [temp_high, temp_low, hum_high, hum_low]
Req:all
Set Sensor alert configuration
e.g.:SHT_SetAlertCmd
SHT_StopPer Stop periodical capture for SHT Sensor
simonirtest Simons Special Test
SM16703P_Send NULL
SM16703P_Test qq
SM16703P_Test_3xOne NULL
SM16703P_Test_3xZero NULL
SM2135_Current [RGBLimit][CWLimit] Sets the maximum current for LED driver. Please note that arguments are using SM2135 codes, see full list of codes here
SM2135_Map [Ch0][Ch1][Ch2][Ch3][Ch4] Maps the RGBCW values to given indices of SM2135 channels. This is because SM2135 channels order is not the same for some devices. Some devices are using RGBCW order and some are using GBRCW, etc, etc. Example usage: SM2135_Map 0 1 2 3 4
SM2135_RGBCW [HexColor] Don't use it. It's for direct access of SM2135 driver. You don't need it because LED driver automatically calls it, so just use led_basecolor_rgb
SM2235_Current [Value] Sets the maximum current for LED driver.
SM2235_Map [Ch0][Ch1][Ch2][Ch3][Ch4] Maps the RGBCW values to given indices of SM2235 channels. This is because SM2235 channels order is not the same for some devices. Some devices are using RGBCW order and some are using GBRCW, etc, etc. Example usage: SM2235_Map 0 1 2 3 4
SM2235_RGBCW [HexColor] Don't use it. It's for direct access of SM2235 driver. You don't need it because LED driver automatically calls it, so just use led_basecolor_rgb
SPITestFlash_Erase CMD_SPITestFlash_Erase
SPITestFlash_ReadData CMD_SPITestFlash_ReadData
SPITestFlash_ReadID CMD_SPITestFlash_ReadID
SPITestFlash_WriteStr CMD_SPITestFlash_WriteStr
SSID1 [ValueString] Sets the SSID of target WiFi. Command keeps Tasmota syntax.
stackOverflow Causes a stack overflow
startDriver [DriverName] Starts driver
startScript [FileName][Label][UniqueID] Starts a script thread from given file, at given label - can be * for whole file, with given unique ID
StartupCommand [Command in quotation marks][bRunAfter] Sets the new startup command (short startup command, the one stored in config) to given string. Second argument is optional, if set to 1, command will be also executed after setting
State NULL NULL
stopAllScripts Stops all running scripts
stopDriver [DriverName] Stops driver
stopScript [UniqueID] Force-stop given script thread by ID
TasTeleInterval [SensorInterval][StateInterval] This allows you to configure Tasmota TELE publish intervals, only if you have TELE flag enabled. First argument is interval for sensor publish (energy metering, etc), second is interval for State tele publish.
testArgs Test tokenizer for args and print back all the given args to console
testFloats Do some more test printfs with floating point numbers
testJSON Test the JSON library
testLog Do some test printfs to log with integer and a float
testMallocFree Test malloc and free functionality to see if the device crashes
testRealloc Test realloc and free functions to see if the device crashes
testStrdup Test strdup function to see if it allocs news string correctly, also test freeing the string
TM1650_Test CMD_TM1650_Test
TMGN_Brightness [Brigthness0to7][bOn] This allows you to change brightness and state of TM1637/GN932/etc display
TMGN_Char [CharIndex] [CharCode] This allows you to set binary code for given char, valid chars range is 0 to 15, because this is 7-seg display
TMGN_Clear This clears the TM1637/GN932/etc display
TMGN_Map [Map0][Map1, etc] This allows you to remap characters order for TM1637/GN932/etc. My TM1637 module from Aliexpress has a strange characters order.
TMGN_Print [StartOfs] [MaxLenOr0] [StringText] [optionalBClampWithZeroesForClock] This allows you to print string on TM1637/GN932/etc display, it supports variables expansion
TMGN_Read CMD_TMGN_Read
TMGN_SetBit [CharIndex] [BitIndex] [BitValue] Set given bit of given digit to 1 or 0.
TMGN_SetupButtons CMD_TMGN_SetupButtons
TMGN_Test CMD_TM1637_Test
ToggleChannel [ChannelIndex] Toggles given channel value. Non-zero becomes zero, zero becomes 1.
toggler_channel [ChannelIndex] handles toggler_channel0, toggler_channel1. Sets channel linked to given toggler slot.
toggler_enable [1or0] Sets the given output ON or OFF. handles toggler_enable0, toggler_enable1, etc
toggler_name Handles toggler_name0, toggler_name1, etc. Sets the name of a toggler for GUI.
toggler_set [Value] Sets the VALUE of given output. Handles toggler_set0, toggler_set1, etc. The last digit after command name is changed to slot index.
tuyaMcu_defWiFiState Command sets the default WiFi state for TuyaMCU when device is not online. It may be required for some devices to work, because Tuya designs them to ignore touch buttons or beep when not paired. Please see values table and description here.
tuyaMcu_sendCurTime Sends a current date by TuyaMCU to clock/callendar MCU. Time is taken from NTP driver, so NTP also should be already running.
tuyaMcu_sendHeartbeat Send heartbeat to TuyaMCU
tuyaMcu_sendMCUConf Send MCU conf command
tuyaMcu_sendProductInformation Send query packet (0x01). No arguments needed.
tuyaMcu_sendQueryState Send query state command. No arguments needed.
tuyaMcu_sendRSSI Command sends the specific RSSI value to TuyaMCU (it will send current RSSI if no argument is set)
tuyaMcu_sendState [dpID][dpType][dpValue] Manually send set state command. Do not use it. Use mapping, so communication is bidirectional and automatic.
tuyaMcu_setBaudRate [BaudValue] Sets the baud rate used by TuyaMCU UART communication. Default value is 9600. Some other devices require 115200.
tuyaMcu_setDimmerRange [Min][Max] Set dimmer range used by TuyaMCU
tuyaMcu_testSendTime Sends a example date by TuyaMCU to clock/callendar MCU
uartFakeHex [HexString] Spoofs a fake hex packet so it looks like TuyaMCU send that to us. Used for testing.
uartInit [BaudRate] Manually starts UART1 port. Keep in mind that you don't need to do it for TuyaMCU and BL0942, those drivers do it automatically.
uartSendASCII [AsciiString] Sends given string by UART.
uartSendHex [HexString] Sends raw data by UART, can be used to send TuyaMCU data, but you must write whole packet with checksum yourself
UCS1912_Test
VCPPrecision [VoltageDigits][CurrentDigitsAmpers][PowerDigitsWats][EnergyDigitsWh] Sets the number of digits after decimal point for power metering publishes. Default is BL09XX_VCPPrecision 1 3 2 3. This works for OBK-style publishes.
VCPPublishIntervals [MinDelayBetweenPublishes][ForcedPublishInterval] First argument is minimal allowed interval in second between Voltage/Current/Power/Energy publishes (even if there is a large change), second value is an interval in which V/C/P/E is always published, even if there is no change
VCPPublishThreshold [VoltageDeltaVolts][CurrentDeltaAmpers][PowerDeltaWats][EnergyDeltaWh] Sets the minimal change between previous reported value over MQTT and next reported value over MQTT. Very useful for BL0942, BL0937, etc. So, if you set, VCPPublishThreshold 0.5 0.001 0.5, it will only report voltage again if the delta from previous reported value is largen than 0.5V. Remember, that the device will also ALWAYS force-report values every N seconds (default 60)
VoltageSet Voltage Measure the real voltage with an external, reliable power meter and enter this voltage via this command to calibrate. The calibration is automatically saved in the flash memory.
waitFor [EventName] [Argument] Wait forever for event. Can be used within script. For example, you can do: waitFor MQTTState 1 or waitFor NTPState 1. You can also do waitFor NoPingTime 600 to wait for 600 seconds without ping watchdog getting successful reply