mirror/OpenBK7231T_App
3
0
Fork 0
mirror of https://github.com/openshwprojects/OpenBK7231T_App.git synced 2026-02-05 01:05:35 +00:00
Code Issues Packages Projects Releases Wiki Activity

Documentation Update (#843)

Browse Source 
* 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.
This commit is contained in:
Tom
2023-06-02 08:05:46 -05:00
committed by GitHub
parent 9982e10d5f
commit cb39120560
12 changed files with 2485 additions and 2436 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
docs/README.md
View File

@ -13,15 +13,15 @@ Do not add anything here, as it will overwritten with next rebuild.
# Doc tables
| Section | Comment |
|:------------- |------:|
| [IO/Pin Roles](https://github.com/openshwprojects/OpenBK7231T_App/blob/main/docs/ioRoles.md) (76 total) | You can set pin roles in 'Configure Module' section or use one of predefined templates in Web App. For each pin, you also set coresponding channel value. This is needed for modules with multiple relays. If you have 3 relays and 3 buttons, you need to use channel values like 1, 2, and 3. Just enter '1' in the text field, etc. |
| [IO/Pin Roles](https://github.com/openshwprojects/OpenBK7231T_App/blob/main/docs/ioRoles.md) (77 total) | You can set pin roles in 'Configure Module' section or use one of predefined templates in Web App. For each pin, you also set coresponding channel value. This is needed for modules with multiple relays. If you have 3 relays and 3 buttons, you need to use channel values like 1, 2, and 3. Just enter '1' in the text field, etc. |
| [Flags](https://github.com/openshwprojects/OpenBK7231T_App/blob/main/docs/flags.md) (41 total) | Flags are global and allows you to alter behaviour of the device. |
| [Drivers](https://github.com/openshwprojects/OpenBK7231T_App/blob/main/docs/drivers.md) (36 total) | Drivers allows you to control certain peripherals or enable certain features that are off by default. |
| [Script constants](https://github.com/openshwprojects/OpenBK7231T_App/blob/main/docs/constants.md) (24 total) | Every console command that takes an integer argument supports certain constant expansion. |
| [Channel Types](https://github.com/openshwprojects/OpenBK7231T_App/blob/main/docs/channelTypes.md) (38 total) | Channel types are often not required and don't have to be configured, but in some cases they are required for better device control from OpenBeken web panel. Channel types describes the kind of value stored in channel, for example, if you have a Tuya Fan Controller with 3 speeds control, you can set the channel type to LowMidHigh and it will display the correct UI radiobutton on OpenBeken panel.<br>Some channels have '_div10' or '_div100' sufixes. This is for TuyaMCU. This is needed because TuyaMCU sends values as integers, so it sends, for example, 215 for 21.5C temperature, and we store it internally as 215 and only convert to float for display. |
| [Channel Types](https://github.com/openshwprojects/OpenBK7231T_App/blob/main/docs/channelTypes.md) (39 total) | Channel types are often not required and don't have to be configured, but in some cases they are required for better device control from OpenBeken web panel. Channel types describes the kind of value stored in channel, for example, if you have a Tuya Fan Controller with 3 speeds control, you can set the channel type to LowMidHigh and it will display the correct UI radiobutton on OpenBeken panel.<br>Some channels have '_div10' or '_div100' sufixes. This is for TuyaMCU. This is needed because TuyaMCU sends values as integers, so it sends, for example, 215 for 21.5C temperature, and we store it internally as 215 and only convert to float for display. |
| [FAQ](https://github.com/openshwprojects/OpenBK7231T_App/blob/main/docs/faq.md) (27 total) | Here is a detailed list of questions you may ask. Some information from docs is repeated here. |
| [Console/Script commands](https://github.com/openshwprojects/OpenBK7231T_App/blob/main/docs/commands.md) (260 total) | There are multiple console commands that allow you to automate your devices. Commands can be entered manually in command line, can be send by HTTP (just like in Tasmota), can be send by MQTT and also can be scripted. |
| [Console/Script commands](https://github.com/openshwprojects/OpenBK7231T_App/blob/main/docs/commands.md) (262 total) | There are multiple console commands that allow you to automate your devices. Commands can be entered manually in command line, can be send by HTTP (just like in Tasmota), can be send by MQTT and also can be scripted. |
| [Command Examples](https://github.com/openshwprojects/OpenBK7231T_App/blob/main/docs/commandExamples.md) (10 total) | Here you can find some examples of console commands usage |
| [Autoexec.bat examples (configs)](https://github.com/openshwprojects/OpenBK7231T_App/blob/main/docs/autoexecExamples.md) (15 total) | Here you can find examples of autoexec.bat configs. The autoexec.bat file can be created in Web Application, under LittleFS tab, and is run every time device reboots (unless device enters safe mode/AP mode). The autoexec.bat file allows you to create more advanced configs, setup TuyaMCU mappings, etc |
| [MQTT Topics](https://github.com/openshwprojects/OpenBK7231T_App/blob/main/docs/mqttTopics.md) (25 total) | MQTT topic names and content for incoming and ougoing OBK MQTT publishes |
| [Script examples](https://github.com/openshwprojects/OpenBK7231T_App/blob/main/docs/scriptExamples.md) (5 total) | Scripts can be put in autoexec.bat and then they will start automatically on reboot, you can also put script in other LittleFS file and use startScript [fileName] [Label] command to run them. From the firmware point of view, scripts and autoexecs are basically the same thing. There is, however, a little bit more advanced system of execution for scripts which can be written in a form of scripts threads that run over time, can have delays within then, conditional checks and jumps. |
| [Console/Script commands [Extended Edition]](https://github.com/openshwprojects/OpenBK7231T_App/blob/main/docs/commands-extended.md) (260 total) | More details on commands. |
| [Console/Script commands [Extended Edition]](https://github.com/openshwprojects/OpenBK7231T_App/blob/main/docs/commands-extended.md) (262 total) | More details on commands. |

1
docs/channelTypes.md
View File

@ -42,4 +42,5 @@ Do not add anything here, as it will overwritten with next rebuild.
| Custom | A custom channel type that is still send to HA. |
| Power_div10 | Just like power, but with one decimal place (but stored as integer, for TuyaMCU support) |
| ReadOnlyLowMidHigh | Like LowMidHigh, but just read only |
| SmokePercent | Smoke percentage |
| Max | This is the current total number of available channel types. |

464
docs/commands-extended.md
View File

@ -5,264 +5,266 @@ All descriptions were taken from code.
Do not add anything here, as it will overwritten with next rebuild.
| Command | Arguments | Description | Location |
|:------------- |:-------------:|:----- | ------:|
| 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. | File: cmnds/cmd_channels.c<br/>Function: CMD_SetChannel |
| SetChannelFloat | [ChannelIndex][ChannelValue] | Sets a raw channel to given float value. Currently only used for LED PWM channels. | File: cmnds/cmd_channels.c<br/>Function: CMD_SetChannelFloat |
| ToggleChannel | [ChannelIndex] | Toggles given channel value. Non-zero becomes zero, zero becomes 1. | File: cmnds/cmd_channels.c<br/>Function: CMD_ToggleChannel |
| 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. | File: cmnds/cmd_channels.c<br/>Function: CMD_AddChannel |
| ClampChannel | [ChannelIndex][Min][Max] | Clamps given channel value to a range. | File: cmnds/cmd_channels.c<br/>Function: CMD_ClampChannel |
| 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. | File: cmnds/cmd_channels.c<br/>Function: CMD_SetPinRole |
| 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. | File: cmnds/cmd_channels.c<br/>Function: CMD_SetPinChannel |
| GetChannel | [ChannelIndex] | Prints given channel value to console. | File: cmnds/cmd_channels.c<br/>Function: CMD_GetChannel |
| GetReadings | | Prints voltage etc readings to console. | File: cmnds/cmd_channels.c<br/>Function: CMD_GetReadings |
| ShortName | [Name] | Sets the short name of the device. | File: cmnds/cmd_channels.c<br/>Function: CMD_ShortName |
| FriendlyName | [Name] | Sets the full name of the device | File: cmnds/cmd_channels.c<br/>Function: CMD_FriendlyName |
| PinDeepSleep | | Starts a pin deep sleep (deep sleep that can be interrupted by external IO events like a button press) | File: cmnds/cmd_channels.c<br/>Function: CMD_PinDeepSleep |
| 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. | File: cmnds/cmd_channels.c<br/>Function: CMD_FullBootTime |
| 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 | File: cmnds/cmd_channels.c<br/>Function: CMD_SetChannelLabel |
| 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 | File: cmnds/cmd_channels.c<br/>Function: CMD_MapRanges |
| Map | [TargetChannel][InputValue][InMin][InMax][OutMin][OutMax] | qqq | File: cmnds/cmd_channels.c<br/>Function: CMD_Map |
| 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... | File: cmnds/cmd_channels.c<br/>Function: CMD_SetChannelVisible |
| 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. | File: cmnds/cmd_channels.c<br/>Function: CMD_Ch |
| AddEventHandler | [EventName][EventArgument][CommandToRun] | This can be used to trigger an action on a button click, long press, etc | File: cmnds/cmd_eventHandlers.c<br/>Function: CMD_AddEventHandler |
| 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') | File: drv/drv_adcButton.c<br/>Function: Cmd_ADCButtonMap |
| 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' | File: cmnds/cmd_eventHandlers.c<br/>Function: CMD_AddChangeHandler |
| listEventHandlers | | Prints full list of added event handlers | File: cmnds/cmd_eventHandlers.c<br/>Function: CMD_ListEventHandlers |
| clearAllHandlers | | This clears all added event handlers | File: cmnds/cmd_eventHandlers.c<br/>Function: CMD_ClearAllHandlers |
| aliasMem | | Internal usage only. See docs for 'alias' command. | File: cmnds/cmd_test.c<br/>Function: runcmd |
| 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. | File: cmnds/cmd_channels.c<br/>Function: CMD_AddChannel |
| 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 | File: driver/drv_ntp_events.c<br/>Function: CMD_NTP_AddClockEvent |
| AddEventHandler | [EventName][EventArgument][CommandToRun] | This can be used to trigger an action on a button click, long press, etc | File: cmnds/cmd_eventHandlers.c<br/>Function: CMD_AddEventHandler |
| addI2CDevice_LCD_PCF8574 | | Adds a new I2C device - PCF8574 | File: i2c/drv_i2c_main.c<br/>Function: DRV_I2C_AddDevice_PCF8574 |
| addI2CDevice_LCM1602 | | Adds a new I2C device - LCM1602 | File: i2c/drv_i2c_main.c<br/>Function: DRV_I2C_AddDevice_LCM1602 |
| addI2CDevice_MCP23017 | | Adds a new I2C device - MCP23017 | File: i2c/drv_i2c_main.c<br/>Function: DRV_I2C_AddDevice_MCP23017 |
| addI2CDevice_TC74 | | Adds a new I2C device - TC74 | File: i2c/drv_i2c_main.c<br/>Function: DRV_I2C_AddDevice_TC74 |
| addRepeatingEvent | [IntervalSeconds][RepeatsOr-1][CommandToRun] | Starts a timer/interval command. Use 'backlog' to fit multiple commands in a single string. | File: cmnds/cmd_repeatingEvents.c<br/>Function: RepeatingEvents_Cmd_AddRepeatingEvent |
| addRepeatingEventID | [IntervalSeconds][RepeatsOr-1][UserID][CommandToRun] | as addRepeatingEvent, but with a given ID. You can later cancel it with cancelRepeatingEvent.<br/>e.g.:addRepeatingEventID 2 -1 123 Power0 Toggle | File: cmnds/cmd_repeatingEvents.c<br/>Function: RepeatingEvents_Cmd_AddRepeatingEvent |
| 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). | File: cmnds/cmd_newLEDDriver.c<br/>Function: add_dimmer |
| add_temperature | [DeltaValue][bWrapAroundInsteadOfHold] | Adds a given value to current LED temperature. Function can wrap or clamp if max/min is exceeded. | File: cmnds/cmd_newLEDDriver.c<br/>Function: add_temperature |
| alias | [Alias][Command with spaces] | add an aliased command, so a command with spaces can be called with a short, nospaced alias | File: cmnds/cmd_test.c<br/>Function: alias |
| 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. | File: cmnds/cmd_main.c<br/>Function: CMD_Echo |
| restart | | Reboots the module | File: cmnds/cmd_main.c<br/>Function: CMD_Restart |
| reboot | | Same as restart. Needed for bkWriter 1.60 which sends 'reboot' cmd before trying to get bus | File: cmnds/cmd_main.c<br/>Function: CMD_Restart |
| aliasMem | | Internal usage only. See docs for 'alias' command. | File: cmnds/cmd_test.c<br/>Function: runcmd |
| backlog | [string of commands separated with ;] | run a sequence of ; separated commands | File: cmnds/cmd_tasmota.c<br/>Function: cmnd_backlog |
| Battery_cycle | [int] | change cycle of measurement by default every 10 seconds<br/>e.g.:Battery_cycle 60 | File: drv/drv_battery.c<br/>Function: Battery_cycle |
| Battery_Setup | [minbatt][maxbatt][V_divider][Vref][AD Bits] | measure battery based on ADC. <br />req. args: minbatt in mv, maxbatt in mv. <br />optional: V_divider(2), Vref(default 2400), ADC bits(4096)<br/>e.g.:Battery_Setup 1500 3000 2 2400 4096 | File: drv/drv_battery.c<br/>Function: Battery_Setup |
| BP1658CJ_Current | [MaxCurrentRGB][MaxCurrentCW] | Sets the maximum current limit for BP1658CJ driver. | File: driver/drv_bp1658cj.c<br/>Function: BP1658CJ_Current |
| 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 | File: driver/drv_bp1658cj.c<br/>Function: BP1658CJ_Map |
| 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 | File: driver/drv_bp1658cj.c<br/>Function: BP1658CJ_RGBCW |
| BP5758D_Current | [MaxCurrentRGB][MaxCurrentCW] | Sets the maximum current limit for BP5758D driver, first value is for rgb and second for cw | File: driver/drv_bp5758d.c<br/>Function: BP5758D_Current |
| 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 | File: driver/drv_bp5758d.c<br/>Function: BP5758D_Map |
| 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 | File: driver/drv_bp5758d.c<br/>Function: BP5758D_RGBCW |
| BridgePulseLength | [FloatValue] | Setup value for bridge pulse len | File: driver/drv_bridge_driver.c<br/>Function: Bridge_Pulse_length |
| cancelRepeatingEvent | [UserIDInteger] | Stops a given repeating event with a specified ID | File: cmnds/cmd_repeatingEvents.c<br/>Function: RepeatingEvents_Cmd_CancelRepeatingEvent |
| 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. | File: cmnds/cmd_channels.c<br/>Function: CMD_Ch |
| CHT_Calibrate | | Calibrate the CHT Sensor as Tolerance is +/-2 degrees C.<br/>e.g.:SHT_Calibrate -4 10 | File: driver/drv_cht8305.c<br/>Function: CHT_Calibrate |
| CHT_Cycle | [int] | This is the interval between measurements in seconds, by default 1. Max is 255.<br/>e.g.:CHT_Cycle 60 | File: drv/drv_cht8305.c<br/>Function: CHT_cycle |
| ClampChannel | [ChannelIndex][Min][Max] | Clamps given channel value to a range. | File: cmnds/cmd_channels.c<br/>Function: CMD_ClampChannel |
| clearAll | | Clears config and all remaining features, like runtime scripts, events, etc | File: cmnds/cmd_main.c<br/>Function: CMD_ClearAll |
| clearAllHandlers | | This clears all added event handlers | File: cmnds/cmd_eventHandlers.c<br/>Function: CMD_ClearAllHandlers |
| clearClockEvents | | Removes all set clock events | File: driver/drv_ntp_events.c<br/>Function: CMD_NTP_ClearEvents |
| clearConfig | | Clears all config, including WiFi data | File: cmnds/cmd_main.c<br/>Function: CMD_ClearConfig |
| clearIO | | Clears all pins setting, channels settings | File: cmnds/cmd_main.c<br/>Function: CMD_ClearIO |
| clearAll | | Clears config and all remaining features, like runtime scripts, events, etc | File: cmnds/cmd_main.c<br/>Function: CMD_ClearAll |
| 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. | File: cmnds/cmd_main.c<br/>Function: CMD_DeepSleep |
| 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. | File: cmnds/cmd_main.c<br/>Function: CMD_PowerSave |
| stackOverflow | | Causes a stack overflow | File: cmnds/cmd_main.c<br/>Function: CMD_StackOverflow |
| crashNull | | Causes a crash | File: cmnds/cmd_main.c<br/>Function: CMD_CrashNull |
| simonirtest | | Simons Special Test | File: cmnds/cmd_main.c<br/>Function: CMD_SimonTest |
| 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 | File: cmnds/cmd_main.c<br/>Function: CMD_If |
| 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) | File: cmnds/cmd_main.c<br/>Function: CMD_HTTPOTA |
| 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. | File: cmnds/cmd_main.c<br/>Function: CMD_ScheduleHADiscovery |
| flags | [IntegerValue] | Sets the device flags | File: cmnds/cmd_main.c<br/>Function: CMD_Flags |
| SetFlag | [FlagIndex][0or1] | Sets given flag | File: cmnds/cmd_main.c<br/>Function: CMD_SetFlag |
| ClearNoPingTime | | Command for ping watchdog; it sets the 'time since last ping reply' to 0 again | File: cmnds/cmd_main.c<br/>Function: CMD_ClearNoPingTime |
| 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' | File: cmnds/cmd_main.c<br/>Function: CMD_SetStartValue |
| OpenAP | | Temporarily disconnects from programmed WiFi network and opens Access Point | File: cmnds/cmd_main.c<br/>Function: CMD_OpenAP |
| DSEdge | [edgeCode] | DoorSensor driver 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 | File: drv/drv_doorSensorWithDeepSleep.c<br/>Function: CMD_DeepSleep_SetEdge |
| SafeMode | | Forces device reboot into safe mode (open ap with disabled drivers) | File: cmnds/cmd_main.c<br/>Function: CMD_SafeMode |
| PingInterval | [IntegerSeconds] | Sets the interval between ping attempts for ping watchdog mechanism | File: cmnds/cmd_main.c<br/>Function: CMD_PingInterval |
| PingHost | [IPStr] | Sets the host to ping by IP watchdog | File: cmnds/cmd_main.c<br/>Function: CMD_PingHost |
| 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 | File: cmnds/cmd_main.c<br/>Function: CMD_StartupCommand |
| led_dimmer | [Value] | set output dimmer 0..100 | File: cmnds/cmd_newLEDDriver.c<br/>Function: dimmer |
| Dimmer | [Value] | Alias for led_dimmer | File: cmnds/cmd_newLEDDriver.c<br/>Function: dimmer |
| 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). | File: cmnds/cmd_newLEDDriver.c<br/>Function: add_dimmer |
| led_enableAll | [1or0orToggle] | Power on/off LED but remember the RGB(CW) values | File: cmnds/cmd_newLEDDriver.c<br/>Function: enableAll |
| led_basecolor_rgb | [HexValue] | Puts the LED driver in RGB mode and sets given color. | File: cmnds/cmd_newLEDDriver.c<br/>Function: basecolor_rgb |
| clearRepeatingEvents | | Clears all repeating events. | File: cmnds/cmd_repeatingEvents.c<br/>Function: RepeatingEvents_Cmd_ClearRepeatingEvents |
| Color | [HexValue] | Puts the LED driver in RGB mode and sets given color. | File: cmnds/cmd_newLEDDriver.c<br/>Function: basecolor_rgb |
| led_basecolor_rgbcw | | set PWN color using #RRGGBB[cw][ww] | File: cmnds/cmd_newLEDDriver.c<br/>Function: basecolor_rgbcw |
| add_temperature | [DeltaValue][bWrapAroundInsteadOfHold] | Adds a given value to current LED temperature. Function can wrap or clamp if max/min is exceeded. | File: cmnds/cmd_newLEDDriver.c<br/>Function: add_temperature |
| 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) | File: cmnds/cmd_newLEDDriver.c<br/>Function: temperature |
| ConsumptionThreshold | [FloatValue] | Setup value for automatic save of consumption data [1..100] | File: driver/drv_bl_shared.c<br/>Function: BL09XX_SetupConsumptionThreshold |
| crashNull | | Causes a crash | File: cmnds/cmd_main.c<br/>Function: CMD_CrashNull |
| CT | [TempValue] | Same as led_temperature | File: cmnds/cmd_newLEDDriver.c<br/>Function: temperature |
| led_colorMult | [Value] | Internal usage. | File: cmnds/cmd_newLEDDriver.c<br/>Function: colorMult |
| led_saturation | [Value] | This is an alternate way to set the LED color. | File: cmnds/cmd_newLEDDriver.c<br/>Function: setSaturation |
| led_hue | [Value] | This is an alternate way to set the LED color. | File: cmnds/cmd_newLEDDriver.c<br/>Function: setHue |
| led_nextColor | | Sets the next color from predefined colours list. Our list is the same as in Tasmota. | File: cmnds/cmd_newLEDDriver.c<br/>Function: nextColor |
| 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 | File: cmnds/cmd_newLEDDriver.c<br/>Function: lerpSpeed |
| CTRange | [MinRange][MaxRange] | This sets the temperature range for display. Default is 154-500. | File: cmnds/cmd_newLEDDriver.c<br/>Function: ctRange |
| 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. | File: driver/drv_pwrCal.c<br/>Function: NULL); |
| 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. | File: cmnds/cmd_main.c<br/>Function: CMD_DeepSleep |
| delay_ms | [ValueMS] | Script-only command. Pauses current script thread for given amount of ms. | File: cmnds/cmd_script.c<br/>Function: CMD_Delay_ms |
| delay_s | [ValueSeconds] | Script-only command. Pauses current script thread for given amount of seconds. | File: cmnds/cmd_script.c<br/>Function: CMD_Delay_s |
| 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. | File: driver/drv_tasmotaDeviceGroups.c<br/>Function: CMD_DGR_SendBrightness |
| 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. | File: driver/drv_tasmotaDeviceGroups.c<br/>Function: CMD_DGR_SendFixedColor |
| 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. | File: driver/drv_tasmotaDeviceGroups.c<br/>Function: CMD_DGR_SendPower |
| 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. | File: driver/drv_tasmotaDeviceGroups.c<br/>Function: CMD_DGR_SendRGBCW |
| Dimmer | [Value] | Alias for led_dimmer | File: cmnds/cmd_newLEDDriver.c<br/>Function: dimmer |
| DimmerDelta | [DeltaValue] | This sets the delta value for SmartDimmer/SmartButtonForLEDs hold event. This determines the amount of change of dimmer per hold event. | File: cmnds/cmd_newLEDDriver.c<br/>Function: dimmerDelta |
| 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 | File: drv/drv_doorSensorWithDeepSleep.c<br/>Function: CMD_DeepSleep_SetEdge |
| 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 | File: drv/drv_doorSensorWithDeepSleep.c<br/>Function: DoorDeepSleep_SetTime |
| 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. | File: cmnds/cmd_main.c<br/>Function: CMD_Echo |
| 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. | File: driver/drv_bl_shared.c<br/>Function: BL09XX_ResetEnergyCounter |
| exec | [Filename] | exec <file> - run autoexec.bat or other file from LFS if present | File: cmnds/cmd_tasmota.c<br/>Function: cmnd_lfsexec |
| fakeTuyaPacket | [HexString] | This simulates packet being sent from TuyaMCU to our OBK device. | File: driver/drv_tuyaMCU.c<br/>Function: TuyaMCU_FakePacket |
| flags | [IntegerValue] | Sets the device flags | File: cmnds/cmd_main.c<br/>Function: CMD_Flags |
| FriendlyName | [Name] | Sets the full name of the device | File: cmnds/cmd_channels.c<br/>Function: CMD_FriendlyName |
| 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. | File: cmnds/cmd_channels.c<br/>Function: CMD_FullBootTime |
| GetChannel | [ChannelIndex] | Prints given channel value to console. | File: cmnds/cmd_channels.c<br/>Function: CMD_GetChannel |
| GetReadings | | Prints voltage etc readings to console. | File: cmnds/cmd_channels.c<br/>Function: CMD_GetReadings |
| 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 | File: cmnds/cmd_script.c<br/>Function: CMD_GoTo |
| HSBColor | [H][S][B] | Tasmota-style colour access. Hue in 0-360 range, saturation in 0-100 and brightness in 0-100 range. | File: cmnds/cmd_newLEDDriver.c<br/>Function: LED_SetBaseColor_HSB |
| HSBColor1 | [Hue] | Tasmota-style colour access. Sets hue in 0 to 360 range. | File: cmnds/cmd_newLEDDriver.c<br/>Function: setHue |
| HSBColor2 | [Saturation] | Tasmota-style colour access. Set saturation in 0 to 100 range. | File: cmnds/cmd_newLEDDriver.c<br/>Function: setSaturation |
| HSBColor3 | [Brightness] | Tasmota-style colour access. Sets brightness in 0 to 100 range. | File: cmnds/cmd_newLEDDriver.c<br/>Function: setBrightness |
| 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. | File: cmnds/cmd_newLEDDriver.c<br/>Function: led_finishFullLerp |
| led_gammaCtrl | sub-cmd [par] | control LED Gamma Correction and Calibration<br/>e.g.:led_gammaCtrl on | File: cmnds/cmd_rgbGamma.c<br/>Function: rgb_gamma_control |
| CTRange | [MinRange][MaxRange] | This sets the temperature range for display. Default is 154-500. | File: cmnds/cmd_newLEDDriver.c<br/>Function: ctRange |
| DimmerDelta | [DeltaValue] | This sets the delta value for SmartDimmer/SmartButtonForLEDs hold event. This determines the amount of change of dimmer per hold event. | File: cmnds/cmd_newLEDDriver.c<br/>Function: dimmerDelta |
| 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. | File: cmnds/cmd_newLEDDriver.c<br/>Function: cmdSaveStateIfModifiedInterval |
| addRepeatingEvent | [IntervalSeconds][RepeatsOr-1][CommandToRun] | Starts a timer/interval command. Use 'backlog' to fit multiple commands in a single string. | File: cmnds/cmd_repeatingEvents.c<br/>Function: RepeatingEvents_Cmd_AddRepeatingEvent |
| addRepeatingEventID | [IntervalSeconds][RepeatsOr-1][UserID][CommandToRun] | as addRepeatingEvent, but with a given ID. You can later cancel it with cancelRepeatingEvent.<br/>e.g.:addRepeatingEventID 2 -1 123 Power0 Toggle | File: cmnds/cmd_repeatingEvents.c<br/>Function: RepeatingEvents_Cmd_AddRepeatingEvent |
| cancelRepeatingEvent | [UserIDInteger] | Stops a given repeating event with a specified ID | File: cmnds/cmd_repeatingEvents.c<br/>Function: RepeatingEvents_Cmd_CancelRepeatingEvent |
| clearRepeatingEvents | | Clears all repeating events. | File: cmnds/cmd_repeatingEvents.c<br/>Function: RepeatingEvents_Cmd_ClearRepeatingEvents |
| listRepeatingEvents | | lists all repeating events | File: cmnds/cmd_repeatingEvents.c<br/>Function: RepeatingEvents_Cmd_ListRepeatingEvents |
| startScript | [FileName][Label][UniqueID] | Starts a script thread from given file, at given label - can be * for whole file, with given unique ID | File: cmnds/cmd_script.c<br/>Function: CMD_StartScript |
| stopScript | [UniqueID] | Force-stop given script thread by ID | File: cmnds/cmd_script.c<br/>Function: CMD_StopScript |
| stopAllScripts | | Stops all running scripts | File: cmnds/cmd_script.c<br/>Function: CMD_StopAllScripts |
| listScripts | | Lists all running scripts. | File: cmnds/cmd_script.c<br/>Function: CMD_ListScripts |
| 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 | File: cmnds/cmd_script.c<br/>Function: CMD_GoTo |
| delay_s | [ValueSeconds] | Script-only command. Pauses current script thread for given amount of seconds. | File: cmnds/cmd_script.c<br/>Function: CMD_Delay_s |
| delay_ms | [ValueMS] | Script-only command. Pauses current script thread for given amount of ms. | File: cmnds/cmd_script.c<br/>Function: CMD_Delay_ms |
| return | | Script-only command. Currently it just stops totally current script thread. | File: cmnds/cmd_script.c<br/>Function: CMD_Return |
| resetSVM | | Resets all SVM and clears all scripts. | File: cmnds/cmd_script.c<br/>Function: CMD_resetSVM |
| 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 | File: cmnds/cmd_script.c<br/>Function: CMD_waitFor |
| 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. | File: cmnds/cmd_send.c<br/>Function: CMD_SendGET |
| 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. | File: cmnds/cmd_tasmota.c<br/>Function: power |
| powerAll | | set all outputs | File: cmnds/cmd_tasmota.c<br/>Function: powerAll |
| backlog | [string of commands separated with ;] | run a sequence of ; separated commands | File: cmnds/cmd_tasmota.c<br/>Function: cmnd_backlog |
| exec | [Filename] | exec <file> - run autoexec.bat or other file from LFS if present | File: cmnds/cmd_tasmota.c<br/>Function: cmnd_lfsexec |
| SSID1 | [ValueString] | Sets the SSID of target WiFi. Command keeps Tasmota syntax. | File: cmnds/cmd_tasmota.c<br/>Function: cmnd_SSID1 |
| Password1 | [ValueString] | Sets the Pass of target WiFi. Command keeps Tasmota syntax | File: cmnds/cmd_tasmota.c<br/>Function: cmnd_Password1 |
| MqttHost | [ValueString] | Sets the MQTT host. Command keeps Tasmota syntax | File: cmnds/cmd_tasmota.c<br/>Function: cmnd_MqttHost |
| MqttUser | [ValueString] | Sets the MQTT user. Command keeps Tasmota syntax | File: cmnds/cmd_tasmota.c<br/>Function: cmnd_MqttUser |
| MqttPassword | [ValueString] | Sets the MQTT pass. Command keeps Tasmota syntax | File: cmnds/cmd_tasmota.c<br/>Function: cmnd_MqttPassword |
| MqttClient | [ValueString] | Sets the MQTT client. Command keeps Tasmota syntax | File: cmnds/cmd_tasmota.c<br/>Function: cmnd_MqttClient |
| State | NULL | NULL | File: cmnds/cmd_tasmota.c<br/>Function: cmnd_State |
| testMallocFree | | Test malloc and free functionality to see if the device crashes | File: cmnds/cmd_test.c<br/>Function: testMallocFree |
| testRealloc | | Test realloc and free functions to see if the device crashes | File: cmnds/cmd_test.c<br/>Function: testRealloc |
| testJSON | | Test the JSON library | File: cmnds/cmd_test.c<br/>Function: testJSON |
| testLog | | Do some test printfs to log with integer and a float | File: cmnds/cmd_test.c<br/>Function: testLog |
| testFloats | | Do some more test printfs with floating point numbers | File: cmnds/cmd_test.c<br/>Function: testFloats |
| testArgs | | Test tokenizer for args and print back all the given args to console | File: cmnds/cmd_test.c<br/>Function: testArgs |
| testStrdup | | Test strdup function to see if it allocs news string correctly, also test freeing the string | File: cmnds/cmd_test.c<br/>Function: testStrdup |
| lfs_test1 | [FileName] | Tests the LFS file reading feature. | File: cmnds/cmd_tasmota.c<br/>Function: cmnd_lfs_test1 |
| lfs_test2 | [FileName] | Tests the LFS file reading feature. | File: cmnds/cmd_tasmota.c<br/>Function: cmnd_lfs_test2 |
| lfs_test3 | [FileName] | Tests the LFS file reading feature. | File: cmnds/cmd_tasmota.c<br/>Function: cmnd_lfs_test3 |
| json_test | cmnd_json_test | | File: cmnds/cmd_test.c<br/>Function: NULL); |
| 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') | File: drv/drv_adcButton.c<br/>Function: Cmd_ADCButtonMap |
| Battery_Setup | [float][float][float][float][float] | measure battery based on ADC args minbatt and maxbatt in mv. optional V_divider(2), Vref(default 2400) and ADC bits(4096) and <br/>e.g.:Battery_Setup 1500 3000 2 2400 4096 | File: drv/drv_battery.c<br/>Function: Battery_Setup |
| Battery_cycle | [int] | change cycle of measurement by default every 10 seconds<br/>e.g.:Battery_Setup 60 | File: drv/drv_battery.c<br/>Function: Battery_cycle |
| PowerMax | BL0937_PowerMax | | File: driver/drv_bl0937.c<br/>Function: NULL); |
| 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. | File: driver/drv_bl_shared.c<br/>Function: BL09XX_ResetEnergyCounter |
| SetupEnergyStats | [Enable1or0][SampleTime][SampleCount][JSonEnable] | Setup Energy Statistic Parameters: [enable<0|1>] [sample_time<10..900>] [sample_count<10..180>] [JsonEnable<0|1>]. JSONEnable is optional. | File: driver/drv_bl_shared.c<br/>Function: BL09XX_SetupEnergyStatistic |
| ConsumptionThreshold | [FloatValue] | Setup value for automatic save of consumption data [1..100] | File: driver/drv_bl_shared.c<br/>Function: BL09XX_SetupConsumptionThreshold |
| 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) | File: driver/drv_bl_shared.c<br/>Function: BL09XX_VCPPublishThreshold |
| 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. | File: driver/drv_bl_shared.c<br/>Function: BL09XX_VCPPrecision |
| 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 | File: driver/drv_bl_shared.c<br/>Function: BL09XX_VCPPublishIntervals |
| 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 | File: driver/drv_bp1658cj.c<br/>Function: BP1658CJ_RGBCW |
| 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 | File: driver/drv_bp1658cj.c<br/>Function: BP1658CJ_Map |
| BP1658CJ_Current | [MaxCurrentRGB][MaxCurrentCW] | Sets the maximum current limit for BP1658CJ driver. | File: driver/drv_bp1658cj.c<br/>Function: BP1658CJ_Current |
| 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 | File: driver/drv_bp5758d.c<br/>Function: BP5758D_RGBCW |
| 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 | File: driver/drv_bp5758d.c<br/>Function: BP5758D_Map |
| BP5758D_Current | [MaxCurrentRGB][MaxCurrentCW] | Sets the maximum current limit for BP5758D driver, first value is for rgb and second for cw | File: driver/drv_bp5758d.c<br/>Function: BP5758D_Current |
| BridgePulseLength | [FloatValue] | Setup value for bridge pulse len | File: driver/drv_bridge_driver.c<br/>Function: Bridge_Pulse_length |
| CHT_Calibrate | | Calibrate the CHT Sensor as Tolerance is +/-2 degrees C.<br/>e.g.:SHT_Calibrate -4 10 | File: driver/drv_cht8305.c<br/>Function: CHT_Calibrate |
| 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 | File: drv/drv_doorSensorWithDeepSleep.c<br/>Function: DoorDeepSleep_SetTime |
| setButtonColor | [ButtonIndex][Color] | Sets the colour of custom scriptable HTTP page button | File: driver/drv_httpButtons.c<br/>Function: CMD_setButtonColor |
| setButtonCommand | [ButtonIndex][Command] | Sets the command of custom scriptable HTTP page button | File: driver/drv_httpButtons.c<br/>Function: CMD_setButtonCommand |
| setButtonLabel | [ButtonIndex][Label] | Sets the label of custom scriptable HTTP page button | File: driver/drv_httpButtons.c<br/>Function: CMD_setButtonLabel |
| setButtonEnabled | [ButtonIndex][1or0] | Sets the visibility of custom scriptable HTTP page button | File: driver/drv_httpButtons.c<br/>Function: CMD_setButtonEnabled |
| IRSend | [PROT-ADDR-CMD-REP] | Sends IR commands in the form PROT-ADDR-CMD-REP, e.g. NEC-1-1A-0 | File: driver/drv_ir.cpp<br/>Function: IR_Send_Cmd |
| 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 | File: cmnds/cmd_main.c<br/>Function: CMD_If |
| 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 | File: driver/drv_ir.cpp<br/>Function: IR_Enable |
| startDriver | [DriverName] | Starts driver | File: driver/drv_main.c<br/>Function: DRV_Start |
| stopDriver | [DriverName] | Stops driver | File: driver/drv_main.c<br/>Function: DRV_Stop |
| MAX72XX_Setup | [Value] | Sets the maximum current for LED driver. | File: driver/drv_sm2135.c<br/>Function: SM2135_Current |
| MAX72XX_Scroll | DRV_MAX72XX_Scroll | | File: driver/drv_max72xx_single.c<br/>Function: NULL); |
| MAX72XX_Print | DRV_MAX72XX_Print | | File: driver/drv_max72xx_single.c<br/>Function: NULL); |
| 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. | File: driver/drv_ntp.c<br/>Function: NTP_SetTimeZoneOfs |
| ntp_setServer | [ServerIP] | Sets the NTP server | File: driver/drv_ntp.c<br/>Function: NTP_SetServer |
| ntp_info | | Display NTP related settings | File: driver/drv_ntp.c<br/>Function: NTP_Info |
| 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 | File: driver/drv_ntp_events.c<br/>Function: CMD_NTP_AddClockEvent |
| removeClockEvent | [ID] | Removes clock event wtih given ID | File: driver/drv_ntp_events.c<br/>Function: CMD_NTP_RemoveClockEvent |
| listClockEvents | | Print the complete set clock events list | File: driver/drv_ntp_events.c<br/>Function: CMD_NTP_ListEvents |
| clearClockEvents | | Removes all set clock events | File: driver/drv_ntp_events.c<br/>Function: CMD_NTP_ClearEvents |
| toggler_enable | [1or0] | Sets the given output ON or OFF. handles toggler_enable0, toggler_enable1, etc | File: driver/drv_pwmToggler.c<br/>Function: Toggler_EnableX |
| 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. | File: driver/drv_pwmToggler.c<br/>Function: Toggler_SetX |
| toggler_channel | [ChannelIndex] | handles toggler_channel0, toggler_channel1. Sets channel linked to given toggler slot. | File: driver/drv_pwmToggler.c<br/>Function: Toggler_ChannelX |
| toggler_name | | Handles toggler_name0, toggler_name1, etc. Sets the name of a toggler for GUI. | File: driver/drv_pwmToggler.c<br/>Function: Toggler_NameX |
| 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. | File: driver/drv_pwrCal.c<br/>Function: NULL); |
| 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. | File: driver/drv_pwrCal.c<br/>Function: NULL); |
| 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. | File: driver/drv_pwrCal.c<br/>Function: NULL); |
| SGP_cycle | [int] | change cycle of measurement by default every 10 seconds 0 to deactivate<br/>e.g.:SGP_Cycle 60 | File: drv/drv_sgp.c<br/>Function: SGP_cycle |
| SGP_GetVersion | | SGP : get version<br/>e.g.:SGP_GetVersion | File: drv/drv_sgp.c<br/>Function: SGP_GetVersion |
| SGP_GetBaseline | | SGP Get baseline<br/>e.g.:SGP_GetBaseline | File: drv/drv_sgp.c<br/>Function: SGP_GetBaseline |
| SGP_SoftReset | | SGP i2C soft reset<br/>e.g.:SGP_SoftReset | File: drv/drv_sgp.c<br/>Function: SGP_SoftReset |
| SHT_cycle | [int] | change cycle of measurement by default every 10 seconds 0 to deactivate<br/>e.g.:SHT_Cycle 60 | File: drv/drv_sht3x.c<br/>Function: SHT_cycle |
| SHT_Calibrate | | Calibrate the SHT Sensor as Tolerance is +/-2 degrees C.<br/>e.g.:SHT_Calibrate -4 10 | File: driver/drv_sht3x.c<br/>Function: SHT3X_Calibrate |
| SHT_MeasurePer | | Retrieve Periodical measurement for SHT<br/>e.g.:SHT_Measure | File: driver/drv_sht3x.c<br/>Function: SHT3X_MeasurePer |
| SHT_LaunchPer | [msb][lsb] | Launch/Change periodical capture for SHT Sensor<br/>e.g.:SHT_LaunchPer 0x23 0x22 | File: driver/drv_sht3x.c<br/>Function: SHT3X_ChangePer |
| SHT_StopPer | | Stop periodical capture for SHT Sensor | File: driver/drv_sht3x.c<br/>Function: SHT3X_StopPerCmd |
| SHT_Measure | | Retrieve OneShot measurement for SHT<br/>e.g.:SHT_Measure | File: driver/drv_sht3x.c<br/>Function: SHT3X_Measure |
| SHT_Heater | | Activate or Deactivate Heater (0 / 1)<br/>e.g.:SHT_Heater 1 | File: driver/drv_sht3x.c<br/>Function: SHT3X_Heater |
| SHT_GetStatus | | Get Sensor Status<br/>e.g.:SHT_GetStatusCmd | File: driver/drv_sht3x.c<br/>Function: SHT3X_GetStatus |
| SHT_ClearStatus | | Clear Sensor Status<br/>e.g.:SHT_ClearStatusCmd | File: driver/drv_sht3x.c<br/>Function: SHT3X_ClearStatus |
| SHT_ReadAlert | | Get Sensor alert configuration<br/>e.g.:SHT_ReadAlertCmd | File: driver/drv_sht3x.c<br/>Function: SHT3X_ReadAlertcmd |
| SHT_SetAlert | [temp_high, temp_low, hum_high, hum_low]<br/>Req:all | Set Sensor alert configuration<br/>e.g.:SHT_SetAlertCmd | File: driver/drv_sht3x.c<br/>Function: SHT3X_SetAlertcmd |
| SM16703P_Test | | qq | File: driver/drv_ucs1912.c<br/>Function: SM16703P_Test |
| SM16703P_Send | | NULL | File: driver/drv_sm16703P.c<br/>Function: SM16703P_Send_Cmd |
| SM16703P_Test_3xZero | | NULL | File: driver/drv_sm16703P.c<br/>Function: SM16703P_Test_3xZero |
| SM16703P_Test_3xOne | | NULL | File: driver/drv_sm16703P.c<br/>Function: SM16703P_Test_3xOne |
| 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 | File: driver/drv_sm2135.c<br/>Function: SM2135_RGBCW |
| 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 | File: driver/drv_sm2135.c<br/>Function: SM2135_Map |
| 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](https://www.elektroda.com/rtvforum/viewtopic.php?p=20493415#20493415) | File: driver/drv_sm2135.c<br/>Function: SM2135_Current |
| 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 | File: driver/drv_sm2235.c<br/>Function: SM2235_RGBCW |
| 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 | File: driver/drv_sm2235.c<br/>Function: SM2235_Map |
| SM2235_Current | [Value] | Sets the maximum current for LED driver. | File: driver/drv_sm2235.c<br/>Function: SM2235_Current |
| SPITestFlash_ReadID | CMD_SPITestFlash_ReadID | | File: cmnds/cmd_main.c<br/>Function: NULL); |
| SPITestFlash_WriteStr | CMD_SPITestFlash_WriteStr | | File: driver/drv_spi_flash.c<br/>Function: NULL); |
| SPITestFlash_Erase | CMD_SPITestFlash_Erase | | File: driver/drv_spi_flash.c<br/>Function: NULL); |
| SPITestFlash_ReadData | CMD_SPITestFlash_ReadData | | File: cmnds/cmd_main.c<br/>Function: NULL); |
| obkDeviceList | | Generate the SSDP list of OpenBeken devices found on the network. | File: driver/drv_ssdp.c<br/>Function: Cmd_obkDeviceList |
| 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. | File: driver/drv_tasmotaDeviceGroups.c<br/>Function: CMD_DGR_SendPower |
| 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. | File: driver/drv_tasmotaDeviceGroups.c<br/>Function: CMD_DGR_SendBrightness |
| 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. | File: driver/drv_tasmotaDeviceGroups.c<br/>Function: CMD_DGR_SendRGBCW |
| 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. | File: driver/drv_tasmotaDeviceGroups.c<br/>Function: CMD_DGR_SendFixedColor |
| SetupTestPower | | NULL | File: driver/drv_test_drivers.c<br/>Function: TestPower_Setup |
| TMGN_SetBit | [CharIndex] [BitIndex] [BitValue] | Set given bit of given digit to 1 or 0. | File: driver/drv_tm1637.c<br/>Function: NULL); |
| TMGN_Clear | | This clears the TM1637/GN932/etc display | File: driver/drv_tm_gn_display_shared.c<br/>Function: NULL); |
| 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 | File: driver/drv_tm1637.c<br/>Function: NULL); |
| TMGN_Print | [StartOfs] [MaxLenOr0] [StringText] [optionalBClampWithZeroesForClock] | This allows you to print string on TM1637/GN932/etc display, it supports variables expansion | File: driver/drv_tm_gn_display_shared.c<br/>Function: NULL); |
| TMGN_Test | CMD_TM1637_Test | | File: driver/drv_tm_gn_display_shared.c<br/>Function: NULL); |
| TMGN_Brightness | [Brigthness0to7][bOn] | This allows you to change brightness and state of TM1637/GN932/etc display | File: driver/drv_tm_gn_display_shared.c<br/>Function: NULL); |
| 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. | File: driver/drv_tm_gn_display_shared.c<br/>Function: NULL); |
| TM1650_Test | CMD_TM1650_Test | | File: driver/drv_tm1637.c<br/>Function: NULL); |
| TMGN_Read | CMD_TMGN_Read | | File: driver/drv_tm1637.c<br/>Function: NULL); |
| TMGN_SetupButtons | CMD_TMGN_SetupButtons | | File: driver/drv_tm1637.c<br/>Function: NULL); |
| tuyaMcu_testSendTime | | Sends a example date by TuyaMCU to clock/callendar MCU | File: driver/drv_tuyaMCU.c<br/>Function: TuyaMCU_Send_SetTime_Example |
| 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. | File: driver/drv_tuyaMCU.c<br/>Function: TuyaMCU_Send_SetTime_Current |
| 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](https://developer.tuya.com/en/docs/iot/tuya-cloud-universal-serial-port-access-protocol?id=K9hhi0xxtn9cb) for info about TuyaMCU. You can also see our [TuyaMCU Analyzer Tool](https://www.elektroda.com/rtvforum/viewtopic.php?p=20528459#20528459) | File: driver/drv_tuyaMCU.c<br/>Function: TuyaMCU_LinkTuyaMCUOutputToChannel |
| tuyaMcu_setDimmerRange | [Min][Max] | Set dimmer range used by TuyaMCU | File: driver/drv_tuyaMCU.c<br/>Function: TuyaMCU_SetDimmerRange |
| tuyaMcu_sendHeartbeat | | Send heartbeat to TuyaMCU | File: driver/drv_tuyaMCU.c<br/>Function: TuyaMCU_SendHeartbeat |
| tuyaMcu_sendQueryState | | Send query state command. No arguments needed. | File: driver/drv_tuyaMCU.c<br/>Function: TuyaMCU_SendQueryState |
| tuyaMcu_sendProductInformation | | Send query packet (0x01). No arguments needed. | File: driver/drv_tuyaMCU.c<br/>Function: TuyaMCU_SendQueryProductInformation |
| tuyaMcu_sendState | [dpID][dpType][dpValue] | Manually send set state command. Do not use it. Use mapping, so communication is bidirectional and automatic. | File: driver/drv_tuyaMCU.c<br/>Function: TuyaMCU_SendStateCmd |
| tuyaMcu_sendMCUConf | | Send MCU conf command | File: driver/drv_tuyaMCU.c<br/>Function: TuyaMCU_SendMCUConf |
| fakeTuyaPacket | [HexString] | This simulates packet being sent from TuyaMCU to our OBK device. | File: driver/drv_tuyaMCU.c<br/>Function: TuyaMCU_FakePacket |
| tuyaMcu_setBaudRate | [BaudValue] | Sets the baud rate used by TuyaMCU UART communication. Default value is 9600. Some other devices require 115200. | File: driver/drv_tuyaMCU.c<br/>Function: TuyaMCU_SetBaudRate |
| tuyaMcu_sendRSSI | | Command sends the specific RSSI value to TuyaMCU (it will send current RSSI if no argument is set) | File: driver/drv_tuyaMCU.c<br/>Function: Cmd_TuyaMCU_Send_RSSI |
| 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](https://www.elektroda.com/rtvforum/viewtopic.php?p=20483899#20483899). | File: driver/drv_tuyaMCU.c<br/>Function: Cmd_TuyaMCU_Send_RSSI |
| uartSendHex | [HexString] | Sends raw data by UART, can be used to send TuyaMCU data, but you must write whole packet with checksum yourself | File: driver/drv_tuyaMCU.c<br/>Function: CMD_UART_Send_Hex |
| uartSendASCII | [AsciiString] | Sends given string by UART. | File: driver/drv_uart.c<br/>Function: CMD_UART_Send_ASCII |
| uartFakeHex | [HexString] | Spoofs a fake hex packet so it looks like TuyaMCU send that to us. Used for testing. | File: driver/drv_uart.c<br/>Function: CMD_UART_FakeHex |
| 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. | File: driver/drv_uart.c<br/>Function: CMD_UART_Init |
| UCS1912_Test | | | File: driver/drv_ucs1912.c<br/>Function: UCS1912_Test |
| IRSend | [PROT-ADDR-CMD-REP] | Sends IR commands in the form PROT-ADDR-CMD-REP, e.g. NEC-1-1A-0 | File: driver/drv_ir.cpp<br/>Function: IR_Send_Cmd |
| json_test | cmnd_json_test | | File: cmnds/cmd_test.c<br/>Function: NULL); |
| lcd_clear | | Clears the LCD | File: i2c/drv_i2c_lcd_pcf8574t.c<br/>Function: DRV_I2C_LCD_PCF8574_Clear |
| lcd_clearAndGoto | | Clears LCD and go to pos | File: i2c/drv_i2c_lcd_pcf8574t.c<br/>Function: DRV_I2C_LCD_PCF8574_ClearAndGoTo |
| lcd_goto | | Go to position on LCD | File: i2c/drv_i2c_lcd_pcf8574t.c<br/>Function: DRV_I2C_LCD_PCF8574_GoTo |
| lcd_print | | Prints a string on the LCD | File: i2c/drv_i2c_lcd_pcf8574t.c<br/>Function: DRV_I2C_LCD_PCF8574_Print |
| lcd_printFloat | | Prints a float on the LCD | File: i2c/drv_i2c_lcd_pcf8574t.c<br/>Function: DRV_I2C_LCD_PCF8574_PrintFloat |
| lcd_printInt | | Prints an omt on the LCD | File: i2c/drv_i2c_lcd_pcf8574t.c<br/>Function: DRV_I2C_LCD_PCF8574_PrintInt |
| lcd_clear | | Clears the LCD | File: i2c/drv_i2c_lcd_pcf8574t.c<br/>Function: DRV_I2C_LCD_PCF8574_Clear |
| addI2CDevice_TC74 | | Adds a new I2C device - TC74 | File: i2c/drv_i2c_main.c<br/>Function: DRV_I2C_AddDevice_TC74 |
| addI2CDevice_MCP23017 | | Adds a new I2C device - MCP23017 | File: i2c/drv_i2c_main.c<br/>Function: DRV_I2C_AddDevice_MCP23017 |
| addI2CDevice_LCM1602 | | Adds a new I2C device - LCM1602 | File: i2c/drv_i2c_main.c<br/>Function: DRV_I2C_AddDevice_LCM1602 |
| addI2CDevice_LCD_PCF8574 | | Adds a new I2C device - PCF8574 | File: i2c/drv_i2c_main.c<br/>Function: DRV_I2C_AddDevice_PCF8574 |
| MCP23017_MapPinToChannel | | Maps port expander bit to OBK channel | File: i2c/drv_i2c_main.c<br/>Function: DRV_I2C_MCP23017_MapPinToChannel |
| scanI2C | | | File: i2c/drv_i2c_main.c<br/>Function: DRV_I2C_MCP23017_MapPinToChannel |
| lfs_size | [MaxSize] | Log or Set LFS size - will apply and re-format next boot, usage setlfssize 0x10000 | File: littlefs/our_lfs.c<br/>Function: CMD_LFS_Size |
| lfs_unmount | | Un-mount LFS | File: littlefs/our_lfs.c<br/>Function: CMD_LFS_Unmount |
| lfs_mount | | Mount LFS | File: littlefs/our_lfs.c<br/>Function: CMD_LFS_Mount |
| lfs_format | | Unmount and format LFS. Optionally add new size as argument | File: littlefs/our_lfs.c<br/>Function: CMD_LFS_Format |
| led_basecolor_rgb | [HexValue] | Puts the LED driver in RGB mode and sets given color. | File: cmnds/cmd_newLEDDriver.c<br/>Function: basecolor_rgb |
| led_basecolor_rgbcw | | set PWN color using #RRGGBB[cw][ww] | File: cmnds/cmd_newLEDDriver.c<br/>Function: basecolor_rgbcw |
| led_colorMult | [Value] | Internal usage. | File: cmnds/cmd_newLEDDriver.c<br/>Function: colorMult |
| led_dimmer | [Value] | set output dimmer 0..100 | File: cmnds/cmd_newLEDDriver.c<br/>Function: dimmer |
| led_enableAll | [1or0orToggle] | Power on/off LED but remember the RGB(CW) values | File: cmnds/cmd_newLEDDriver.c<br/>Function: enableAll |
| 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. | File: cmnds/cmd_newLEDDriver.c<br/>Function: led_finishFullLerp |
| led_gammaCtrl | sub-cmd [par] | control LED Gamma Correction and Calibration<br/>e.g.:led_gammaCtrl on | File: cmnds/cmd_rgbGamma.c<br/>Function: rgb_gamma_control |
| led_hue | [Value] | This is an alternate way to set the LED color. | File: cmnds/cmd_newLEDDriver.c<br/>Function: setHue |
| 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 | File: cmnds/cmd_newLEDDriver.c<br/>Function: lerpSpeed |
| led_nextColor | | Sets the next color from predefined colours list. Our list is the same as in Tasmota. | File: cmnds/cmd_newLEDDriver.c<br/>Function: nextColor |
| led_saturation | [Value] | This is an alternate way to set the LED color. | File: cmnds/cmd_newLEDDriver.c<br/>Function: setSaturation |
| 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. | File: cmnds/cmd_newLEDDriver.c<br/>Function: cmdSaveStateIfModifiedInterval |
| 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) | File: cmnds/cmd_newLEDDriver.c<br/>Function: temperature |
| lfs_append | [FileName][String] | Appends a string to LFS file | File: cmnds/cmd_main.c<br/>Function: CMD_LFS_Append |
| lfs_appendFloat | [FileName][Float] | Appends a float to LFS file | File: cmnds/cmd_main.c<br/>Function: CMD_LFS_AppendFloat |
| lfs_appendInt | [FileName][Int] | Appends a Int to LFS file | File: cmnds/cmd_main.c<br/>Function: CMD_LFS_AppendInt |
| lfs_appendLine | [FileName][String] | Appends a string to LFS file with a next line marker | File: cmnds/cmd_main.c<br/>Function: CMD_LFS_AppendLine |
| lfs_format | | Unmount and format LFS. Optionally add new size as argument | File: littlefs/our_lfs.c<br/>Function: CMD_LFS_Format |
| lfs_mount | | Mount LFS | File: littlefs/our_lfs.c<br/>Function: CMD_LFS_Mount |
| lfs_remove | [FileName] | Deletes a LittleFS file | File: cmnds/cmd_main.c<br/>Function: CMD_LFS_Remove |
| lfs_size | [MaxSize] | Log or Set LFS size - will apply and re-format next boot, usage setlfssize 0x10000 | File: littlefs/our_lfs.c<br/>Function: CMD_LFS_Size |
| lfs_test1 | [FileName] | Tests the LFS file reading feature. | File: cmnds/cmd_tasmota.c<br/>Function: cmnd_lfs_test1 |
| lfs_test2 | [FileName] | Tests the LFS file reading feature. | File: cmnds/cmd_tasmota.c<br/>Function: cmnd_lfs_test2 |
| lfs_test3 | [FileName] | Tests the LFS file reading feature. | File: cmnds/cmd_tasmota.c<br/>Function: cmnd_lfs_test3 |
| lfs_unmount | | Un-mount LFS | File: littlefs/our_lfs.c<br/>Function: CMD_LFS_Unmount |
| lfs_write | [FileName][String] | Resets a LFS file and writes a new string to it | File: cmnds/cmd_main.c<br/>Function: CMD_LFS_Write |
| lfs_writeLine | [FileName][String] | Resets a LFS file and writes a new string to it with newline | File: cmnds/cmd_main.c<br/>Function: CMD_LFS_WriteLine |
| 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 | File: logging/logging.c<br/>Function: log_command |
| logfeature | [Index][1or0] | set log feature filter, as an index and a 1 or 0 | File: logging/logging.c<br/>Function: log_command |
| logtype | [TypeStr] | logtype direct|thread|none - type of serial logging - thread (in a thread; default), direct (logged directly to serial), none (no UART logging) | File: logging/logging.c<br/>Function: log_command |
| 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](https://developer.tuya.com/en/docs/iot/tuya-cloud-universal-serial-port-access-protocol?id=K9hhi0xxtn9cb) for info about TuyaMCU. You can also see our [TuyaMCU Analyzer Tool](https://www.elektroda.com/rtvforum/viewtopic.php?p=20528459#20528459) | File: driver/drv_tuyaMCU.c<br/>Function: TuyaMCU_LinkTuyaMCUOutputToChannel |
| listClockEvents | | Print the complete set clock events list | File: driver/drv_ntp_events.c<br/>Function: CMD_NTP_ListEvents |
| listEventHandlers | | Prints full list of added event handlers | File: cmnds/cmd_eventHandlers.c<br/>Function: CMD_ListEventHandlers |
| listRepeatingEvents | | lists all repeating events | File: cmnds/cmd_repeatingEvents.c<br/>Function: RepeatingEvents_Cmd_ListRepeatingEvents |
| listScripts | | Lists all running scripts. | File: cmnds/cmd_script.c<br/>Function: CMD_ListScripts |
| 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. | File: logging/logging.c<br/>Function: log_command |
| logfeature | [Index][1or0] | set log feature filter, as an index and a 1 or 0 | File: logging/logging.c<br/>Function: log_command |
| 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 | File: logging/logging.c<br/>Function: log_command |
| 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.. | File: logging/logging.c<br/>Function: log_port |
| 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 | File: mqtt/new_mqtt.c<br/>Function: MQTT_PublishCommand |
| 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. | File: mqtt/new_mqtt.c<br/>Function: MQTT_PublishCommand |
| 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. | File: mqtt/new_mqtt.c<br/>Function: MQTT_PublishCommand |
| publishAll | | Starts the step by step publish of all available values | File: mqtt/new_mqtt.c<br/>Function: MQTT_PublishAll |
| publishChannel | [ChannelIndex] | Forces publish of given channel | File: mqtt/new_mqtt.c<br/>Function: MQTT_PublishChannel |
| publishChannels | | Starts the step by step publish of all channel values | File: mqtt/new_mqtt.c<br/>Function: MQTT_PublishChannels |
| publishBenchmark | | | File: mqtt/new_mqtt.c<br/>Function: MQTT_StartMQTTTestThread |
| logtype | [TypeStr] | logtype direct|thread|none - type of serial logging - thread (in a thread; default), direct (logged directly to serial), none (no UART logging) | File: logging/logging.c<br/>Function: log_command |
| Map | [TargetChannel][InputValue][InMin][InMax][OutMin][OutMax] | Used to convert a value from one range into a proportional value of another range. | File: cmnds/cmd_channels.c<br/>Function: CMD_Map |
| 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 | File: cmnds/cmd_channels.c<br/>Function: CMD_MapRanges |
| MAX72XX_Print | DRV_MAX72XX_Print | | File: driver/drv_max72xx_single.c<br/>Function: NULL); |
| MAX72XX_Scroll | DRV_MAX72XX_Scroll | | File: driver/drv_max72xx_single.c<br/>Function: NULL); |
| MAX72XX_Setup | [Value] | Sets the maximum current for LED driver. | File: driver/drv_sm2135.c<br/>Function: SM2135_Current |
| MCP23017_MapPinToChannel | | Maps port expander bit to OBK channel | File: i2c/drv_i2c_main.c<br/>Function: DRV_I2C_MCP23017_MapPinToChannel |
| MqttClient | [ValueString] | Sets the MQTT client. Command keeps Tasmota syntax | File: cmnds/cmd_tasmota.c<br/>Function: cmnd_MqttClient |
| MqttHost | [ValueString] | Sets the MQTT host. Command keeps Tasmota syntax | File: cmnds/cmd_tasmota.c<br/>Function: cmnd_MqttHost |
| MqttPassword | [ValueString] | Sets the MQTT pass. Command keeps Tasmota syntax | File: cmnds/cmd_tasmota.c<br/>Function: cmnd_MqttPassword |
| MqttUser | [ValueString] | Sets the MQTT user. Command keeps Tasmota syntax | File: cmnds/cmd_tasmota.c<br/>Function: cmnd_MqttUser |
| 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. | File: mqtt/new_mqtt.c<br/>Function: MQTT_SetBroadcastInterval |
| 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. | File: mqtt/new_mqtt.c<br/>Function: MQTT_SetMaxBroadcastItemsPublishedPerSecond |
| 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. | File: mqtt/new_mqtt.c<br/>Function: MQTT_SetTasTeleIntervals |
| showgpi | NULL | log stat of all GPIs | File: new_pins.c<br/>Function: showgpi |
| setChannelType | [ChannelIndex][TypeString] | Sets a custom type for channel. Types are mostly used to determine how to display channel value on GUI | File: new_pins.c<br/>Function: CMD_SetChannelType |
| showChannelValues | | log channel values | File: new_pins.c<br/>Function: CMD_ShowChannelValues |
| setButtonTimes | [ValLongPress][ValShortPress][ValRepeat] | Each value is times 100ms, so: SetButtonTimes 2 1 1 means 200ms long press, 100ms short and 100ms repeat | File: new_pins.c<br/>Function: CMD_SetButtonTimes |
| ntp_info | | Display NTP related settings | File: driver/drv_ntp.c<br/>Function: NTP_Info |
| ntp_setServer | [ServerIP] | Sets the NTP server | File: driver/drv_ntp.c<br/>Function: NTP_SetServer |
| 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. | File: driver/drv_ntp.c<br/>Function: NTP_SetTimeZoneOfs |
| obkDeviceList | | Generate the SSDP list of OpenBeken devices found on the network. | File: driver/drv_ssdp.c<br/>Function: Cmd_obkDeviceList |
| OpenAP | | Temporarily disconnects from programmed WiFi network and opens Access Point | File: cmnds/cmd_main.c<br/>Function: CMD_OpenAP |
| 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) | File: cmnds/cmd_main.c<br/>Function: CMD_HTTPOTA |
| Password1 | [ValueString] | Sets the Pass of target WiFi. Command keeps Tasmota syntax | File: cmnds/cmd_tasmota.c<br/>Function: cmnd_Password1 |
| PinDeepSleep | | Starts a pin deep sleep (deep sleep that can be interrupted by external IO events like a button press) | File: cmnds/cmd_channels.c<br/>Function: CMD_PinDeepSleep |
| PingHost | [IPStr] | Sets the host to ping by IP watchdog | File: cmnds/cmd_main.c<br/>Function: CMD_PingHost |
| PingInterval | [IntegerSeconds] | Sets the interval between ping attempts for ping watchdog mechanism | File: cmnds/cmd_main.c<br/>Function: CMD_PingInterval |
| 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. | File: cmnds/cmd_tasmota.c<br/>Function: power |
| powerAll | | set all outputs | File: cmnds/cmd_tasmota.c<br/>Function: powerAll |
| PowerMax | BL0937_PowerMax | | File: driver/drv_bl0937.c<br/>Function: NULL); |
| 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. | File: cmnds/cmd_main.c<br/>Function: CMD_PowerSave |
| 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. | File: driver/drv_pwrCal.c<br/>Function: NULL); |
| 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 | File: mqtt/new_mqtt.c<br/>Function: MQTT_PublishCommand |
| publishAll | | Starts the step by step publish of all available values | File: mqtt/new_mqtt.c<br/>Function: MQTT_PublishAll |
| publishBenchmark | | | File: mqtt/new_mqtt.c<br/>Function: MQTT_StartMQTTTestThread |
| publishChannel | [ChannelIndex] | Forces publish of given channel | File: mqtt/new_mqtt.c<br/>Function: MQTT_PublishChannel |
| publishChannels | | Starts the step by step publish of all channel values | File: mqtt/new_mqtt.c<br/>Function: MQTT_PublishChannels |
| 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. | File: mqtt/new_mqtt.c<br/>Function: MQTT_PublishCommand |
| 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. | File: mqtt/new_mqtt.c<br/>Function: MQTT_PublishCommand |
| reboot | | Same as restart. Needed for bkWriter 1.60 which sends 'reboot' cmd before trying to get bus | File: cmnds/cmd_main.c<br/>Function: CMD_Restart |
| removeClockEvent | [ID] | Removes clock event wtih given ID | File: driver/drv_ntp_events.c<br/>Function: CMD_NTP_RemoveClockEvent |
| resetSVM | | Resets all SVM and clears all scripts. | File: cmnds/cmd_script.c<br/>Function: CMD_resetSVM |
| restart | | Reboots the module | File: cmnds/cmd_main.c<br/>Function: CMD_Restart |
| return | | Script-only command. Currently it just stops totally current script thread. | File: cmnds/cmd_script.c<br/>Function: CMD_Return |
| SafeMode | | Forces device reboot into safe mode (open ap with disabled drivers) | File: cmnds/cmd_main.c<br/>Function: CMD_SafeMode |
| scanI2C | | | File: i2c/drv_i2c_main.c<br/>Function: DRV_I2C_MCP23017_MapPinToChannel |
| 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. | File: cmnds/cmd_main.c<br/>Function: CMD_ScheduleHADiscovery |
| 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. | File: cmnds/cmd_send.c<br/>Function: CMD_SendGET |
| sendPOST | CMD_SendPOST | | File: cmnds/cmd_send.c<br/>Function: NULL); |
| setButtonColor | [ButtonIndex][Color] | Sets the colour of custom scriptable HTTP page button | File: driver/drv_httpButtons.c<br/>Function: CMD_setButtonColor |
| setButtonCommand | [ButtonIndex][Command] | Sets the command of custom scriptable HTTP page button | File: driver/drv_httpButtons.c<br/>Function: CMD_setButtonCommand |
| setButtonEnabled | [ButtonIndex][1or0] | Sets the visibility of custom scriptable HTTP page button | File: driver/drv_httpButtons.c<br/>Function: CMD_setButtonEnabled |
| setButtonHoldRepeat | [Value] | Sets just the hold button repeat time, given value is times 100ms, so write 1 for 100ms, 2 for 200ms, etc | File: new_pins.c<br/>Function: CMD_setButtonHoldRepeat |
| setButtonLabel | [ButtonIndex][Label] | Sets the label of custom scriptable HTTP page button | File: driver/drv_httpButtons.c<br/>Function: CMD_setButtonLabel |
| setButtonTimes | [ValLongPress][ValShortPress][ValRepeat] | Each value is times 100ms, so: SetButtonTimes 2 1 1 means 200ms long press, 100ms short and 100ms repeat | File: new_pins.c<br/>Function: CMD_SetButtonTimes |
| 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. | File: cmnds/cmd_channels.c<br/>Function: CMD_SetChannel |
| SetChannelFloat | [ChannelIndex][ChannelValue] | Sets a raw channel to given float value. Currently only used for LED PWM channels. | File: cmnds/cmd_channels.c<br/>Function: CMD_SetChannelFloat |
| 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 | File: cmnds/cmd_channels.c<br/>Function: CMD_SetChannelLabel |
| setChannelType | [ChannelIndex][TypeString] | Sets a custom type for channel. Types are mostly used to determine how to display channel value on GUI | File: new_pins.c<br/>Function: CMD_SetChannelType |
| 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... | File: cmnds/cmd_channels.c<br/>Function: CMD_SetChannelVisible |
| SetFlag | [FlagIndex][0or1] | Sets given flag | File: cmnds/cmd_main.c<br/>Function: CMD_SetFlag |
| 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. | File: cmnds/cmd_channels.c<br/>Function: CMD_SetPinChannel |
| 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. | File: cmnds/cmd_channels.c<br/>Function: CMD_SetPinRole |
| 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' | File: cmnds/cmd_main.c<br/>Function: CMD_SetStartValue |
| SetupEnergyStats | [Enable1or0][SampleTime][SampleCount][JSonEnable] | Setup Energy Statistic Parameters: [enable<0|1>] [sample_time<10..900>] [sample_count<10..180>] [JsonEnable<0|1>]. JSONEnable is optional. | File: driver/drv_bl_shared.c<br/>Function: BL09XX_SetupEnergyStatistic |
| SetupTestPower | | NULL | File: driver/drv_test_drivers.c<br/>Function: TestPower_Setup |
| SGP_cycle | [int] | change cycle of measurement by default every 10 seconds 0 to deactivate<br/>e.g.:SGP_Cycle 60 | File: drv/drv_sgp.c<br/>Function: SGP_cycle |
| SGP_GetBaseline | | SGP Get baseline<br/>e.g.:SGP_GetBaseline | File: drv/drv_sgp.c<br/>Function: SGP_GetBaseline |
| SGP_GetVersion | | SGP : get version<br/>e.g.:SGP_GetVersion | File: drv/drv_sgp.c<br/>Function: SGP_GetVersion |
| SGP_SoftReset | | SGP i2C soft reset<br/>e.g.:SGP_SoftReset | File: drv/drv_sgp.c<br/>Function: SGP_SoftReset |
| ShortName | [Name] | Sets the short name of the device. | File: cmnds/cmd_channels.c<br/>Function: CMD_ShortName |
| showChannelValues | | log channel values | File: new_pins.c<br/>Function: CMD_ShowChannelValues |
| showgpi | NULL | log stat of all GPIs | File: new_pins.c<br/>Function: showgpi |
| SHT_Calibrate | | Calibrate the SHT Sensor as Tolerance is +/-2 degrees C.<br/>e.g.:SHT_Calibrate -4 10 | File: driver/drv_sht3x.c<br/>Function: SHT3X_Calibrate |
| SHT_ClearStatus | | Clear Sensor Status<br/>e.g.:SHT_ClearStatusCmd | File: driver/drv_sht3x.c<br/>Function: SHT3X_ClearStatus |
| SHT_cycle | [int] | This is the interval between measurements in seconds, by default 10. Max is 255.<br/>e.g.:SHT_Cycle 60 | File: drv/drv_sht3x.c<br/>Function: SHT_cycle |
| SHT_GetStatus | | Get Sensor Status<br/>e.g.:SHT_GetStatusCmd | File: driver/drv_sht3x.c<br/>Function: SHT3X_GetStatus |
| SHT_Heater | | Activate or Deactivate Heater (0 / 1)<br/>e.g.:SHT_Heater 1 | File: driver/drv_sht3x.c<br/>Function: SHT3X_Heater |
| SHT_LaunchPer | [msb][lsb] | Launch/Change periodical capture for SHT Sensor<br/>e.g.:SHT_LaunchPer 0x23 0x22 | File: driver/drv_sht3x.c<br/>Function: SHT3X_ChangePer |
| SHT_Measure | | Retrieve OneShot measurement for SHT<br/>e.g.:SHT_Measure | File: driver/drv_sht3x.c<br/>Function: SHT3X_Measure |
| SHT_MeasurePer | | Retrieve Periodical measurement for SHT<br/>e.g.:SHT_Measure | File: driver/drv_sht3x.c<br/>Function: SHT3X_MeasurePer |
| SHT_ReadAlert | | Get Sensor alert configuration<br/>e.g.:SHT_ReadAlertCmd | File: driver/drv_sht3x.c<br/>Function: SHT3X_ReadAlertcmd |
| SHT_SetAlert | [temp_high, temp_low, hum_high, hum_low]<br/>Req:all | Set Sensor alert configuration<br/>e.g.:SHT_SetAlertCmd | File: driver/drv_sht3x.c<br/>Function: SHT3X_SetAlertcmd |
| SHT_StopPer | | Stop periodical capture for SHT Sensor | File: driver/drv_sht3x.c<br/>Function: SHT3X_StopPerCmd |
| simonirtest | | Simons Special Test | File: cmnds/cmd_main.c<br/>Function: CMD_SimonTest |
| SM16703P_Send | | NULL | File: driver/drv_sm16703P.c<br/>Function: SM16703P_Send_Cmd |
| SM16703P_Test | | qq | File: driver/drv_ucs1912.c<br/>Function: SM16703P_Test |
| SM16703P_Test_3xOne | | NULL | File: driver/drv_sm16703P.c<br/>Function: SM16703P_Test_3xOne |
| SM16703P_Test_3xZero | | NULL | File: driver/drv_sm16703P.c<br/>Function: SM16703P_Test_3xZero |
| 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](https://www.elektroda.com/rtvforum/viewtopic.php?p=20493415#20493415) | File: driver/drv_sm2135.c<br/>Function: SM2135_Current |
| 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 | File: driver/drv_sm2135.c<br/>Function: SM2135_Map |
| 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 | File: driver/drv_sm2135.c<br/>Function: SM2135_RGBCW |
| SM2235_Current | [Value] | Sets the maximum current for LED driver. | File: driver/drv_sm2235.c<br/>Function: SM2235_Current |
| 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 | File: driver/drv_sm2235.c<br/>Function: SM2235_Map |
| 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 | File: driver/drv_sm2235.c<br/>Function: SM2235_RGBCW |
| SPITestFlash_Erase | CMD_SPITestFlash_Erase | | File: driver/drv_spi_flash.c<br/>Function: NULL); |
| SPITestFlash_ReadData | CMD_SPITestFlash_ReadData | | File: cmnds/cmd_main.c<br/>Function: NULL); |
| SPITestFlash_ReadID | CMD_SPITestFlash_ReadID | | File: cmnds/cmd_main.c<br/>Function: NULL); |
| SPITestFlash_WriteStr | CMD_SPITestFlash_WriteStr | | File: driver/drv_spi_flash.c<br/>Function: NULL); |
| SSID1 | [ValueString] | Sets the SSID of target WiFi. Command keeps Tasmota syntax. | File: cmnds/cmd_tasmota.c<br/>Function: cmnd_SSID1 |
| stackOverflow | | Causes a stack overflow | File: cmnds/cmd_main.c<br/>Function: CMD_StackOverflow |
| startDriver | [DriverName] | Starts driver | File: driver/drv_main.c<br/>Function: DRV_Start |
| startScript | [FileName][Label][UniqueID] | Starts a script thread from given file, at given label - can be * for whole file, with given unique ID | File: cmnds/cmd_script.c<br/>Function: CMD_StartScript |
| 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 | File: cmnds/cmd_main.c<br/>Function: CMD_StartupCommand |
| State | NULL | NULL | File: cmnds/cmd_tasmota.c<br/>Function: cmnd_State |
| stopAllScripts | | Stops all running scripts | File: cmnds/cmd_script.c<br/>Function: CMD_StopAllScripts |
| stopDriver | [DriverName] | Stops driver | File: driver/drv_main.c<br/>Function: DRV_Stop |
| stopScript | [UniqueID] | Force-stop given script thread by ID | File: cmnds/cmd_script.c<br/>Function: CMD_StopScript |
| 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. | File: mqtt/new_mqtt.c<br/>Function: MQTT_SetTasTeleIntervals |
| testArgs | | Test tokenizer for args and print back all the given args to console | File: cmnds/cmd_test.c<br/>Function: testArgs |
| testFloats | | Do some more test printfs with floating point numbers | File: cmnds/cmd_test.c<br/>Function: testFloats |
| testJSON | | Test the JSON library | File: cmnds/cmd_test.c<br/>Function: testJSON |
| testLog | | Do some test printfs to log with integer and a float | File: cmnds/cmd_test.c<br/>Function: testLog |
| testMallocFree | | Test malloc and free functionality to see if the device crashes | File: cmnds/cmd_test.c<br/>Function: testMallocFree |
| testRealloc | | Test realloc and free functions to see if the device crashes | File: cmnds/cmd_test.c<br/>Function: testRealloc |
| testStrdup | | Test strdup function to see if it allocs news string correctly, also test freeing the string | File: cmnds/cmd_test.c<br/>Function: testStrdup |
| TM1650_Test | CMD_TM1650_Test | | File: driver/drv_tm1637.c<br/>Function: NULL); |
| TMGN_Brightness | [Brigthness0to7][bOn] | This allows you to change brightness and state of TM1637/GN932/etc display | File: driver/drv_tm_gn_display_shared.c<br/>Function: NULL); |
| 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 | File: driver/drv_tm1637.c<br/>Function: NULL); |
| TMGN_Clear | | This clears the TM1637/GN932/etc display | File: driver/drv_tm_gn_display_shared.c<br/>Function: NULL); |
| 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. | File: driver/drv_tm_gn_display_shared.c<br/>Function: NULL); |
| TMGN_Print | [StartOfs] [MaxLenOr0] [StringText] [optionalBClampWithZeroesForClock] | This allows you to print string on TM1637/GN932/etc display, it supports variables expansion | File: driver/drv_tm_gn_display_shared.c<br/>Function: NULL); |
| TMGN_Read | CMD_TMGN_Read | | File: driver/drv_tm1637.c<br/>Function: NULL); |
| TMGN_SetBit | [CharIndex] [BitIndex] [BitValue] | Set given bit of given digit to 1 or 0. | File: driver/drv_tm1637.c<br/>Function: NULL); |
| TMGN_SetupButtons | CMD_TMGN_SetupButtons | | File: driver/drv_tm1637.c<br/>Function: NULL); |
| TMGN_Test | CMD_TM1637_Test | | File: driver/drv_tm_gn_display_shared.c<br/>Function: NULL); |
| ToggleChannel | [ChannelIndex] | Toggles given channel value. Non-zero becomes zero, zero becomes 1. | File: cmnds/cmd_channels.c<br/>Function: CMD_ToggleChannel |
| toggler_channel | [ChannelIndex] | handles toggler_channel0, toggler_channel1. Sets channel linked to given toggler slot. | File: driver/drv_pwmToggler.c<br/>Function: Toggler_ChannelX |
| toggler_enable | [1or0] | Sets the given output ON or OFF. handles toggler_enable0, toggler_enable1, etc | File: driver/drv_pwmToggler.c<br/>Function: Toggler_EnableX |
| toggler_name | | Handles toggler_name0, toggler_name1, etc. Sets the name of a toggler for GUI. | File: driver/drv_pwmToggler.c<br/>Function: Toggler_NameX |
| 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. | File: driver/drv_pwmToggler.c<br/>Function: Toggler_SetX |
| 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](https://www.elektroda.com/rtvforum/viewtopic.php?p=20483899#20483899). | File: driver/drv_tuyaMCU.c<br/>Function: Cmd_TuyaMCU_Send_RSSI |
| 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. | File: driver/drv_tuyaMCU.c<br/>Function: TuyaMCU_Send_SetTime_Current |
| tuyaMcu_sendHeartbeat | | Send heartbeat to TuyaMCU | File: driver/drv_tuyaMCU.c<br/>Function: TuyaMCU_SendHeartbeat |
| tuyaMcu_sendMCUConf | | Send MCU conf command | File: driver/drv_tuyaMCU.c<br/>Function: TuyaMCU_SendMCUConf |
| tuyaMcu_sendProductInformation | | Send query packet (0x01). No arguments needed. | File: driver/drv_tuyaMCU.c<br/>Function: TuyaMCU_SendQueryProductInformation |
| tuyaMcu_sendQueryState | | Send query state command. No arguments needed. | File: driver/drv_tuyaMCU.c<br/>Function: TuyaMCU_SendQueryState |
| tuyaMcu_sendRSSI | | Command sends the specific RSSI value to TuyaMCU (it will send current RSSI if no argument is set) | File: driver/drv_tuyaMCU.c<br/>Function: Cmd_TuyaMCU_Send_RSSI |
| tuyaMcu_sendState | [dpID][dpType][dpValue] | Manually send set state command. Do not use it. Use mapping, so communication is bidirectional and automatic. | File: driver/drv_tuyaMCU.c<br/>Function: TuyaMCU_SendStateCmd |
| tuyaMcu_setBaudRate | [BaudValue] | Sets the baud rate used by TuyaMCU UART communication. Default value is 9600. Some other devices require 115200. | File: driver/drv_tuyaMCU.c<br/>Function: TuyaMCU_SetBaudRate |
| tuyaMcu_setDimmerRange | [Min][Max] | Set dimmer range used by TuyaMCU | File: driver/drv_tuyaMCU.c<br/>Function: TuyaMCU_SetDimmerRange |
| tuyaMcu_testSendTime | | Sends a example date by TuyaMCU to clock/callendar MCU | File: driver/drv_tuyaMCU.c<br/>Function: TuyaMCU_Send_SetTime_Example |
| uartFakeHex | [HexString] | Spoofs a fake hex packet so it looks like TuyaMCU send that to us. Used for testing. | File: driver/drv_uart.c<br/>Function: CMD_UART_FakeHex |
| 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. | File: driver/drv_uart.c<br/>Function: CMD_UART_Init |
| uartSendASCII | [AsciiString] | Sends given string by UART. | File: driver/drv_uart.c<br/>Function: CMD_UART_Send_ASCII |
| uartSendHex | [HexString] | Sends raw data by UART, can be used to send TuyaMCU data, but you must write whole packet with checksum yourself | File: driver/drv_tuyaMCU.c<br/>Function: CMD_UART_Send_Hex |
| UCS1912_Test | | | File: driver/drv_ucs1912.c<br/>Function: 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. | File: driver/drv_bl_shared.c<br/>Function: BL09XX_VCPPrecision |
| 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 | File: driver/drv_bl_shared.c<br/>Function: BL09XX_VCPPublishIntervals |
| 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) | File: driver/drv_bl_shared.c<br/>Function: BL09XX_VCPPublishThreshold |
| 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. | File: driver/drv_pwrCal.c<br/>Function: NULL); |
| 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 | File: cmnds/cmd_script.c<br/>Function: CMD_waitFor |

464
docs/commands.md
View File

@ -8,264 +8,266 @@ Also remember that commands can be put in autoexec.bat to run at startup (see We
Do not add anything here, as it will overwritten with next rebuild.
| Command | Arguments | Description |
|:------------- |:------------- | -----:|
| 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. |
| ToggleChannel | [ChannelIndex] | Toggles given channel value. Non-zero becomes zero, zero becomes 1. |
| 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. |
| ClampChannel | [ChannelIndex][Min][Max] | Clamps given channel value to a range. |
| 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. |
| 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. |
| GetChannel | [ChannelIndex] | Prints given channel value to console. |
| GetReadings | | Prints voltage etc readings to console. |
| ShortName | [Name] | Sets the short name of the device. |
| FriendlyName | [Name] | Sets the full name of the device |
| PinDeepSleep | | Starts a pin deep sleep (deep sleep that can be interrupted by external IO events like a button press) |
| 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. |
| 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 |
| 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 |
| Map | [TargetChannel][InputValue][InMin][InMax][OutMin][OutMax] | qqq |
| 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... |
| 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. |
| AddEventHandler | [EventName][EventArgument][CommandToRun] | This can be used to trigger an action on a button click, long press, etc |
| 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' |
| listEventHandlers | | Prints full list of added event handlers |
| clearAllHandlers | | This clears all added event handlers |
| aliasMem | | Internal usage only. See docs for 'alias' command. |
| 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.<br/>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 |
| 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. |
| restart | | Reboots the module |
| reboot | | Same as restart. Needed for bkWriter 1.60 which sends 'reboot' cmd before trying to get bus |
| 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<br/>e.g.:Battery_cycle 60 |
| Battery_Setup | [minbatt][maxbatt][V_divider][Vref][AD Bits] | measure battery based on ADC. <br />req. args: minbatt in mv, maxbatt in mv. <br />optional: V_divider(2), Vref(default 2400), ADC bits(4096)<br/>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.<br/>e.g.:SHT_Calibrate -4 10 |
| CHT_Cycle | [int] | This is the interval between measurements in seconds, by default 1. Max is 255.<br/>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 |
| clearAll | | Clears config and all remaining features, like runtime scripts, events, etc |
| 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. |
| 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. |
| stackOverflow | | Causes a stack overflow |
| crashNull | | Causes a crash |
| simonirtest | | Simons Special Test |
| 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 |
| 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) |
| 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. |
| flags | [IntegerValue] | Sets the device flags |
| SetFlag | [FlagIndex][0or1] | Sets given flag |
| ClearNoPingTime | | Command for ping watchdog; it sets the 'time since last ping reply' to 0 again |
| 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' |
| OpenAP | | Temporarily disconnects from programmed WiFi network and opens Access Point |
| DSEdge | [edgeCode] | DoorSensor driver 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 |
| SafeMode | | Forces device reboot into safe mode (open ap with disabled drivers) |
| PingInterval | [IntegerSeconds] | Sets the interval between ping attempts for ping watchdog mechanism |
| PingHost | [IPStr] | Sets the host to ping by IP watchdog |
| 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 |
| led_dimmer | [Value] | set output dimmer 0..100 |
| Dimmer | [Value] | Alias for led_dimmer |
| 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). |
| led_enableAll | [1or0orToggle] | Power on/off LED but remember the RGB(CW) values |
| led_basecolor_rgb | [HexValue] | Puts the LED driver in RGB mode and sets given color. |
| clearRepeatingEvents | | Clears all repeating events. |
| Color | [HexValue] | Puts the LED driver in RGB mode and sets given color. |
| led_basecolor_rgbcw | | set PWN color using #RRGGBB[cw][ww] |
| add_temperature | [DeltaValue][bWrapAroundInsteadOfHold] | Adds a given value to current LED temperature. Function can wrap or clamp if max/min is exceeded. |
| 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) |
| ConsumptionThreshold | [FloatValue] | Setup value for automatic save of consumption data [1..100] |
| crashNull | | Causes a crash |
| CT | [TempValue] | Same as led_temperature |
| led_colorMult | [Value] | Internal usage. |
| led_saturation | [Value] | This is an alternate way to set the LED color. |
| led_hue | [Value] | This is an alternate way to set the LED color. |
| led_nextColor | | Sets the next color from predefined colours list. Our list is the same as in Tasmota. |
| 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 |
| 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 <file> - 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. |
| 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<br/>e.g.:led_gammaCtrl on |
| CTRange | [MinRange][MaxRange] | This sets the temperature range for display. Default is 154-500. |
| DimmerDelta | [DeltaValue] | This sets the delta value for SmartDimmer/SmartButtonForLEDs hold event. This determines the amount of change of dimmer per hold event. |
| 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. |
| 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.<br/>e.g.:addRepeatingEventID 2 -1 123 Power0 Toggle |
| cancelRepeatingEvent | [UserIDInteger] | Stops a given repeating event with a specified ID |
| clearRepeatingEvents | | Clears all repeating events. |
| listRepeatingEvents | | lists all repeating events |
| startScript | [FileName][Label][UniqueID] | Starts a script thread from given file, at given label - can be * for whole file, with given unique ID |
| stopScript | [UniqueID] | Force-stop given script thread by ID |
| stopAllScripts | | Stops all running scripts |
| listScripts | | Lists all running scripts. |
| 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 |
| delay_s | [ValueSeconds] | Script-only command. Pauses current script thread for given amount of seconds. |
| delay_ms | [ValueMS] | Script-only command. Pauses current script thread for given amount of ms. |
| return | | Script-only command. Currently it just stops totally current script thread. |
| resetSVM | | Resets all SVM and clears all scripts. |
| 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 |
| 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. |
| 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 |
| backlog | [string of commands separated with ;] | run a sequence of ; separated commands |
| exec | [Filename] | exec <file> - run autoexec.bat or other file from LFS if present |
| SSID1 | [ValueString] | Sets the SSID of target WiFi. Command keeps Tasmota syntax. |
| Password1 | [ValueString] | Sets the Pass of target WiFi. Command keeps Tasmota syntax |
| MqttHost | [ValueString] | Sets the MQTT host. Command keeps Tasmota syntax |
| MqttUser | [ValueString] | Sets the MQTT user. Command keeps Tasmota syntax |
| MqttPassword | [ValueString] | Sets the MQTT pass. Command keeps Tasmota syntax |
| MqttClient | [ValueString] | Sets the MQTT client. Command keeps Tasmota syntax |
| State | NULL | NULL |
| testMallocFree | | Test malloc and free functionality to see if the device crashes |
| testRealloc | | Test realloc and free functions to see if the device crashes |
| testJSON | | Test the JSON library |
| testLog | | Do some test printfs to log with integer and a float |
| testFloats | | Do some more test printfs with floating point numbers |
| testArgs | | Test tokenizer for args and print back all the given args to console |
| testStrdup | | Test strdup function to see if it allocs news string correctly, also test freeing the string |
| 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. |
| json_test | cmnd_json_test | |
| 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') |
| Battery_Setup | [float][float][float][float][float] | measure battery based on ADC args minbatt and maxbatt in mv. optional V_divider(2), Vref(default 2400) and ADC bits(4096) and <br/>e.g.:Battery_Setup 1500 3000 2 2400 4096 |
| Battery_cycle | [int] | change cycle of measurement by default every 10 seconds<br/>e.g.:Battery_Setup 60 |
| PowerMax | BL0937_PowerMax | |
| 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. |
| SetupEnergyStats | [Enable1or0][SampleTime][SampleCount][JSonEnable] | Setup Energy Statistic Parameters: [enable<0|1>] [sample_time<10..900>] [sample_count<10..180>] [JsonEnable<0|1>]. JSONEnable is optional. |
| ConsumptionThreshold | [FloatValue] | Setup value for automatic save of consumption data [1..100] |
| 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) |
| 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 |
| 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 |
| 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_Current | [MaxCurrentRGB][MaxCurrentCW] | Sets the maximum current limit for BP1658CJ driver. |
| 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 |
| 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_Current | [MaxCurrentRGB][MaxCurrentCW] | Sets the maximum current limit for BP5758D driver, first value is for rgb and second for cw |
| BridgePulseLength | [FloatValue] | Setup value for bridge pulse len |
| CHT_Calibrate | | Calibrate the CHT Sensor as Tolerance is +/-2 degrees C.<br/>e.g.:SHT_Calibrate -4 10 |
| 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 |
| setButtonColor | [ButtonIndex][Color] | Sets the colour of custom scriptable HTTP page button |
| setButtonCommand | [ButtonIndex][Command] | Sets the command of custom scriptable HTTP page button |
| setButtonLabel | [ButtonIndex][Label] | Sets the label of custom scriptable HTTP page button |
| setButtonEnabled | [ButtonIndex][1or0] | Sets the visibility of custom scriptable HTTP page button |
| IRSend | [PROT-ADDR-CMD-REP] | Sends IR commands in the form PROT-ADDR-CMD-REP, e.g. NEC-1-1A-0 |
| 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 |
| startDriver | [DriverName] | Starts driver |
| stopDriver | [DriverName] | Stops driver |
| MAX72XX_Setup | [Value] | Sets the maximum current for LED driver. |
| MAX72XX_Scroll | DRV_MAX72XX_Scroll | |
| MAX72XX_Print | DRV_MAX72XX_Print | |
| 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. |
| ntp_setServer | [ServerIP] | Sets the NTP server |
| ntp_info | | Display NTP related settings |
| 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 |
| removeClockEvent | [ID] | Removes clock event wtih given ID |
| listClockEvents | | Print the complete set clock events list |
| clearClockEvents | | Removes all set clock events |
| toggler_enable | [1or0] | Sets the given output ON or OFF. handles toggler_enable0, toggler_enable1, etc |
| 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. |
| toggler_channel | [ChannelIndex] | handles toggler_channel0, toggler_channel1. Sets channel linked to given toggler slot. |
| toggler_name | | Handles toggler_name0, toggler_name1, etc. Sets the name of a toggler for GUI. |
| 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. |
| 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. |
| 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. |
| SGP_cycle | [int] | change cycle of measurement by default every 10 seconds 0 to deactivate<br/>e.g.:SGP_Cycle 60 |
| SGP_GetVersion | | SGP : get version<br/>e.g.:SGP_GetVersion |
| SGP_GetBaseline | | SGP Get baseline<br/>e.g.:SGP_GetBaseline |
| SGP_SoftReset | | SGP i2C soft reset<br/>e.g.:SGP_SoftReset |
| SHT_cycle | [int] | change cycle of measurement by default every 10 seconds 0 to deactivate<br/>e.g.:SHT_Cycle 60 |
| SHT_Calibrate | | Calibrate the SHT Sensor as Tolerance is +/-2 degrees C.<br/>e.g.:SHT_Calibrate -4 10 |
| SHT_MeasurePer | | Retrieve Periodical measurement for SHT<br/>e.g.:SHT_Measure |
| SHT_LaunchPer | [msb][lsb] | Launch/Change periodical capture for SHT Sensor<br/>e.g.:SHT_LaunchPer 0x23 0x22 |
| SHT_StopPer | | Stop periodical capture for SHT Sensor |
| SHT_Measure | | Retrieve OneShot measurement for SHT<br/>e.g.:SHT_Measure |
| SHT_Heater | | Activate or Deactivate Heater (0 / 1)<br/>e.g.:SHT_Heater 1 |
| SHT_GetStatus | | Get Sensor Status<br/>e.g.:SHT_GetStatusCmd |
| SHT_ClearStatus | | Clear Sensor Status<br/>e.g.:SHT_ClearStatusCmd |
| SHT_ReadAlert | | Get Sensor alert configuration<br/>e.g.:SHT_ReadAlertCmd |
| SHT_SetAlert | [temp_high, temp_low, hum_high, hum_low]<br/>Req:all | Set Sensor alert configuration<br/>e.g.:SHT_SetAlertCmd |
| SM16703P_Test | | qq |
| SM16703P_Send | | NULL |
| SM16703P_Test_3xZero | | NULL |
| SM16703P_Test_3xOne | | NULL |
| 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 |
| 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_Current | [RGBLimit][CWLimit] | Sets the maximum current for LED driver. Please note that arguments are using SM2135 codes, see [full list of codes here](https://www.elektroda.com/rtvforum/viewtopic.php?p=20493415#20493415) |
| 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 |
| 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_Current | [Value] | Sets the maximum current for LED driver. |
| SPITestFlash_ReadID | CMD_SPITestFlash_ReadID | |
| SPITestFlash_WriteStr | CMD_SPITestFlash_WriteStr | |
| SPITestFlash_Erase | CMD_SPITestFlash_Erase | |
| SPITestFlash_ReadData | CMD_SPITestFlash_ReadData | |
| obkDeviceList | | Generate the SSDP list of OpenBeken devices found on the network. |
| 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_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_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. |
| 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. |
| SetupTestPower | | NULL |
| TMGN_SetBit | [CharIndex] [BitIndex] [BitValue] | Set given bit of given digit to 1 or 0. |
| TMGN_Clear | | This clears the 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_Print | [StartOfs] [MaxLenOr0] [StringText] [optionalBClampWithZeroesForClock] | This allows you to print string on TM1637/GN932/etc display, it supports variables expansion |
| TMGN_Test | CMD_TM1637_Test | |
| TMGN_Brightness | [Brigthness0to7][bOn] | This allows you to change brightness and state of 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. |
| TM1650_Test | CMD_TM1650_Test | |
| TMGN_Read | CMD_TMGN_Read | |
| TMGN_SetupButtons | CMD_TMGN_SetupButtons | |
| tuyaMcu_testSendTime | | Sends a example date by TuyaMCU to clock/callendar MCU |
| 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. |
| 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](https://developer.tuya.com/en/docs/iot/tuya-cloud-universal-serial-port-access-protocol?id=K9hhi0xxtn9cb) for info about TuyaMCU. You can also see our [TuyaMCU Analyzer Tool](https://www.elektroda.com/rtvforum/viewtopic.php?p=20528459#20528459) |
| tuyaMcu_setDimmerRange | [Min][Max] | Set dimmer range used by TuyaMCU |
| tuyaMcu_sendHeartbeat | | Send heartbeat to TuyaMCU |
| tuyaMcu_sendQueryState | | Send query state command. No arguments needed. |
| tuyaMcu_sendProductInformation | | Send query packet (0x01). No arguments needed. |
| tuyaMcu_sendState | [dpID][dpType][dpValue] | Manually send set state command. Do not use it. Use mapping, so communication is bidirectional and automatic. |
| tuyaMcu_sendMCUConf | | Send MCU conf command |
| fakeTuyaPacket | [HexString] | This simulates packet being sent from TuyaMCU to our OBK device. |
| tuyaMcu_setBaudRate | [BaudValue] | Sets the baud rate used by TuyaMCU UART communication. Default value is 9600. Some other devices require 115200. |
| tuyaMcu_sendRSSI | | Command sends the specific RSSI value to TuyaMCU (it will send current RSSI if no argument is set) |
| 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](https://www.elektroda.com/rtvforum/viewtopic.php?p=20483899#20483899). |
| uartSendHex | [HexString] | Sends raw data by UART, can be used to send TuyaMCU data, but you must write whole packet with checksum yourself |
| uartSendASCII | [AsciiString] | Sends given string by UART. |
| 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. |
| UCS1912_Test | | |
| 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 |
| lcd_clear | | Clears the LCD |
| addI2CDevice_TC74 | | Adds a new I2C device - TC74 |
| addI2CDevice_MCP23017 | | Adds a new I2C device - MCP23017 |
| addI2CDevice_LCM1602 | | Adds a new I2C device - LCM1602 |
| addI2CDevice_LCD_PCF8574 | | Adds a new I2C device - PCF8574 |
| MCP23017_MapPinToChannel | | Maps port expander bit to OBK channel |
| scanI2C | | |
| lfs_size | [MaxSize] | Log or Set LFS size - will apply and re-format next boot, usage setlfssize 0x10000 |
| lfs_unmount | | Un-mount LFS |
| lfs_mount | | Mount LFS |
| lfs_format | | Unmount and format LFS. Optionally add new size as argument |
| 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<br/>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 |
| 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 |
| logfeature | [Index][1or0] | set log feature filter, as an index and a 1 or 0 |
| logtype | [TypeStr] | logtype direct|thread|none - type of serial logging - thread (in a thread; default), direct (logged directly to serial), none (no UART logging) |
| 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](https://developer.tuya.com/en/docs/iot/tuya-cloud-universal-serial-port-access-protocol?id=K9hhi0xxtn9cb) for info about TuyaMCU. You can also see our [TuyaMCU Analyzer Tool](https://www.elektroda.com/rtvforum/viewtopic.php?p=20528459#20528459) |
| 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.. |
| 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 |
| 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. |
| 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. |
| publishAll | | Starts the step by step publish of all available values |
| publishChannel | [ChannelIndex] | Forces publish of given channel |
| publishChannels | | Starts the step by step publish of all channel values |
| publishBenchmark | | |
| logtype | [TypeStr] | logtype direct|thread|none - type of serial logging - thread (in a thread; default), direct (logged directly to serial), none (no UART logging) |
| 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. |
| 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. |
| showgpi | NULL | log stat of all GPIs |
| setChannelType | [ChannelIndex][TypeString] | Sets a custom type for channel. Types are mostly used to determine how to display channel value on GUI |
| showChannelValues | | log channel values |
| setButtonTimes | [ValLongPress][ValShortPress][ValRepeat] | Each value is times 100ms, so: SetButtonTimes 2 1 1 means 200ms long press, 100ms short and 100ms repeat |
| 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|1>] [sample_time<10..900>] [sample_count<10..180>] [JsonEnable<0|1>]. JSONEnable is optional. |
| SetupTestPower | | NULL |
| SGP_cycle | [int] | change cycle of measurement by default every 10 seconds 0 to deactivate<br/>e.g.:SGP_Cycle 60 |
| SGP_GetBaseline | | SGP Get baseline<br/>e.g.:SGP_GetBaseline |
| SGP_GetVersion | | SGP : get version<br/>e.g.:SGP_GetVersion |
| SGP_SoftReset | | SGP i2C soft reset<br/>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.<br/>e.g.:SHT_Calibrate -4 10 |
| SHT_ClearStatus | | Clear Sensor Status<br/>e.g.:SHT_ClearStatusCmd |
| SHT_cycle | [int] | This is the interval between measurements in seconds, by default 10. Max is 255.<br/>e.g.:SHT_Cycle 60 |
| SHT_GetStatus | | Get Sensor Status<br/>e.g.:SHT_GetStatusCmd |
| SHT_Heater | | Activate or Deactivate Heater (0 / 1)<br/>e.g.:SHT_Heater 1 |
| SHT_LaunchPer | [msb][lsb] | Launch/Change periodical capture for SHT Sensor<br/>e.g.:SHT_LaunchPer 0x23 0x22 |
| SHT_Measure | | Retrieve OneShot measurement for SHT<br/>e.g.:SHT_Measure |
| SHT_MeasurePer | | Retrieve Periodical measurement for SHT<br/>e.g.:SHT_Measure |
| SHT_ReadAlert | | Get Sensor alert configuration<br/>e.g.:SHT_ReadAlertCmd |
| SHT_SetAlert | [temp_high, temp_low, hum_high, hum_low]<br/>Req:all | Set Sensor alert configuration<br/>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](https://www.elektroda.com/rtvforum/viewtopic.php?p=20493415#20493415) |
| 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](https://www.elektroda.com/rtvforum/viewtopic.php?p=20483899#20483899). |
| 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 |

1
docs/ioRoles.md
View File

@ -80,4 +80,5 @@ Do not add anything here, as it will overwritten with next rebuild.
| TM1638_CLK | QQQ |
| TM1638_DAT | QQQ |
| TM1638_STB | QQQ |
| BAT_Relay_n | Like BAT_Relay, but inversed. See [battery driver topic here](https://www.elektroda.com/rtvforum/topic3959103.html) |
| Total_Options | Current total number of available IOR roles |

8
docs/json/channelTypes.json
View File

@ -295,6 +295,14 @@
"file": "new_pins.h",
"driver": ""
},
{
"name": "SmokePercent",
"title": "TODO",
"descr": "Smoke percentage",
"enum": "ChType_SmokePercent",
"file": "new_pins.h",
"driver": ""
},
{
"name": "Max",
"title": "TODO",

3926
docs/json/commands.json
View File

File diff suppressed because it is too large Load Diff

8
docs/json/ioRoles.json
View File

@ -599,6 +599,14 @@
"file": "new_pins.h",
"driver": ""
},
{
"name": "BAT_Relay_n",
"title": "TODO",
"descr": "Like BAT_Relay, but inversed. See [battery driver topic here](https://www.elektroda.com/rtvforum/topic3959103.html)",
"enum": "IOR_BAT_Relay_n",
"file": "new_pins.h",
"driver": ""
},
{
"name": "Total_Options",
"title": "TODO",

10
scripts/getcommands.js
View File

@ -846,6 +846,15 @@ for (let i = 0; i < flags.length; i++) {
}
}
// Sort commands by Name alphabetically
commands.sort((a, b) => {
if (a.name.toUpperCase() < b.name.toUpperCase())
return -1;
if (a.name.toUpperCase() > b.name.toUpperCase())
return 1;
return 0;
});
for (let i = 0; i < commands.length; i++){
/* like:
@ -1064,6 +1073,7 @@ function writeDocMD_Page(page) {
page.fullMDPath = fullName;
}
writeDocMD_Array('ioRoles', iosmdshort, ios, "IO/Pin Roles", true, generic.pins);
writeDocMD_Array('flags', flagsmdshort, flags, "Flags", true, generic.flags);
writeDocMD_Array('drivers', driversmdshort, drvs, "Drivers", true, generic.drivers);

2
src/cmnds/cmd_channels.c
View File

@ -512,7 +512,7 @@ void CMD_InitChannelCommands(){
//cmddetail:"examples":""}
CMD_RegisterCommand("MapRanges", CMD_MapRanges, NULL);
//cmddetail:{"name":"Map","args":"[TargetChannel][InputValue][InMin][InMax][OutMin][OutMax]",
//cmddetail:"descr":"qqq",
//cmddetail:"descr":"Used to convert a value from one range into a proportional value of another range.",
//cmddetail:"fn":"CMD_Map","file":"cmnds/cmd_channels.c","requires":"",
//cmddetail:"examples":""}
CMD_RegisterCommand("Map", CMD_Map, NULL);

23
src/cmnds/cmd_send.c
View File

@ -7,8 +7,8 @@
// SendGet http://192.168.0.112/cm?cmnd=Power0%20Toggle
// addRepeatingEvent 5 SendGet http://192.168.0.112/cm?cmnd=Power0%20Toggle
// addEventHandler OnClick 8 SendGet http://192.168.0.112/cm?cmnd=Power0%20Toggle
static commandResult_t CMD_SendGET(const void *context, const char *cmd, const char *args, int cmdFlags){
ADDLOG_INFO(LOG_FEATURE_CMD, " CMD_SendGET received with args %s",args);
static commandResult_t CMD_SendGET(const void* context, const char* cmd, const char* args, int cmdFlags) {
ADDLOG_INFO(LOG_FEATURE_CMD, " CMD_SendGET received with args %s", args);
#if defined(PLATFORM_BEKEN) || defined(WINDOWS)
HTTPClient_Async_SendGet(args);
@ -19,14 +19,14 @@ static commandResult_t CMD_SendGET(const void *context, const char *cmd, const c
return CMD_RES_OK;
}
// SendPOST http://localhost:3000/ 3000 "application/json" "{ \"a\":123, \"b\":77 }"
static commandResult_t CMD_SendPOST(const void *context, const char *cmd, const char *args, int cmdFlags) {
static commandResult_t CMD_SendPOST(const void* context, const char* cmd, const char* args, int cmdFlags) {
ADDLOG_INFO(LOG_FEATURE_CMD, " CMD_SendPOST received with args %s", args);
Tokenizer_TokenizeString(args, TOKENIZER_ALLOW_QUOTES | TOKENIZER_ALLOW_ESCAPING_QUOTATIONS);
#if defined(PLATFORM_BEKEN) || defined(WINDOWS)
HTTPClient_Async_SendPost(Tokenizer_GetArg(0),
Tokenizer_GetArgIntegerDefault(1,80),
Tokenizer_GetArgIntegerDefault(1, 80),
Tokenizer_GetArg(2),
Tokenizer_GetArg(3),
Tokenizer_GetArg(4));
@ -36,7 +36,7 @@ static commandResult_t CMD_SendPOST(const void *context, const char *cmd, const
#endif
return CMD_RES_OK;
}
static commandResult_t CMD_TestPOST(const void *context, const char *cmd, const char *args, int cmdFlags) {
static commandResult_t CMD_TestPOST(const void* context, const char* cmd, const char* args, int cmdFlags) {
#if defined(PLATFORM_BEKEN) || defined(WINDOWS)
HTTPClient_Async_SendPost("http://localhost:3000/",
@ -52,20 +52,19 @@ static commandResult_t CMD_TestPOST(const void *context, const char *cmd, const
}
int CMD_InitSendCommands(){
int CMD_InitSendCommands() {
//cmddetail:{"name":"sendGet","args":"[TargetURL]",
//cmddetail:"descr":"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.",
//cmddetail:"fn":"CMD_SendGET","file":"cmnds/cmd_send.c","requires":"",
//cmddetail:"examples":""}
CMD_RegisterCommand("sendGet", CMD_SendGET, NULL);
CMD_RegisterCommand("sendGet", CMD_SendGET, NULL);
//cmddetail:{"name":"sendPost","args":"[TargetURL]",
//cmddetail:"descr":"Sends a HTTP POST request to target URL. TODO",
//cmddetail:{"name":"sendPost","args":"[TargetURL] [HTTP Port] [Content Type] [Post Content]",
//cmddetail:"descr":"Sends a HTTP POST request to target URL",
//cmddetail:"fn":"CMD_SendPOST","file":"cmnds/cmd_send.c","requires":"",
//cmddetail:"examples":""}
//cmddetail:"examples":"SendPost ""http://192.168.0.1/write?db=energy"" 8086 ""application/octet-stream"" ""current,clientid=A0:92:08:CB:41:E1 value=$current"""}
CMD_RegisterCommand("sendPOST", CMD_SendPOST, NULL);
//CMD_RegisterCommand("testPost", CMD_TestPOST, NULL);
return 0;
return 0;
}

6
src/driver/drv_battery.c
View File

@ -134,8 +134,8 @@ commandResult_t Battery_cycle(const void* context, const char* cmd, const char*
// startDriver Battery
void Batt_Init() {
//cmddetail:{"name":"Battery_Setup","args":"[float][float][float][float][float]",
//cmddetail:"descr":"measure battery based on ADC args minbatt and maxbatt in mv. optional V_divider(2), Vref(default 2400) and ADC bits(4096) and ",
//cmddetail:{"name":"Battery_Setup","args":"[minbatt][maxbatt][V_divider][Vref][AD Bits]",
//cmddetail:"descr":"measure battery based on ADC. <br />req. args: minbatt in mv, maxbatt in mv. <br />optional: V_divider(2), Vref(default 2400), ADC bits(4096)",
//cmddetail:"fn":"Battery_Setup","file":"drv/drv_battery.c","requires":"",
//cmddetail:"examples":"Battery_Setup 1500 3000 2 2400 4096"}
CMD_RegisterCommand("Battery_Setup", Battery_Setup, NULL);
@ -143,7 +143,7 @@ void Batt_Init() {
//cmddetail:{"name":"Battery_cycle","args":"[int]",
//cmddetail:"descr":"change cycle of measurement by default every 10 seconds",
//cmddetail:"fn":"Battery_cycle","file":"drv/drv_battery.c","requires":"",
//cmddetail:"examples":"Battery_Setup 60"}
//cmddetail:"examples":"Battery_cycle 60"}
CMD_RegisterCommand("Battery_cycle", Battery_cycle, NULL);
}