mirror/OpenBK7231T_App
3
0
Fork 0
mirror of https://github.com/openshwprojects/OpenBK7231T_App.git synced 2025-10-29 19:43:22 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs refresh

Browse Source
This commit is contained in:
Tester23 2025-06-17 18:01:35 +02:00
parent 901a43ceaf
commit b02068e485
20 changed files with 624 additions and 30 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
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) (80 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 corresponding 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) (51 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) (61 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) (41 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) (59 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' suffixes. 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. |
| [IO/Pin Roles](https://github.com/openshwprojects/OpenBK7231T_App/blob/main/docs/ioRoles.md) (82 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 corresponding 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) (52 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) (67 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) (42 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) (62 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' suffixes. 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) (31 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) (326 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) (362 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) (37 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 outgoing OBK MQTT publishes |
| [Script examples](https://github.com/openshwprojects/OpenBK7231T_App/blob/main/docs/scriptExamples.md) (6 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) (326 total) | More details on commands. |
| [Console/Script commands [Extended Edition]](https://github.com/openshwprojects/OpenBK7231T_App/blob/main/docs/commands-extended.md) (362 total) | More details on commands. |

7
docs/channelTypes.md
View File

@ -51,9 +51,9 @@ Do not add anything here, as it will overwritten with next rebuild.
| TimerSeconds | This will display time formatted to minutes, hours, etc. |
| Frequency_div10 | For TuyaMCU power metering. Not used for BL09** and CSE** sensors. Divider is used by TuyaMCU, because TuyaMCU sends always values as integers so we have to divide them before displaying on UI |
| PowerFactor_div100 | For TuyaMCU power metering. Not used for BL09** and CSE** sensors. Divider is used by TuyaMCU, because TuyaMCU sends always values as integers so we have to divide them before displaying on UI |
| Pressure_div100 | . |
| Pressure_div100 | Pressure in hPa, but divided by 100 |
| Temperature_div100 | Just like humidity_div100, but for temperature. |
| LeakageCurrent_div1000 | . |
| LeakageCurrent_div1000 | Leakage current in mA |
| Power_div100 | Just like power, but with one decimal place (but stored as integer, for TuyaMCU support) |
| Motion | Motion |
| ReadOnly_div10 | This channel is read only. |
@ -63,4 +63,7 @@ Do not add anything here, as it will overwritten with next rebuild.
| Orp | Orp Water Quality |
| Tds | TDS Water Quality |
| Motion_n | Motion_n |
| Frequency_div1000 | For TuyaMCU power metering. Not used for BL09** and CSE** sensors. Divider is used by TuyaMCU, because TuyaMCU sends always values as integers so we have to divide them before displaying on UI |
| OpenStopClose | TODO |
| Percent | TODO |
| Max | This is the current total number of available channel types. |

46
docs/commands-extended.md
View File

@ -6,6 +6,7 @@ Do not add anything here, as it will overwritten with next rebuild.
| Command | Arguments | Description | Location |
|:------------- |:-------------:|:----- | ------:|
| 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').<br/><br/>See also [AB_Map on forum](https://www.elektroda.com/rtvforum/find.php?q=AB_Map). | File: drv/drv_adcButton.c<br/>Function: Cmd_ADCButtonMap |
| ACMode | CMD_ACMode | .<br/><br/>See also [ACMode on forum](https://www.elektroda.com/rtvforum/find.php?q=ACMode). | File: driver/drv_tclAC.c<br/>Function: NULL); |
| ADCSmoother | [Pindex] [TotalSamples] [SampleIntervalMS] [TargetChannelADCValue] [MarginValue] [TargetChannel0or1] | Starts the ADC smoother with given configuration.<br/><br/>See also [ADCSmoother on forum](https://www.elektroda.com/rtvforum/find.php?q=ADCSmoother). | File: driver/drv_adcSmoother.c<br/>Function: NULL); |
| 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'.<br/><br/>See also [AddChangeHandler on forum](https://www.elektroda.com/rtvforum/find.php?q=AddChangeHandler). | File: cmnds/cmd_eventHandlers.c<br/>Function: CMD_AddChangeHandler |
| 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.<br/><br/>See also [AddChannel on forum](https://www.elektroda.com/rtvforum/find.php?q=AddChannel). | File: cmnds/cmd_channels.c<br/>Function: CMD_AddChannel |
@ -31,6 +32,8 @@ Do not add anything here, as it will overwritten with next rebuild.
| backlog | [string of commands separated with ;] | Run a sequence of ; separated commands.<br/><br/>See also [backlog on forum](https://www.elektroda.com/rtvforum/find.php?q=backlog). | File: cmnds/cmd_tasmota.c<br/>Function: cmnd_backlog |
| Battery_cycle | [int] | Change cycle of measurement by default every 10 seconds.<br/><br/>Example: Battery_cycle 60<br/><br/>See also [Battery_cycle on forum](https://www.elektroda.com/rtvforum/find.php?q=Battery_cycle). | 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/><br/>Example: Battery_Setup 1500 3000 2 2400 4096<br/><br/>See also [Battery_Setup on forum](https://www.elektroda.com/rtvforum/find.php?q=Battery_Setup). | File: drv/drv_battery.c<br/>Function: Battery_Setup |
| berry | CMD_Berry | .<br/><br/>See also [berry on forum](https://www.elektroda.com/rtvforum/find.php?q=berry). | File: cmnds/cmd_berry.c<br/>Function: NULL); |
| BL0942opts | opts | BL0942opts 0= default mode (as set in config Flag 26), 3= two BL0942 on both UARTs (bit0 BL0942 on UART1, bit1 BL0942 on UART2).<br/><br/>See also [BL0942opts on forum](https://www.elektroda.com/rtvforum/find.php?q=BL0942opts). | File: driver/drv_pwrCal.c<br/>Function: NULL); |
| BMPI2C_Calibrate | [DeltaTemp][DeltaPressure][DeltaHumidity] | Calibrate the BMPI2C Sensor.<br/><br/>Example: BMPI2C_Calibrate -4 0 10 <br /> meaning -4 on current temp reading, 0 on current pressure reading and +10 on current humidity reading<br/><br/>See also [BMPI2C_Calibrate on forum](https://www.elektroda.com/rtvforum/find.php?q=BMPI2C_Calibrate). | File: driver/drv_bmpi2c.c<br/>Function: BMPI2C_Calibrate |
| BMPI2C_Configure | [Mode][TempSampling][PressureSampling][HumSampling][IIRFilter][StandbyTime] | Manual sensor configuration. Modes: 0 - normal, 1 - forced, 2 - sleep. Overampling range: -1 - skipped, 2^0 to 2^4. Default is X1. IIRFilter range: 0 - off, 2^1 to 2^4 for most, up to 2^7 for BME68X, StandbyTime: 1 for 0.5ms, 63 for 62.5ms, 125, 250, 500, 1000, 2000, 4000. Mode and StandbyTime are not needed on BME68X, All values will be rounded down to closest available (like sampling 10 will choose 8x).<br/><br/>Example: BMPI2C_Configure 0 8 2 4 16 125 <br /><br/><br/>See also [BMPI2C_Configure on forum](https://www.elektroda.com/rtvforum/find.php?q=BMPI2C_Configure). | File: driver/drv_bmpi2c.c<br/>Function: BMPI2C_Configure |
| BMPI2C_Cycle | [IntervalSeconds] | This is the interval between measurements in seconds, by default 1. Max is 255.<br/><br/>Example: BMPI2C_Cycle 60 <br /> measurement is taken every 60 seconds<br/><br/>See also [BMPI2C_Cycle on forum](https://www.elektroda.com/rtvforum/find.php?q=BMPI2C_Cycle). | File: drv/drv_bmpi2c.c<br/>Function: BMPI2C_cycle |
@ -41,6 +44,7 @@ Do not add anything here, as it will overwritten with next rebuild.
| 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.<br/><br/>See also [BP5758D_Map on forum](https://www.elektroda.com/rtvforum/find.php?q=BP5758D_Map). | 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.<br/><br/>See also [BP5758D_RGBCW on forum](https://www.elektroda.com/rtvforum/find.php?q=BP5758D_RGBCW). | File: driver/drv_bp5758d.c<br/>Function: BP5758D_RGBCW |
| BridgePulseLength | [FloatValue] | Setup value for bridge pulse len.<br/><br/>See also [BridgePulseLength on forum](https://www.elektroda.com/rtvforum/find.php?q=BridgePulseLength). | File: driver/drv_bridge_driver.c<br/>Function: Bridge_Pulse_length |
| Buzzer | CMD_Buzzer | .<br/><br/>See also [Buzzer on forum](https://www.elektroda.com/rtvforum/find.php?q=Buzzer). | File: driver/drv_tclAC.c<br/>Function: NULL); |
| cancelRepeatingEvent | [UserIDInteger] | Stops a given repeating event with a specified ID.<br/><br/>See also [cancelRepeatingEvent on forum](https://www.elektroda.com/rtvforum/find.php?q=cancelRepeatingEvent). | 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.<br/><br/>See also [Ch on forum](https://www.elektroda.com/rtvforum/find.php?q=Ch). | File: cmnds/cmd_channels.c<br/>Function: CMD_Ch |
| chart_add | [ntp_time][val1][val2]...[valN] | Adds data to the chart with specified variables at a specific NTP time. See [tutorial](https://www.elektroda.com/rtvforum/topic4075289.html).<br/><br/>See also [chart_add on forum](https://www.elektroda.com/rtvforum/find.php?q=chart_add). | File: driver/drv_charts.c<br/>Function: NULL); |
@ -61,10 +65,12 @@ Do not add anything here, as it will overwritten with next rebuild.
| clearIO | | Clears all pins setting, channels settings.<br/><br/>See also [clearIO on forum](https://www.elektroda.com/rtvforum/find.php?q=clearIO). | File: cmnds/cmd_main.c<br/>Function: CMD_ClearIO |
| ClearNoPingTime | | Command for ping watchdog; it sets the 'time since last ping reply' to 0 again.<br/><br/>See also [ClearNoPingTime on forum](https://www.elektroda.com/rtvforum/find.php?q=ClearNoPingTime). | File: cmnds/cmd_main.c<br/>Function: CMD_ClearNoPingTime |
| clearRepeatingEvents | | Clears all repeating events.<br/><br/>See also [clearRepeatingEvents on forum](https://www.elektroda.com/rtvforum/find.php?q=clearRepeatingEvents). | File: cmnds/cmd_repeatingEvents.c<br/>Function: RepeatingEvents_Cmd_ClearRepeatingEvents |
| CLOCK_CalcDST | [nthWeekEnd monthEnd dayEnd hourEnd nthWeekStart monthStart dayStart hourStart [g_DSToffset hours - default is 1 if unset] | Checks, if actual time is during DST or not.<br/><br/>See also [CLOCK_CalcDST on forum](https://www.elektroda.com/rtvforum/find.php?q=CLOCK_CalcDST). | File: driver/drv_ntp.c<br/>Function: CLOCK_CalcDST |
| clock_calcDST | CLOCK_CalcDST | .<br/><br/>See also [clock_calcDST on forum](https://www.elektroda.com/rtvforum/find.php?q=clock_calcDST). | File: driver/drv_ntp.c<br/>Function: NULL); |
| Color | [HexValue] | Puts the LED driver in RGB mode and sets given color.<br/><br/>See also [Color on forum](https://www.elektroda.com/rtvforum/find.php?q=Color). | File: cmnds/cmd_newLEDDriver.c<br/>Function: basecolor_rgb |
| ConsumptionThreshold | [FloatValue] | Setup value for automatic save of consumption data [1..100].<br/><br/>See also [ConsumptionThreshold on forum](https://www.elektroda.com/rtvforum/find.php?q=ConsumptionThreshold). | File: driver/drv_bl_shared.c<br/>Function: BL09XX_SetupConsumptionThreshold |
| crashNull | | Causes a crash.<br/><br/>See also [crashNull on forum](https://www.elektroda.com/rtvforum/find.php?q=crashNull). | File: cmnds/cmd_main.c<br/>Function: CMD_CrashNull |
| CT | [TempValue] | Same as led_temperature.<br/><br/>See also [CT on forum](https://www.elektroda.com/rtvforum/find.php?q=CT). | File: cmnds/cmd_newLEDDriver.c<br/>Function: temperature |
| CT | [TempValue] | Sets the LED temperature. Same as led_temperature but with Tasmota syntax.<br/><br/>See also [CT on forum](https://www.elektroda.com/rtvforum/find.php?q=CT). | File: cmnds/cmd_newLEDDriver.c<br/>Function: temperature |
| CTRange | [MinRange][MaxRange] | This sets the temperature range for display. Default is 154-500.<br/><br/>See also [CTRange on forum](https://www.elektroda.com/rtvforum/find.php?q=CTRange). | 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.<br/><br/>See also [CurrentSet on forum](https://www.elektroda.com/rtvforum/find.php?q=CurrentSet). | 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.<br/><br/>See also [DeepSleep on forum](https://www.elektroda.com/rtvforum/find.php?q=DeepSleep). | File: cmnds/cmd_main.c<br/>Function: CMD_DeepSleep |
@ -74,15 +80,18 @@ Do not add anything here, as it will overwritten with next rebuild.
| 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.<br/><br/>See also [DGR_SendFixedColor on forum](https://www.elektroda.com/rtvforum/find.php?q=DGR_SendFixedColor). | 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.<br/><br/>See also [DGR_SendPower on forum](https://www.elektroda.com/rtvforum/find.php?q=DGR_SendPower). | 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.<br/><br/>See also [DGR_SendRGBCW on forum](https://www.elektroda.com/rtvforum/find.php?q=DGR_SendRGBCW). | File: driver/drv_tasmotaDeviceGroups.c<br/>Function: CMD_DGR_SendRGBCW |
| Dimmer | [Value] | Alias for led_dimmer.<br/><br/>See also [Dimmer on forum](https://www.elektroda.com/rtvforum/find.php?q=Dimmer). | File: cmnds/cmd_newLEDDriver.c<br/>Function: dimmer |
| Dimmer | [Value] | Alias for led_dimmer, added for Tasmota.<br/><br/>See also [Dimmer on forum](https://www.elektroda.com/rtvforum/find.php?q=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.<br/><br/>See also [DimmerDelta on forum](https://www.elektroda.com/rtvforum/find.php?q=DimmerDelta). | File: cmnds/cmd_newLEDDriver.c<br/>Function: dimmerDelta |
| Display | CMD_Display | .<br/><br/>See also [Display on forum](https://www.elektroda.com/rtvforum/find.php?q=Display). | File: driver/drv_tclAC.c<br/>Function: NULL); |
| DS1820_SetResolution | [int] | Sets resolution for connected DS1820 sensor (9/10/11/12 bits).<br/><br/>See also [DS1820_SetResolution on forum](https://www.elektroda.com/rtvforum/find.php?q=DS1820_SetResolution). | File: drv/drv_ds1820_simple.c<br/>Function: Cmd_SetResolution |
| DSEdge | [edgeCode][optionalPinIndex] | 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. Second argument is optional and allows to set per-pin DSEdge instead of setting it for all pins.<br/><br/>See also [DSEdge on forum](https://www.elektroda.com/rtvforum/find.php?q=DSEdge). | File: drv/drv_doorSensorWithDeepSleep.c<br/>Function: CMD_DeepSleep_SetEdge |
| DSTime | [timeSeconds][optionalAutoWakeUpTimeSeconds] | 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. You can also use this to extend current awake time (at runtime) with syntax: 'DSTime +10', this will make device stay awake 10 seconds longer. You can also restart current value of awake counter by 'DSTime clear', this will make counter go from 0 again.<br/><br/>See also [DSTime on forum](https://www.elektroda.com/rtvforum/find.php?q=DSTime). | 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.<br/><br/>See also [echo on forum](https://www.elektroda.com/rtvforum/find.php?q=echo). | File: cmnds/cmd_main.c<br/>Function: CMD_Echo |
| EnergyCntReset | [OptionalNewValue] | Resets the total Energy Counter, the one that is usually kept after device reboots. After this commands, the counter will start again from 0 (or from the value you specified).<br/><br/>See also [EnergyCntReset on forum](https://www.elektroda.com/rtvforum/find.php?q=EnergyCntReset). | File: driver/drv_bl_shared.c<br/>Function: BL09XX_ResetEnergyCounter |
| EnergyCntReset | [OptionalNewValue][sensorix] | Resets the total Energy Counter, the one that is usually kept after device reboots. After this commands, the counter will start again from 0 (or from the value you specified). sensorix is used in ENABLE_BL_TWIN.<br/><br/>See also [EnergyCntReset on forum](https://www.elektroda.com/rtvforum/find.php?q=EnergyCntReset). | File: driver/drv_bl_shared.c<br/>Function: BL09XX_ResetEnergyCounter |
| exec | [Filename] | Exec <file> - run autoexec.bat or other file from LFS if present.<br/><br/>See also [exec on forum](https://www.elektroda.com/rtvforum/find.php?q=exec). | File: cmnds/cmd_tasmota.c<br/>Function: cmnd_lfsexec |
| ExitSimulator | | [SIMULATOR ONLY] Exits the application instance.<br/><br/>See also [ExitSimulator on forum](https://www.elektroda.com/rtvforum/find.php?q=ExitSimulator). | File: cmnds/cmd_simulatorOnly.c<br/>Function: CMD_ExitSimulator |
| fakeTuyaPacket | [HexString] | This simulates packet being sent from TuyaMCU to our OBK device.<br/><br/>See also [fakeTuyaPacket on forum](https://www.elektroda.com/rtvforum/find.php?q=fakeTuyaPacket). | File: driver/drv_tuyaMCU.c<br/>Function: TuyaMCU_FakePacket |
| FANMode | CMD_FANMode | .<br/><br/>See also [FANMode on forum](https://www.elektroda.com/rtvforum/find.php?q=FANMode). | File: driver/drv_tclAC.c<br/>Function: NULL); |
| flags | [IntegerValue] | Sets the device flags.<br/><br/>See also [flags on forum](https://www.elektroda.com/rtvforum/find.php?q=flags). | File: cmnds/cmd_main.c<br/>Function: CMD_Flags |
| FriendlyName | [Name] | Sets the full name of the device.<br/><br/>See also [FriendlyName on forum](https://www.elektroda.com/rtvforum/find.php?q=FriendlyName). | 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.<br/><br/>See also [FullBootTime on forum](https://www.elektroda.com/rtvforum/find.php?q=FullBootTime). | File: cmnds/cmd_channels.c<br/>Function: CMD_FullBootTime |
@ -101,8 +110,11 @@ Do not add anything here, as it will overwritten with next rebuild.
| HT16K33_Test | HT16K33_Test | .<br/><br/>See also [HT16K33_Test on forum](https://www.elektroda.com/rtvforum/find.php?q=HT16K33_Test). | File: driver/drv_ht16k33.c<br/>Function: NULL); |
| 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.<br/><br/>See also [if on forum](https://www.elektroda.com/rtvforum/find.php?q=if). | File: cmnds/cmd_main.c<br/>Function: CMD_If |
| IndexRefreshInterval | [Interval] | .<br/><br/>See also [IndexRefreshInterval on forum](https://www.elektroda.com/rtvforum/find.php?q=IndexRefreshInterval). | File: cmnds/cmd_main.c<br/>Function: NULL); |
| IRAC | [TODO] | Sends IR commands for HVAC control (TODO).<br/><br/>See also [IRAC on forum](https://www.elektroda.com/rtvforum/find.php?q=IRAC). | File: driver/drv_ir.cpp<br/>Function: IR_AC_Cmd |
| 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.<br/><br/>See also [IREnable on forum](https://www.elektroda.com/rtvforum/find.php?q=IREnable). | File: driver/drv_ir.cpp<br/>Function: IR_Enable |
| IRParam | [MinSize] [Noise Threshold] | Set minimal size of the message and noise threshold.<br/><br/>See also [IRParam on forum](https://www.elektroda.com/rtvforum/find.php?q=IRParam). | File: driver/drv_ir.cpp<br/>Function: IR_Enable |
| IRSend | [PROT-ADDR-CMD-REP-BITS] | Sends IR commands in the form PROT-ADDR-CMD-REP-BITS, e.g. NEC-1-1A-0-0, note that -BITS is optional, it can be 0 for default one, so you can just do NEC-1-1A-0.<br/><br/>See also [IRSend on forum](https://www.elektroda.com/rtvforum/find.php?q=IRSend). | File: driver/drv_ir.cpp<br/>Function: IR_Send_Cmd |
| Json | json array of commands | A stub for Tasmota.<br/><br/>See also [Json on forum](https://www.elektroda.com/rtvforum/find.php?q=Json). | File: cmnds/cmd_tasmota.c<br/>Function: cmnd_JsonCommand |
| json_test | | Developer-only command used to test CJSON library.<br/><br/>See also [json_test on forum](https://www.elektroda.com/rtvforum/find.php?q=json_test). | File: cmnds/cmd_test.c<br/>Function: NULL); |
| KP18058_Current | [RGBLimit][CWLimit] | Sets the maximum current for LED driver. Values 0-31. Example usage: KP18058_Current 14 30.<br/><br/>See also [KP18058_Current on forum](https://www.elektroda.com/rtvforum/find.php?q=KP18058_Current). | File: driver/drv_kp18058.c<br/>Function: KP18058_Current |
| KP18058_Map | [Ch0][Ch1][Ch2][Ch3][Ch4] | Maps KP18058_Map RGBCW values to given indices of KP18058 channels. This is because KP18058 channels order is not the same for some devices. Some devices are using RGBCW order and some are using GBRCW, etc, etc. Example usage: KP18058_Map 0 1 2 3 4.<br/><br/>See also [KP18058_Map on forum](https://www.elektroda.com/rtvforum/find.php?q=KP18058_Map). | File: driver/drv_kp18058.c<br/>Function: KP18058_Map |
@ -132,6 +144,7 @@ Do not add anything here, as it will overwritten with next rebuild.
| lfs_appendInt | [FileName][Int] | Appends a Int to LFS file.<br/><br/>See also [lfs_appendInt on forum](https://www.elektroda.com/rtvforum/find.php?q=lfs_appendInt). | 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.<br/><br/>See also [lfs_appendLine on forum](https://www.elektroda.com/rtvforum/find.php?q=lfs_appendLine). | File: cmnds/cmd_main.c<br/>Function: CMD_LFS_AppendLine |
| lfs_format | | Unmount and format LFS. Optionally add new size as argument.<br/><br/>See also [lfs_format on forum](https://www.elektroda.com/rtvforum/find.php?q=lfs_format). | File: littlefs/our_lfs.c<br/>Function: CMD_LFS_Format |
| lfs_mkdir | CMD_LFS_MakeDirectory | .<br/><br/>See also [lfs_mkdir on forum](https://www.elektroda.com/rtvforum/find.php?q=lfs_mkdir). | File: littlefs/our_lfs.c<br/>Function: NULL); |
| lfs_mount | | Mount LFS.<br/><br/>See also [lfs_mount on forum](https://www.elektroda.com/rtvforum/find.php?q=lfs_mount). | File: littlefs/our_lfs.c<br/>Function: CMD_LFS_Mount |
| lfs_remove | [FileName] | Deletes a LittleFS file.<br/><br/>See also [lfs_remove on forum](https://www.elektroda.com/rtvforum/find.php?q=lfs_remove). | 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.<br/><br/>See also [lfs_size on forum](https://www.elektroda.com/rtvforum/find.php?q=lfs_size). | File: littlefs/our_lfs.c<br/>Function: CMD_LFS_Size |
@ -141,7 +154,7 @@ Do not add anything here, as it will overwritten with next rebuild.
| lfs_unmount | | Un-mount LFS.<br/><br/>See also [lfs_unmount on forum](https://www.elektroda.com/rtvforum/find.php?q=lfs_unmount). | 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.<br/><br/>See also [lfs_write on forum](https://www.elektroda.com/rtvforum/find.php?q=lfs_write). | 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.<br/><br/>See also [lfs_writeLine on forum](https://www.elektroda.com/rtvforum/find.php?q=lfs_writeLine). | File: cmnds/cmd_main.c<br/>Function: CMD_LFS_WriteLine |
| linkTuyaMCUOutputToChannel | [dpId][varType][channelID][bDPCache-Optional][mult-optional][bInverse] | 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).<br/><br/>See also [linkTuyaMCUOutputToChannel on forum](https://www.elektroda.com/rtvforum/find.php?q=linkTuyaMCUOutputToChannel). | File: driver/drv_tuyaMCU.c<br/>Function: TuyaMCU_LinkTuyaMCUOutputToChannel |
| linkTuyaMCUOutputToChannel | [dpId][varType][channelID][bDPCache-Optional][mult-optional][bInverse-Optional][delta-Optional][delta2][delta3] | Used to map between TuyaMCU dpIDs and our internal channels. Mult, inverse and delta are for calibration, they are optional. bDPCache is also optional, 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).<br/><br/>See also [linkTuyaMCUOutputToChannel on forum](https://www.elektroda.com/rtvforum/find.php?q=linkTuyaMCUOutputToChannel). | File: driver/drv_tuyaMCU.c<br/>Function: TuyaMCU_LinkTuyaMCUOutputToChannel |
| listClockEvents | | Print the complete set clock events list.<br/><br/>See also [listClockEvents on forum](https://www.elektroda.com/rtvforum/find.php?q=listClockEvents). | File: driver/drv_ntp_events.c<br/>Function: CMD_NTP_ListEvents |
| listEventHandlers | | Prints full list of added event handlers.<br/><br/>See also [listEventHandlers on forum](https://www.elektroda.com/rtvforum/find.php?q=listEventHandlers). | File: cmnds/cmd_eventHandlers.c<br/>Function: CMD_ListEventHandlers |
| listRepeatingEvents | | Lists all repeating events.<br/><br/>See also [listRepeatingEvents on forum](https://www.elektroda.com/rtvforum/find.php?q=listRepeatingEvents). | File: cmnds/cmd_repeatingEvents.c<br/>Function: RepeatingEvents_Cmd_ListRepeatingEvents |
@ -163,6 +176,7 @@ Do not add anything here, as it will overwritten with next rebuild.
| MCP9808_Calibrate | [DeltaTemperature] | .<br/><br/>See also [MCP9808_Calibrate on forum](https://www.elektroda.com/rtvforum/find.php?q=MCP9808_Calibrate). | File: driver/drv_mcp9808.c<br/>Function: NULL); |
| MCP9808_Cycle | [DelayInSeconds] | Sets MCP9808 measurement interval.<br/><br/>See also [MCP9808_Cycle on forum](https://www.elektroda.com/rtvforum/find.php?q=MCP9808_Cycle). | File: driver/drv_mcp9808.c<br/>Function: NULL); |
| MqttClient | [ValueString] | Sets the MQTT client. Command keeps Tasmota syntax.<br/><br/>See also [MqttClient on forum](https://www.elektroda.com/rtvforum/find.php?q=MqttClient). | File: cmnds/cmd_tasmota.c<br/>Function: cmnd_MqttClient |
| MqttGroup | [ValueString] | Sets the MQTT Group topic. Command keeps Tasmota syntax.<br/><br/>See also [MqttGroup on forum](https://www.elektroda.com/rtvforum/find.php?q=MqttGroup). | File: cmnds/cmd_tasmota.c<br/>Function: cmnd_MqttGroup |
| MqttHost | [ValueString] | Sets the MQTT host. Command keeps Tasmota syntax.<br/><br/>See also [MqttHost on forum](https://www.elektroda.com/rtvforum/find.php?q=MqttHost). | File: cmnds/cmd_tasmota.c<br/>Function: cmnd_MqttHost |
| MqttPassword | [ValueString] | Sets the MQTT pass. Command keeps Tasmota syntax.<br/><br/>See also [MqttPassword on forum](https://www.elektroda.com/rtvforum/find.php?q=MqttPassword). | File: cmnds/cmd_tasmota.c<br/>Function: cmnd_MqttPassword |
| MqttUser | [ValueString] | Sets the MQTT user. Command keeps Tasmota syntax.<br/><br/>See also [MqttUser on forum](https://www.elektroda.com/rtvforum/find.php?q=MqttUser). | File: cmnds/cmd_tasmota.c<br/>Function: cmnd_MqttUser |
@ -226,6 +240,7 @@ Do not add anything here, as it will overwritten with next rebuild.
| 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...<br/><br/>See also [SetChannelVisible on forum](https://www.elektroda.com/rtvforum/find.php?q=SetChannelVisible). | File: cmnds/cmd_channels.c<br/>Function: CMD_SetChannelVisible |
| SetFlag | [FlagIndex][0or1] | Sets given flag.<br/><br/>See also [SetFlag on forum](https://www.elektroda.com/rtvforum/find.php?q=SetFlag). | File: cmnds/cmd_main.c<br/>Function: CMD_SetFlag |
| SetFlash | [FlashIndex][FlashValue] | Sets a a flashVars channel directly (if you are using remember state for given channel, it will overwrite, it uses same space for channels memory).<br/><br/>See also [SetFlash on forum](https://www.elektroda.com/rtvforum/find.php?q=SetFlash). | File: cmnds/cmd_channels.c<br/>Function: CMD_SetFlash |
| setMovingAvg | MovingAvg | Moving average value for power and current. <=1 disable, >=2 count of avg values. The setting is temporary and need to be set at startup.<br/><br/>See also [setMovingAvg on forum](https://www.elektroda.com/rtvforum/find.php?q=setMovingAvg). | File: new_pins.c<br/>Function: NULL); |
| SetPinChannel | [PinIndex][ChannelIndex][optionalChannel2Index] | 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.<br/><br/>See also [SetPinChannel on forum](https://www.elektroda.com/rtvforum/find.php?q=SetPinChannel). | 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.<br/><br/>See also [SetPinRole on forum](https://www.elektroda.com/rtvforum/find.php?q=SetPinRole). | File: cmnds/cmd_channels.c<br/>Function: CMD_SetPinRole |
| setStartupSSID | [Value] | Sets startup SSID, 0 (SSID0) 1 (SSID1).<br/><br/>See also [setStartupSSID on forum](https://www.elektroda.com/rtvforum/find.php?q=setStartupSSID). | File: new_pins.c<br/>Function: CMD_setStartupSSID |
@ -238,7 +253,7 @@ Do not add anything here, as it will overwritten with next rebuild.
| SGP_GetBaseline | | SGP Get baseline.<br/><br/>Example: SGP_GetBaseline<br/><br/>See also [SGP_GetBaseline on forum](https://www.elektroda.com/rtvforum/find.php?q=SGP_GetBaseline). | File: drv/drv_sgp.c<br/>Function: SGP_GetBaseline |
| SGP_GetVersion | | SGP : get version.<br/><br/>Example: SGP_GetVersion<br/><br/>See also [SGP_GetVersion on forum](https://www.elektroda.com/rtvforum/find.php?q=SGP_GetVersion). | File: drv/drv_sgp.c<br/>Function: SGP_GetVersion |
| SGP_SoftReset | | SGP i2C soft reset.<br/><br/>Example: SGP_SoftReset<br/><br/>See also [SGP_SoftReset on forum](https://www.elektroda.com/rtvforum/find.php?q=SGP_SoftReset). | File: drv/drv_sgp.c<br/>Function: SGP_SoftReset |
| ShortName | [Name] | Sets the short name of the device.<br/><br/>See also [ShortName on forum](https://www.elektroda.com/rtvforum/find.php?q=ShortName). | File: cmnds/cmd_channels.c<br/>Function: CMD_ShortName |
| ShortName | [Name] | Sets the short name of the device. This is used as topic for MQTT, for example, for cmnd/obk123121/power etc MQTT calls.<br/><br/>See also [ShortName on forum](https://www.elektroda.com/rtvforum/find.php?q=ShortName). | File: cmnds/cmd_channels.c<br/>Function: CMD_ShortName |
| showChannelValues | | Log channel values.<br/><br/>See also [showChannelValues on forum](https://www.elektroda.com/rtvforum/find.php?q=showChannelValues). | File: new_pins.c<br/>Function: CMD_ShowChannelValues |
| showgpi | NULL | Log stat of all GPIs.<br/><br/>See also [showgpi on forum](https://www.elektroda.com/rtvforum/find.php?q=showgpi). | File: new_pins.c<br/>Function: showgpi |
| SHT_Calibrate | [DeltaTemp][DeltaHumidity] | Calibrate the SHT Sensor as Tolerance is +/-2 degrees C.<br/><br/>Example: SHT_Calibrate -4 10<br/><br/>See also [SHT_Calibrate on forum](https://www.elektroda.com/rtvforum/find.php?q=SHT_Calibrate). | File: driver/drv_sht3x.c<br/>Function: SHT3X_Calibrate |
@ -273,20 +288,40 @@ Do not add anything here, as it will overwritten with next rebuild.
| stackOverflow | | Causes a stack overflow.<br/><br/>See also [stackOverflow on forum](https://www.elektroda.com/rtvforum/find.php?q=stackOverflow). | File: cmnds/cmd_main.c<br/>Function: CMD_StackOverflow |
| startDriver | [DriverName] | Starts driver.<br/><br/>See also [startDriver on forum](https://www.elektroda.com/rtvforum/find.php?q=startDriver). | 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.<br/><br/>See also [startScript on forum](https://www.elektroda.com/rtvforum/find.php?q=startScript). | File: cmnds/cmd_script.c<br/>Function: CMD_StartScript |
| StartTest | Test_Cmd_Start | .<br/><br/>See also [StartTest on forum](https://www.elektroda.com/rtvforum/find.php?q=StartTest). | File: driver/drv_test.c<br/>Function: NULL); |
| 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.<br/><br/>See also [StartupCommand on forum](https://www.elektroda.com/rtvforum/find.php?q=StartupCommand). | File: cmnds/cmd_main.c<br/>Function: CMD_StartupCommand |
| State | NULL | A stub for Tasmota.<br/><br/>See also [State on forum](https://www.elektroda.com/rtvforum/find.php?q=State). | File: cmnds/cmd_tasmota.c<br/>Function: cmnd_stub |
| Status | NULL | A stub for Tasmota.<br/><br/>See also [Status on forum](https://www.elektroda.com/rtvforum/find.php?q=Status). | File: cmnds/cmd_tasmota.c<br/>Function: cmnd_stub |
| stopAllScripts | | Stops all running scripts.<br/><br/>See also [stopAllScripts on forum](https://www.elektroda.com/rtvforum/find.php?q=stopAllScripts). | File: cmnds/cmd_script.c<br/>Function: CMD_StopAllScripts |
| stopBerry | CMD_StopBerryCommand | .<br/><br/>See also [stopBerry on forum](https://www.elektroda.com/rtvforum/find.php?q=stopBerry). | File: cmnds/cmd_berry.c<br/>Function: NULL); |
| stopDriver | [DriverName] | Stops driver.<br/><br/>See also [stopDriver on forum](https://www.elektroda.com/rtvforum/find.php?q=stopDriver). | File: driver/drv_main.c<br/>Function: DRV_Stop |
| stopScript | [UniqueID] | Force-stop given script thread by ID.<br/><br/>See also [stopScript on forum](https://www.elektroda.com/rtvforum/find.php?q=stopScript). | File: cmnds/cmd_script.c<br/>Function: CMD_StopScript |
| SwingH | CMD_SwingH | .<br/><br/>See also [SwingH on forum](https://www.elektroda.com/rtvforum/find.php?q=SwingH). | File: driver/drv_tclAC.c<br/>Function: NULL); |
| SwingV | CMD_SwingV | .<br/><br/>See also [SwingV on forum](https://www.elektroda.com/rtvforum/find.php?q=SwingV). | File: driver/drv_tclAC.c<br/>Function: NULL); |
| TargetTemperature | CMD_TargetTemperature | .<br/><br/>See also [TargetTemperature on forum](https://www.elektroda.com/rtvforum/find.php?q=TargetTemperature). | File: driver/drv_tclAC.c<br/>Function: NULL); |
| 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.<br/><br/>See also [TasTeleInterval on forum](https://www.elektroda.com/rtvforum/find.php?q=TasTeleInterval). | File: mqtt/new_mqtt.c<br/>Function: MQTT_SetTasTeleIntervals |
| testArgs | | Test tokenizer for args and print back all the given args to console.<br/><br/>See also [testArgs on forum](https://www.elektroda.com/rtvforum/find.php?q=testArgs). | File: cmnds/cmd_test.c<br/>Function: testArgs |
| testAtoi | | Test atoi function.<br/><br/>See also [testAtoi on forum](https://www.elektroda.com/rtvforum/find.php?q=testAtoi). | File: cmnds/cmd_test.c<br/>Function: testArgs |
| TestChannelSetToExpression | CMD_TestChannelSetToExpression | .<br/><br/>See also [TestChannelSetToExpression on forum](https://www.elektroda.com/rtvforum/find.php?q=TestChannelSetToExpression). | File: cmnds/cmd_test.c<br/>Function: NULL); |
| testFloats | | Do some more test printfs with floating point numbers.<br/><br/>See also [testFloats on forum](https://www.elektroda.com/rtvforum/find.php?q=testFloats). | File: cmnds/cmd_test.c<br/>Function: testFloats |
| TestIPtoStr | CMD_TestIPtoStr | .<br/><br/>See also [TestIPtoStr on forum](https://www.elektroda.com/rtvforum/find.php?q=TestIPtoStr). | File: cmnds/cmd_test.c<br/>Function: NULL); |
| testJSON | | Test the JSON library.<br/><br/>See also [testJSON on forum](https://www.elektroda.com/rtvforum/find.php?q=testJSON). | File: cmnds/cmd_test.c<br/>Function: testJSON |
| testLog | | Do some test printfs to log with integer and a float.<br/><br/>See also [testLog on forum](https://www.elektroda.com/rtvforum/find.php?q=testLog). | File: cmnds/cmd_test.c<br/>Function: testLog |
| testMallocFree | | Test malloc and free functionality to see if the device crashes.<br/><br/>See also [testMallocFree on forum](https://www.elektroda.com/rtvforum/find.php?q=testMallocFree). | File: cmnds/cmd_test.c<br/>Function: testMallocFree |
| TestMemcmp | CMD_TestMemcmp | .<br/><br/>See also [TestMemcmp on forum](https://www.elektroda.com/rtvforum/find.php?q=TestMemcmp). | File: cmnds/cmd_test.c<br/>Function: NULL); |
| TestMemcpy | CMD_TestMemcpy | .<br/><br/>See also [TestMemcpy on forum](https://www.elektroda.com/rtvforum/find.php?q=TestMemcpy). | File: cmnds/cmd_test.c<br/>Function: NULL); |
| TestMemset | CMD_TestMemset | .<br/><br/>See also [TestMemset on forum](https://www.elektroda.com/rtvforum/find.php?q=TestMemset). | File: cmnds/cmd_test.c<br/>Function: NULL); |
| TestParseIP | CMD_TestParseIP | .<br/><br/>See also [TestParseIP on forum](https://www.elektroda.com/rtvforum/find.php?q=TestParseIP). | File: cmnds/cmd_test.c<br/>Function: NULL); |
| testRealloc | | Test realloc and free functions to see if the device crashes.<br/><br/>See also [testRealloc on forum](https://www.elektroda.com/rtvforum/find.php?q=testRealloc). | File: cmnds/cmd_test.c<br/>Function: testRealloc |
| TestSprintfForFloat | CMD_TestSprintfForFloat | .<br/><br/>See also [TestSprintfForFloat on forum](https://www.elektroda.com/rtvforum/find.php?q=TestSprintfForFloat). | File: cmnds/cmd_test.c<br/>Function: NULL); |
| TestSprintfForHex | CMD_TestSprintfForHex | .<br/><br/>See also [TestSprintfForHex on forum](https://www.elektroda.com/rtvforum/find.php?q=TestSprintfForHex). | File: cmnds/cmd_test.c<br/>Function: NULL); |
| TestSprintfForInteger | CMD_TestSprintfForInteger | .<br/><br/>See also [TestSprintfForInteger on forum](https://www.elektroda.com/rtvforum/find.php?q=TestSprintfForInteger). | File: cmnds/cmd_test.c<br/>Function: NULL); |
| TestStrcat | CMD_TestStrcat | .<br/><br/>See also [TestStrcat on forum](https://www.elektroda.com/rtvforum/find.php?q=TestStrcat). | File: cmnds/cmd_test.c<br/>Function: NULL); |
| TestStrcmp | CMD_TestStrcmp | .<br/><br/>See also [TestStrcmp on forum](https://www.elektroda.com/rtvforum/find.php?q=TestStrcmp). | File: cmnds/cmd_test.c<br/>Function: NULL); |
| TestStrcpy | CMD_TestStrcpy | .<br/><br/>See also [TestStrcpy on forum](https://www.elektroda.com/rtvforum/find.php?q=TestStrcpy). | File: cmnds/cmd_test.c<br/>Function: NULL); |
| testStrdup | | Test strdup function to see if it allocs news string correctly, also test freeing the string.<br/><br/>See also [testStrdup on forum](https://www.elektroda.com/rtvforum/find.php?q=testStrdup). | File: cmnds/cmd_test.c<br/>Function: testStrdup |
| TestStrlen | CMD_TestStrlen | .<br/><br/>See also [TestStrlen on forum](https://www.elektroda.com/rtvforum/find.php?q=TestStrlen). | File: cmnds/cmd_test.c<br/>Function: NULL); |
| TestStrncpy | CMD_TestStrncpy | .<br/><br/>See also [TestStrncpy on forum](https://www.elektroda.com/rtvforum/find.php?q=TestStrncpy). | File: cmnds/cmd_test.c<br/>Function: NULL); |
| TimeSize | | Prints the size of time_t on current platform - sizeof(time_t), only for testing purposes.<br/><br/>See also [TimeSize on forum](https://www.elektroda.com/rtvforum/find.php?q=TimeSize). | File: cmnds/cmd_main.c<br/>Function: NULL); |
| TM1650_Test | CMD_TM1650_Test | .<br/><br/>See also [TM1650_Test on forum](https://www.elektroda.com/rtvforum/find.php?q=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.<br/><br/>See also [TMGN_Brightness on forum](https://www.elektroda.com/rtvforum/find.php?q=TMGN_Brightness). | File: driver/drv_tm_gn_display_shared.c<br/>Function: NULL); |
@ -329,6 +364,7 @@ Do not add anything here, as it will overwritten with next rebuild.
| 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).<br/><br/>See also [VCPPublishThreshold on forum](https://www.elektroda.com/rtvforum/find.php?q=VCPPublishThreshold). | 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.<br/><br/>See also [VoltageSet on forum](https://www.elektroda.com/rtvforum/find.php?q=VoltageSet). | 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.<br/><br/>See also [waitFor on forum](https://www.elektroda.com/rtvforum/find.php?q=waitFor). | File: cmnds/cmd_script.c<br/>Function: CMD_waitFor |
| WebServer | [0 - Stop / 1 - Start] | Setting state of WebServer.<br/><br/>See also [WebServer on forum](https://www.elektroda.com/rtvforum/find.php?q=WebServer). | File: cmnds/cmd_main.c<br/>Function: CMD_WebServer |
| widget_clearAll | | Removes all registered widgets.<br/><br/>See also [widget_clearAll on forum](https://www.elektroda.com/rtvforum/find.php?q=widget_clearAll). | File: driver/drv_widget.c<br/>Function: NULL); |
| widget_create | [LocationIndex][bAllowCache][FileName] | .<br/><br/>See also [widget_create on forum](https://www.elektroda.com/rtvforum/find.php?q=widget_create). | File: driver/drv_widget.c<br/>Function: NULL); |

47
docs/commands.md
View File

@ -9,6 +9,7 @@ Do not add anything here, as it will overwritten with next rebuild.
| Command | Arguments | Description |
|:------------- |:------------- | -----:|
| AB_Map | [int] | Sets margines for ADC button codes. For given N margins, there are N+1 possible ADC button values (one should be reserved for 'no button').<br/><br/>See also [AB_Map on forum](https://www.elektroda.com/rtvforum/find.php?q=AB_Map). |
| ACMode | CMD_ACMode | .<br/><br/>See also [ACMode on forum](https://www.elektroda.com/rtvforum/find.php?q=ACMode). |
| ADCSmoother | [Pindex] [TotalSamples] [SampleIntervalMS] [TargetChannelADCValue] [MarginValue] [TargetChannel0or1] | Starts the ADC smoother with given configuration.<br/><br/>See also [ADCSmoother on forum](https://www.elektroda.com/rtvforum/find.php?q=ADCSmoother). |
| 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'.<br/><br/>See also [AddChangeHandler on forum](https://www.elektroda.com/rtvforum/find.php?q=AddChangeHandler). |
| 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.<br/><br/>See also [AddChannel on forum](https://www.elektroda.com/rtvforum/find.php?q=AddChannel). |
@ -34,6 +35,8 @@ Do not add anything here, as it will overwritten with next rebuild.
| backlog | [string of commands separated with ;] | Run a sequence of ; separated commands.<br/><br/>See also [backlog on forum](https://www.elektroda.com/rtvforum/find.php?q=backlog). |
| Battery_cycle | [int] | Change cycle of measurement by default every 10 seconds.<br/><br/>Example: Battery_cycle 60<br/><br/>See also [Battery_cycle on forum](https://www.elektroda.com/rtvforum/find.php?q=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/><br/>Example: Battery_Setup 1500 3000 2 2400 4096<br/><br/>See also [Battery_Setup on forum](https://www.elektroda.com/rtvforum/find.php?q=Battery_Setup). |
| berry | CMD_Berry | .<br/><br/>See also [berry on forum](https://www.elektroda.com/rtvforum/find.php?q=berry). |
| BL0942opts | opts | BL0942opts 0= default mode (as set in config Flag 26), 3= two BL0942 on both UARTs (bit0 BL0942 on UART1, bit1 BL0942 on UART2).<br/><br/>See also [BL0942opts on forum](https://www.elektroda.com/rtvforum/find.php?q=BL0942opts). |
| BMPI2C_Calibrate | [DeltaTemp][DeltaPressure][DeltaHumidity] | Calibrate the BMPI2C Sensor.<br/><br/>Example: BMPI2C_Calibrate -4 0 10 <br /> meaning -4 on current temp reading, 0 on current pressure reading and +10 on current humidity reading<br/><br/>See also [BMPI2C_Calibrate on forum](https://www.elektroda.com/rtvforum/find.php?q=BMPI2C_Calibrate). |
| BMPI2C_Configure | [Mode][TempSampling][PressureSampling][HumSampling][IIRFilter][StandbyTime] | Manual sensor configuration. Modes: 0 - normal, 1 - forced, 2 - sleep. Overampling range: -1 - skipped, 2^0 to 2^4. Default is X1. IIRFilter range: 0 - off, 2^1 to 2^4 for most, up to 2^7 for BME68X, StandbyTime: 1 for 0.5ms, 63 for 62.5ms, 125, 250, 500, 1000, 2000, 4000. Mode and StandbyTime are not needed on BME68X, All values will be rounded down to closest available (like sampling 10 will choose 8x).<br/><br/>Example: BMPI2C_Configure 0 8 2 4 16 125 <br /><br/><br/>See also [BMPI2C_Configure on forum](https://www.elektroda.com/rtvforum/find.php?q=BMPI2C_Configure). |
| BMPI2C_Cycle | [IntervalSeconds] | This is the interval between measurements in seconds, by default 1. Max is 255.<br/><br/>Example: BMPI2C_Cycle 60 <br /> measurement is taken every 60 seconds<br/><br/>See also [BMPI2C_Cycle on forum](https://www.elektroda.com/rtvforum/find.php?q=BMPI2C_Cycle). |
@ -44,6 +47,7 @@ Do not add anything here, as it will overwritten with next rebuild.
| 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.<br/><br/>See also [BP5758D_Map on forum](https://www.elektroda.com/rtvforum/find.php?q=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.<br/><br/>See also [BP5758D_RGBCW on forum](https://www.elektroda.com/rtvforum/find.php?q=BP5758D_RGBCW). |
| BridgePulseLength | [FloatValue] | Setup value for bridge pulse len.<br/><br/>See also [BridgePulseLength on forum](https://www.elektroda.com/rtvforum/find.php?q=BridgePulseLength). |
| Buzzer | CMD_Buzzer | .<br/><br/>See also [Buzzer on forum](https://www.elektroda.com/rtvforum/find.php?q=Buzzer). |
| cancelRepeatingEvent | [UserIDInteger] | Stops a given repeating event with a specified ID.<br/><br/>See also [cancelRepeatingEvent on forum](https://www.elektroda.com/rtvforum/find.php?q=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.<br/><br/>See also [Ch on forum](https://www.elektroda.com/rtvforum/find.php?q=Ch). |
| chart_add | [ntp_time][val1][val2]...[valN] | Adds data to the chart with specified variables at a specific NTP time. See [tutorial](https://www.elektroda.com/rtvforum/topic4075289.html).<br/><br/>See also [chart_add on forum](https://www.elektroda.com/rtvforum/find.php?q=chart_add). |
@ -64,10 +68,12 @@ Do not add anything here, as it will overwritten with next rebuild.
| clearIO | | Clears all pins setting, channels settings.<br/><br/>See also [clearIO on forum](https://www.elektroda.com/rtvforum/find.php?q=clearIO). |
| ClearNoPingTime | | Command for ping watchdog; it sets the 'time since last ping reply' to 0 again.<br/><br/>See also [ClearNoPingTime on forum](https://www.elektroda.com/rtvforum/find.php?q=ClearNoPingTime). |
| clearRepeatingEvents | | Clears all repeating events.<br/><br/>See also [clearRepeatingEvents on forum](https://www.elektroda.com/rtvforum/find.php?q=clearRepeatingEvents). |
| CLOCK_CalcDST | [nthWeekEnd monthEnd dayEnd hourEnd nthWeekStart monthStart dayStart hourStart [g_DSToffset hours - default is 1 if unset] | Checks, if actual time is during DST or not.<br/><br/>See also [CLOCK_CalcDST on forum](https://www.elektroda.com/rtvforum/find.php?q=CLOCK_CalcDST). |
| clock_calcDST | CLOCK_CalcDST | .<br/><br/>See also [clock_calcDST on forum](https://www.elektroda.com/rtvforum/find.php?q=clock_calcDST). |
| Color | [HexValue] | Puts the LED driver in RGB mode and sets given color.<br/><br/>See also [Color on forum](https://www.elektroda.com/rtvforum/find.php?q=Color). |
| ConsumptionThreshold | [FloatValue] | Setup value for automatic save of consumption data [1..100].<br/><br/>See also [ConsumptionThreshold on forum](https://www.elektroda.com/rtvforum/find.php?q=ConsumptionThreshold). |
| crashNull | | Causes a crash.<br/><br/>See also [crashNull on forum](https://www.elektroda.com/rtvforum/find.php?q=crashNull). |
| CT | [TempValue] | Same as led_temperature.<br/><br/>See also [CT on forum](https://www.elektroda.com/rtvforum/find.php?q=CT). |
| CT | [TempValue] | Sets the LED temperature. Same as led_temperature but with Tasmota syntax.<br/><br/>See also [CT on forum](https://www.elektroda.com/rtvforum/find.php?q=CT). |
| CTRange | [MinRange][MaxRange] | This sets the temperature range for display. Default is 154-500.<br/><br/>See also [CTRange on forum](https://www.elektroda.com/rtvforum/find.php?q=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.<br/><br/>See also [CurrentSet on forum](https://www.elektroda.com/rtvforum/find.php?q=CurrentSet). |
| 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.<br/><br/>See also [DeepSleep on forum](https://www.elektroda.com/rtvforum/find.php?q=DeepSleep). |
@ -77,15 +83,18 @@ Do not add anything here, as it will overwritten with next rebuild.
| 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.<br/><br/>See also [DGR_SendFixedColor on forum](https://www.elektroda.com/rtvforum/find.php?q=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.<br/><br/>See also [DGR_SendPower on forum](https://www.elektroda.com/rtvforum/find.php?q=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.<br/><br/>See also [DGR_SendRGBCW on forum](https://www.elektroda.com/rtvforum/find.php?q=DGR_SendRGBCW). |
| Dimmer | [Value] | Alias for led_dimmer.<br/><br/>See also [Dimmer on forum](https://www.elektroda.com/rtvforum/find.php?q=Dimmer). |
| Dimmer | [Value] | Alias for led_dimmer, added for Tasmota.<br/><br/>See also [Dimmer on forum](https://www.elektroda.com/rtvforum/find.php?q=Dimmer). |
| DimmerDelta | [DeltaValue] | This sets the delta value for SmartDimmer/SmartButtonForLEDs hold event. This determines the amount of change of dimmer per hold event.<br/><br/>See also [DimmerDelta on forum](https://www.elektroda.com/rtvforum/find.php?q=DimmerDelta). |
| Display | CMD_Display | .<br/><br/>See also [Display on forum](https://www.elektroda.com/rtvforum/find.php?q=Display). |
| DS1820_SetResolution | [int] | Sets resolution for connected DS1820 sensor (9/10/11/12 bits).<br/><br/>See also [DS1820_SetResolution on forum](https://www.elektroda.com/rtvforum/find.php?q=DS1820_SetResolution). |
| DSEdge | [edgeCode][optionalPinIndex] | 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. Second argument is optional and allows to set per-pin DSEdge instead of setting it for all pins.<br/><br/>See also [DSEdge on forum](https://www.elektroda.com/rtvforum/find.php?q=DSEdge). |
| DSTime | [timeSeconds][optionalAutoWakeUpTimeSeconds] | 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. You can also use this to extend current awake time (at runtime) with syntax: 'DSTime +10', this will make device stay awake 10 seconds longer. You can also restart current value of awake counter by 'DSTime clear', this will make counter go from 0 again.<br/><br/>See also [DSTime on forum](https://www.elektroda.com/rtvforum/find.php?q=DSTime). |
| 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.<br/><br/>See also [echo on forum](https://www.elektroda.com/rtvforum/find.php?q=echo). |
| EnergyCntReset | [OptionalNewValue] | Resets the total Energy Counter, the one that is usually kept after device reboots. After this commands, the counter will start again from 0 (or from the value you specified).<br/><br/>See also [EnergyCntReset on forum](https://www.elektroda.com/rtvforum/find.php?q=EnergyCntReset). |
| EnergyCntReset | [OptionalNewValue][sensorix] | Resets the total Energy Counter, the one that is usually kept after device reboots. After this commands, the counter will start again from 0 (or from the value you specified). sensorix is used in ENABLE_BL_TWIN.<br/><br/>See also [EnergyCntReset on forum](https://www.elektroda.com/rtvforum/find.php?q=EnergyCntReset). |
| exec | [Filename] | Exec <file> - run autoexec.bat or other file from LFS if present.<br/><br/>See also [exec on forum](https://www.elektroda.com/rtvforum/find.php?q=exec). |
| ExitSimulator | | [SIMULATOR ONLY] Exits the application instance.<br/><br/>See also [ExitSimulator on forum](https://www.elektroda.com/rtvforum/find.php?q=ExitSimulator). |
| fakeTuyaPacket | [HexString] | This simulates packet being sent from TuyaMCU to our OBK device.<br/><br/>See also [fakeTuyaPacket on forum](https://www.elektroda.com/rtvforum/find.php?q=fakeTuyaPacket). |
| FANMode | CMD_FANMode | .<br/><br/>See also [FANMode on forum](https://www.elektroda.com/rtvforum/find.php?q=FANMode). |
| flags | [IntegerValue] | Sets the device flags.<br/><br/>See also [flags on forum](https://www.elektroda.com/rtvforum/find.php?q=flags). |
| FriendlyName | [Name] | Sets the full name of the device.<br/><br/>See also [FriendlyName on forum](https://www.elektroda.com/rtvforum/find.php?q=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.<br/><br/>See also [FullBootTime on forum](https://www.elektroda.com/rtvforum/find.php?q=FullBootTime). |
@ -104,8 +113,11 @@ Do not add anything here, as it will overwritten with next rebuild.
| HT16K33_Test | HT16K33_Test | .<br/><br/>See also [HT16K33_Test on forum](https://www.elektroda.com/rtvforum/find.php?q=HT16K33_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.<br/><br/>See also [if on forum](https://www.elektroda.com/rtvforum/find.php?q=if). |
| IndexRefreshInterval | [Interval] | .<br/><br/>See also [IndexRefreshInterval on forum](https://www.elektroda.com/rtvforum/find.php?q=IndexRefreshInterval). |
| IRAC | [TODO] | Sends IR commands for HVAC control (TODO).<br/><br/>See also [IRAC on forum](https://www.elektroda.com/rtvforum/find.php?q=IRAC). |
| 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.<br/><br/>See also [IREnable on forum](https://www.elektroda.com/rtvforum/find.php?q=IREnable). |
| IRParam | [MinSize] [Noise Threshold] | Set minimal size of the message and noise threshold.<br/><br/>See also [IRParam on forum](https://www.elektroda.com/rtvforum/find.php?q=IRParam). |
| IRSend | [PROT-ADDR-CMD-REP-BITS] | Sends IR commands in the form PROT-ADDR-CMD-REP-BITS, e.g. NEC-1-1A-0-0, note that -BITS is optional, it can be 0 for default one, so you can just do NEC-1-1A-0.<br/><br/>See also [IRSend on forum](https://www.elektroda.com/rtvforum/find.php?q=IRSend). |
| Json | json array of commands | A stub for Tasmota.<br/><br/>See also [Json on forum](https://www.elektroda.com/rtvforum/find.php?q=Json). |
| json_test | | Developer-only command used to test CJSON library.<br/><br/>See also [json_test on forum](https://www.elektroda.com/rtvforum/find.php?q=json_test). |
| KP18058_Current | [RGBLimit][CWLimit] | Sets the maximum current for LED driver. Values 0-31. Example usage: KP18058_Current 14 30.<br/><br/>See also [KP18058_Current on forum](https://www.elektroda.com/rtvforum/find.php?q=KP18058_Current). |
| KP18058_Map | [Ch0][Ch1][Ch2][Ch3][Ch4] | Maps KP18058_Map RGBCW values to given indices of KP18058 channels. This is because KP18058 channels order is not the same for some devices. Some devices are using RGBCW order and some are using GBRCW, etc, etc. Example usage: KP18058_Map 0 1 2 3 4.<br/><br/>See also [KP18058_Map on forum](https://www.elektroda.com/rtvforum/find.php?q=KP18058_Map). |
@ -135,6 +147,7 @@ Do not add anything here, as it will overwritten with next rebuild.
| lfs_appendInt | [FileName][Int] | Appends a Int to LFS file.<br/><br/>See also [lfs_appendInt on forum](https://www.elektroda.com/rtvforum/find.php?q=lfs_appendInt). |
| lfs_appendLine | [FileName][String] | Appends a string to LFS file with a next line marker.<br/><br/>See also [lfs_appendLine on forum](https://www.elektroda.com/rtvforum/find.php?q=lfs_appendLine). |
| lfs_format | | Unmount and format LFS. Optionally add new size as argument.<br/><br/>See also [lfs_format on forum](https://www.elektroda.com/rtvforum/find.php?q=lfs_format). |
| lfs_mkdir | CMD_LFS_MakeDirectory | .<br/><br/>See also [lfs_mkdir on forum](https://www.elektroda.com/rtvforum/find.php?q=lfs_mkdir). |
| lfs_mount | | Mount LFS.<br/><br/>See also [lfs_mount on forum](https://www.elektroda.com/rtvforum/find.php?q=lfs_mount). |
| lfs_remove | [FileName] | Deletes a LittleFS file.<br/><br/>See also [lfs_remove on forum](https://www.elektroda.com/rtvforum/find.php?q=lfs_remove). |
| lfs_size | [MaxSize] | Log or Set LFS size - will apply and re-format next boot, usage setlfssize 0x10000.<br/><br/>See also [lfs_size on forum](https://www.elektroda.com/rtvforum/find.php?q=lfs_size). |
@ -144,7 +157,7 @@ Do not add anything here, as it will overwritten with next rebuild.
| lfs_unmount | | Un-mount LFS.<br/><br/>See also [lfs_unmount on forum](https://www.elektroda.com/rtvforum/find.php?q=lfs_unmount). |
| lfs_write | [FileName][String] | Resets a LFS file and writes a new string to it.<br/><br/>See also [lfs_write on forum](https://www.elektroda.com/rtvforum/find.php?q=lfs_write). |
| lfs_writeLine | [FileName][String] | Resets a LFS file and writes a new string to it with newline.<br/><br/>See also [lfs_writeLine on forum](https://www.elektroda.com/rtvforum/find.php?q=lfs_writeLine). |
| linkTuyaMCUOutputToChannel | [dpId][varType][channelID][bDPCache-Optional][mult-optional][bInverse] | 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).<br/><br/>See also [linkTuyaMCUOutputToChannel on forum](https://www.elektroda.com/rtvforum/find.php?q=linkTuyaMCUOutputToChannel). |
| linkTuyaMCUOutputToChannel | [dpId][varType][channelID][bDPCache-Optional][mult-optional][bInverse-Optional][delta-Optional][delta2][delta3] | Used to map between TuyaMCU dpIDs and our internal channels. Mult, inverse and delta are for calibration, they are optional. bDPCache is also optional, 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).<br/><br/>See also [linkTuyaMCUOutputToChannel on forum](https://www.elektroda.com/rtvforum/find.php?q=linkTuyaMCUOutputToChannel). |
| listClockEvents | | Print the complete set clock events list.<br/><br/>See also [listClockEvents on forum](https://www.elektroda.com/rtvforum/find.php?q=listClockEvents). |
| listEventHandlers | | Prints full list of added event handlers.<br/><br/>See also [listEventHandlers on forum](https://www.elektroda.com/rtvforum/find.php?q=listEventHandlers). |
| listRepeatingEvents | | Lists all repeating events.<br/><br/>See also [listRepeatingEvents on forum](https://www.elektroda.com/rtvforum/find.php?q=listRepeatingEvents). |
@ -166,6 +179,7 @@ Do not add anything here, as it will overwritten with next rebuild.
| MCP9808_Calibrate | [DeltaTemperature] | .<br/><br/>See also [MCP9808_Calibrate on forum](https://www.elektroda.com/rtvforum/find.php?q=MCP9808_Calibrate). |
| MCP9808_Cycle | [DelayInSeconds] | Sets MCP9808 measurement interval.<br/><br/>See also [MCP9808_Cycle on forum](https://www.elektroda.com/rtvforum/find.php?q=MCP9808_Cycle). |
| MqttClient | [ValueString] | Sets the MQTT client. Command keeps Tasmota syntax.<br/><br/>See also [MqttClient on forum](https://www.elektroda.com/rtvforum/find.php?q=MqttClient). |
| MqttGroup | [ValueString] | Sets the MQTT Group topic. Command keeps Tasmota syntax.<br/><br/>See also [MqttGroup on forum](https://www.elektroda.com/rtvforum/find.php?q=MqttGroup). |
| MqttHost | [ValueString] | Sets the MQTT host. Command keeps Tasmota syntax.<br/><br/>See also [MqttHost on forum](https://www.elektroda.com/rtvforum/find.php?q=MqttHost). |
| MqttPassword | [ValueString] | Sets the MQTT pass. Command keeps Tasmota syntax.<br/><br/>See also [MqttPassword on forum](https://www.elektroda.com/rtvforum/find.php?q=MqttPassword). |
| MqttUser | [ValueString] | Sets the MQTT user. Command keeps Tasmota syntax.<br/><br/>See also [MqttUser on forum](https://www.elektroda.com/rtvforum/find.php?q=MqttUser). |
@ -229,6 +243,7 @@ Do not add anything here, as it will overwritten with next rebuild.
| 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...<br/><br/>See also [SetChannelVisible on forum](https://www.elektroda.com/rtvforum/find.php?q=SetChannelVisible). |
| SetFlag | [FlagIndex][0or1] | Sets given flag.<br/><br/>See also [SetFlag on forum](https://www.elektroda.com/rtvforum/find.php?q=SetFlag). |
| SetFlash | [FlashIndex][FlashValue] | Sets a a flashVars channel directly (if you are using remember state for given channel, it will overwrite, it uses same space for channels memory).<br/><br/>See also [SetFlash on forum](https://www.elektroda.com/rtvforum/find.php?q=SetFlash). |
| setMovingAvg | MovingAvg | Moving average value for power and current. <=1 disable, >=2 count of avg values. The setting is temporary and need to be set at startup.<br/><br/>See also [setMovingAvg on forum](https://www.elektroda.com/rtvforum/find.php?q=setMovingAvg). |
| SetPinChannel | [PinIndex][ChannelIndex][optionalChannel2Index] | 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.<br/><br/>See also [SetPinChannel on forum](https://www.elektroda.com/rtvforum/find.php?q=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.<br/><br/>See also [SetPinRole on forum](https://www.elektroda.com/rtvforum/find.php?q=SetPinRole). |
| setStartupSSID | [Value] | Sets startup SSID, 0 (SSID0) 1 (SSID1).<br/><br/>See also [setStartupSSID on forum](https://www.elektroda.com/rtvforum/find.php?q=setStartupSSID). |
@ -241,7 +256,7 @@ Do not add anything here, as it will overwritten with next rebuild.
| SGP_GetBaseline | | SGP Get baseline.<br/><br/>Example: SGP_GetBaseline<br/><br/>See also [SGP_GetBaseline on forum](https://www.elektroda.com/rtvforum/find.php?q=SGP_GetBaseline). |
| SGP_GetVersion | | SGP : get version.<br/><br/>Example: SGP_GetVersion<br/><br/>See also [SGP_GetVersion on forum](https://www.elektroda.com/rtvforum/find.php?q=SGP_GetVersion). |
| SGP_SoftReset | | SGP i2C soft reset.<br/><br/>Example: SGP_SoftReset<br/><br/>See also [SGP_SoftReset on forum](https://www.elektroda.com/rtvforum/find.php?q=SGP_SoftReset). |
| ShortName | [Name] | Sets the short name of the device.<br/><br/>See also [ShortName on forum](https://www.elektroda.com/rtvforum/find.php?q=ShortName). |
| ShortName | [Name] | Sets the short name of the device. This is used as topic for MQTT, for example, for cmnd/obk123121/power etc MQTT calls.<br/><br/>See also [ShortName on forum](https://www.elektroda.com/rtvforum/find.php?q=ShortName). |
| showChannelValues | | Log channel values.<br/><br/>See also [showChannelValues on forum](https://www.elektroda.com/rtvforum/find.php?q=showChannelValues). |
| showgpi | NULL | Log stat of all GPIs.<br/><br/>See also [showgpi on forum](https://www.elektroda.com/rtvforum/find.php?q=showgpi). |
| SHT_Calibrate | [DeltaTemp][DeltaHumidity] | Calibrate the SHT Sensor as Tolerance is +/-2 degrees C.<br/><br/>Example: SHT_Calibrate -4 10<br/><br/>See also [SHT_Calibrate on forum](https://www.elektroda.com/rtvforum/find.php?q=SHT_Calibrate). |
@ -276,20 +291,40 @@ Do not add anything here, as it will overwritten with next rebuild.
| stackOverflow | | Causes a stack overflow.<br/><br/>See also [stackOverflow on forum](https://www.elektroda.com/rtvforum/find.php?q=stackOverflow). |
| startDriver | [DriverName] | Starts driver.<br/><br/>See also [startDriver on forum](https://www.elektroda.com/rtvforum/find.php?q=startDriver). |
| startScript | [FileName][Label][UniqueID] | Starts a script thread from given file, at given label - can be * for whole file, with given unique ID.<br/><br/>See also [startScript on forum](https://www.elektroda.com/rtvforum/find.php?q=startScript). |
| StartTest | Test_Cmd_Start | .<br/><br/>See also [StartTest on forum](https://www.elektroda.com/rtvforum/find.php?q=StartTest). |
| 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.<br/><br/>See also [StartupCommand on forum](https://www.elektroda.com/rtvforum/find.php?q=StartupCommand). |
| State | NULL | A stub for Tasmota.<br/><br/>See also [State on forum](https://www.elektroda.com/rtvforum/find.php?q=State). |
| Status | NULL | A stub for Tasmota.<br/><br/>See also [Status on forum](https://www.elektroda.com/rtvforum/find.php?q=Status). |
| stopAllScripts | | Stops all running scripts.<br/><br/>See also [stopAllScripts on forum](https://www.elektroda.com/rtvforum/find.php?q=stopAllScripts). |
| stopBerry | CMD_StopBerryCommand | .<br/><br/>See also [stopBerry on forum](https://www.elektroda.com/rtvforum/find.php?q=stopBerry). |
| stopDriver | [DriverName] | Stops driver.<br/><br/>See also [stopDriver on forum](https://www.elektroda.com/rtvforum/find.php?q=stopDriver). |
| stopScript | [UniqueID] | Force-stop given script thread by ID.<br/><br/>See also [stopScript on forum](https://www.elektroda.com/rtvforum/find.php?q=stopScript). |
| SwingH | CMD_SwingH | .<br/><br/>See also [SwingH on forum](https://www.elektroda.com/rtvforum/find.php?q=SwingH). |
| SwingV | CMD_SwingV | .<br/><br/>See also [SwingV on forum](https://www.elektroda.com/rtvforum/find.php?q=SwingV). |
| TargetTemperature | CMD_TargetTemperature | .<br/><br/>See also [TargetTemperature on forum](https://www.elektroda.com/rtvforum/find.php?q=TargetTemperature). |
| 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.<br/><br/>See also [TasTeleInterval on forum](https://www.elektroda.com/rtvforum/find.php?q=TasTeleInterval). |
| testArgs | | Test tokenizer for args and print back all the given args to console.<br/><br/>See also [testArgs on forum](https://www.elektroda.com/rtvforum/find.php?q=testArgs). |
| testAtoi | | Test atoi function.<br/><br/>See also [testAtoi on forum](https://www.elektroda.com/rtvforum/find.php?q=testAtoi). |
| TestChannelSetToExpression | CMD_TestChannelSetToExpression | .<br/><br/>See also [TestChannelSetToExpression on forum](https://www.elektroda.com/rtvforum/find.php?q=TestChannelSetToExpression). |
| testFloats | | Do some more test printfs with floating point numbers.<br/><br/>See also [testFloats on forum](https://www.elektroda.com/rtvforum/find.php?q=testFloats). |
| TestIPtoStr | CMD_TestIPtoStr | .<br/><br/>See also [TestIPtoStr on forum](https://www.elektroda.com/rtvforum/find.php?q=TestIPtoStr). |
| testJSON | | Test the JSON library.<br/><br/>See also [testJSON on forum](https://www.elektroda.com/rtvforum/find.php?q=testJSON). |
| testLog | | Do some test printfs to log with integer and a float.<br/><br/>See also [testLog on forum](https://www.elektroda.com/rtvforum/find.php?q=testLog). |
| testMallocFree | | Test malloc and free functionality to see if the device crashes.<br/><br/>See also [testMallocFree on forum](https://www.elektroda.com/rtvforum/find.php?q=testMallocFree). |
| TestMemcmp | CMD_TestMemcmp | .<br/><br/>See also [TestMemcmp on forum](https://www.elektroda.com/rtvforum/find.php?q=TestMemcmp). |
| TestMemcpy | CMD_TestMemcpy | .<br/><br/>See also [TestMemcpy on forum](https://www.elektroda.com/rtvforum/find.php?q=TestMemcpy). |
| TestMemset | CMD_TestMemset | .<br/><br/>See also [TestMemset on forum](https://www.elektroda.com/rtvforum/find.php?q=TestMemset). |
| TestParseIP | CMD_TestParseIP | .<br/><br/>See also [TestParseIP on forum](https://www.elektroda.com/rtvforum/find.php?q=TestParseIP). |
| testRealloc | | Test realloc and free functions to see if the device crashes.<br/><br/>See also [testRealloc on forum](https://www.elektroda.com/rtvforum/find.php?q=testRealloc). |
| TestSprintfForFloat | CMD_TestSprintfForFloat | .<br/><br/>See also [TestSprintfForFloat on forum](https://www.elektroda.com/rtvforum/find.php?q=TestSprintfForFloat). |
| TestSprintfForHex | CMD_TestSprintfForHex | .<br/><br/>See also [TestSprintfForHex on forum](https://www.elektroda.com/rtvforum/find.php?q=TestSprintfForHex). |
| TestSprintfForInteger | CMD_TestSprintfForInteger | .<br/><br/>See also [TestSprintfForInteger on forum](https://www.elektroda.com/rtvforum/find.php?q=TestSprintfForInteger). |
| TestStrcat | CMD_TestStrcat | .<br/><br/>See also [TestStrcat on forum](https://www.elektroda.com/rtvforum/find.php?q=TestStrcat). |
| TestStrcmp | CMD_TestStrcmp | .<br/><br/>See also [TestStrcmp on forum](https://www.elektroda.com/rtvforum/find.php?q=TestStrcmp). |
| TestStrcpy | CMD_TestStrcpy | .<br/><br/>See also [TestStrcpy on forum](https://www.elektroda.com/rtvforum/find.php?q=TestStrcpy). |
| testStrdup | | Test strdup function to see if it allocs news string correctly, also test freeing the string.<br/><br/>See also [testStrdup on forum](https://www.elektroda.com/rtvforum/find.php?q=testStrdup). |
| TestStrlen | CMD_TestStrlen | .<br/><br/>See also [TestStrlen on forum](https://www.elektroda.com/rtvforum/find.php?q=TestStrlen). |
| TestStrncpy | CMD_TestStrncpy | .<br/><br/>See also [TestStrncpy on forum](https://www.elektroda.com/rtvforum/find.php?q=TestStrncpy). |
| TimeSize | | Prints the size of time_t on current platform - sizeof(time_t), only for testing purposes.<br/><br/>See also [TimeSize on forum](https://www.elektroda.com/rtvforum/find.php?q=TimeSize). |
| TM1650_Test | CMD_TM1650_Test | .<br/><br/>See also [TM1650_Test on forum](https://www.elektroda.com/rtvforum/find.php?q=TM1650_Test). |
| TMGN_Brightness | [Brigthness0to7][bOn] | This allows you to change brightness and state of TM1637/GN932/etc display.<br/><br/>See also [TMGN_Brightness on forum](https://www.elektroda.com/rtvforum/find.php?q=TMGN_Brightness). |
@ -332,7 +367,7 @@ Do not add anything here, as it will overwritten with next rebuild.
| 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).<br/><br/>See also [VCPPublishThreshold on forum](https://www.elektroda.com/rtvforum/find.php?q=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.<br/><br/>See also [VoltageSet on forum](https://www.elektroda.com/rtvforum/find.php?q=VoltageSet). |
| 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.<br/><br/>See also [waitFor on forum](https://www.elektroda.com/rtvforum/find.php?q=waitFor). |
| WebServer | [1or0] | Enable/Disable web interface. 1 to Enable. 0 to Disable. No argument, returns the actual state of the web server interface. No effect on safe mode. In safe mode, the web interface is always enabled. |
| WebServer | [0 - Stop / 1 - Start] | Setting state of WebServer.<br/><br/>See also [WebServer on forum](https://www.elektroda.com/rtvforum/find.php?q=WebServer). |
| widget_clearAll | | Removes all registered widgets.<br/><br/>See also [widget_clearAll on forum](https://www.elektroda.com/rtvforum/find.php?q=widget_clearAll). |
| widget_create | [LocationIndex][bAllowCache][FileName] | .<br/><br/>See also [widget_create on forum](https://www.elektroda.com/rtvforum/find.php?q=widget_create). |

1
docs/constants.md
View File

@ -36,6 +36,7 @@ Do not add anything here, as it will overwritten with next rebuild.
| $year | TODO |
| $yesterday | TODO |
| $today | TODO |
| $isDST | TODO |
| $sunrise | TODO |
| $sunset | TODO |
| $NTPOn | Returns 1 if NTP is on and already synced (so device has correct time), otherwise 0. |

6
docs/drivers.md
View File

@ -10,9 +10,11 @@ Do not add anything here, as it will overwritten with next rebuild.
| TuyaMCU | TuyaMCU is a protocol used for communication between WiFI module and external MCU. This protocol is using usually RX1/TX1 port of BK chips. See [TuyaMCU dimmer example](https://www.elektroda.com/rtvforum/topic3929151.html), see [TH06 LCD humidity/temperature sensor example](https://www.elektroda.com/rtvforum/topic3942730.html), see [fan controller example](https://www.elektroda.com/rtvforum/topic3908093.html), see [simple switch example](https://www.elektroda.com/rtvforum/topic3906443.html).<br/>See also [TuyaMCU on forum](https://www.elektroda.com/rtvforum/find.php?q=TuyaMCU). |
| tmSensor | The tmSensor must be used only when TuyaMCU is already started. tmSensor is a TuyaMcu Sensor, it's used for Low Power TuyaMCU communication on devices like TuyaMCU door sensor, or TuyaMCU humidity sensor. After device reboots, tmSensor uses TuyaMCU to request data update from the sensor and reports it on MQTT. Then MCU turns off WiFi module again and goes back to sleep. See an [example door sensor here](https://www.elektroda.com/rtvforum/topic3914412.html).<br/>See also [tmSensor on forum](https://www.elektroda.com/rtvforum/find.php?q=tmSensor). |
| FREEZE | Freeze is a test driver for watchdog. Enabling this will freeze device main loop.<br/>See also [FREEZE on forum](https://www.elektroda.com/rtvforum/find.php?q=FREEZE). |
| PIR | PIR.<br/>See also [PIR on forum](https://www.elektroda.com/rtvforum/find.php?q=PIR). |
| PixelAnim | PixelAnim provides a simple set of WS2812B animations.<br/>See also [PixelAnim on forum](https://www.elektroda.com/rtvforum/find.php?q=PixelAnim). |
| Drawers | WS2812B driver wrapper with REST API for [smart drawers project](https://www.elektroda.com/rtvforum/topic4054134.html).<br/>See also [Drawers on forum](https://www.elektroda.com/rtvforum/find.php?q=Drawers). |
| HGS02 | [HGS02](https://www.elektroda.com/rtvforum/viewtopic.php?p=21177061#21177061).<br/>See also [HGS02 on forum](https://www.elektroda.com/rtvforum/find.php?q=HGS02). |
| TCL | TODO.<br/>See also [TCL on forum](https://www.elektroda.com/rtvforum/find.php?q=TCL). |
| OpenWeatherMap | OpenWeatherMap integration allows you to fetch current weather for your lat/long. You can later extract temperatura, humidity and pressure data and display it on main page.<br/>See also [OpenWeatherMap on forum](https://www.elektroda.com/rtvforum/find.php?q=OpenWeatherMap). |
| Widget | Widget driver allows you to create custom HTML snippets that are displayed on main OBK page. Snippets are loaded from LittleFS file system and can use OBK REST API.<br/>See also [Widget on forum](https://www.elektroda.com/rtvforum/find.php?q=Widget). |
| TestCharts | Development only driver - a sample of chart generation with chart.js.<br/>See also [TestCharts on forum](https://www.elektroda.com/rtvforum/find.php?q=TestCharts). |
@ -21,6 +23,8 @@ Do not add anything here, as it will overwritten with next rebuild.
| HTTPButtons | This driver allows you to create custom, scriptable buttons on main WWW page. You can create those buttons in autoexec.bat and assign commands to them.<br/>See also [HTTPButtons on forum](https://www.elektroda.com/rtvforum/find.php?q=HTTPButtons). |
| TESTPOWER | This is a fake POWER measuring socket driver, only for testing.<br/>See also [TESTPOWER on forum](https://www.elektroda.com/rtvforum/find.php?q=TESTPOWER). |
| TESTLED | This is a fake I2C LED driver, only for testing.<br/>See also [TESTLED on forum](https://www.elektroda.com/rtvforum/find.php?q=TESTLED). |
| TESTUART | G.<br/>See also [TESTUART on forum](https://www.elektroda.com/rtvforum/find.php?q=TESTUART). |
| Test | Self test of the device.<br/>See also [Test on forum](https://www.elektroda.com/rtvforum/find.php?q=Test). |
| I2C | Generic I2C, not used for LED drivers, but may be useful for displays or port expanders. Supports both hardware and software I2C.<br/>See also [I2C on forum](https://www.elektroda.com/rtvforum/find.php?q=I2C). |
| RN8209 | WIP driver for power-metering chip RN8209 found in one of Zmai-90 versions.<br/>See also [RN8209 on forum](https://www.elektroda.com/rtvforum/find.php?q=RN8209). |
| BL0942 | BL0942 is a power-metering chip which uses UART protocol for communication. It's usually connected to TX1/RX1 port of BK. You need to calibrate power metering once, just like in Tasmota. See [LSPA9 teardown example](https://www.elektroda.com/rtvforum/topic3887748.html). By default, it uses 4800 baud, but you can also enable it with baud 9600 by using 'startDriver BL0942 9600', see [related topic](https://www.elektroda.com/rtvforum/viewtopic.php?p=20957896#20957896).<br/>See also [BL0942 on forum](https://www.elektroda.com/rtvforum/find.php?q=BL0942). |
@ -28,6 +32,7 @@ Do not add anything here, as it will overwritten with next rebuild.
| BL0942SPI | BL0942 driver version for SPI protocol. It's usually connected to SPI1 port of BK. You need to calibrate power metering once, just like in Tasmota. See [PZIOT-E01 teardown example](https://www.elektroda.com/rtvforum/topic3945667.html). .<br/>See also [BL0942SPI on forum](https://www.elektroda.com/rtvforum/find.php?q=BL0942SPI). |
| ChargingLimit | Mechanism to perform an action based on a max. delta value and max time. Used to control Electric Vehicle chargers. See [discussion](https://github.com/openshwprojects/OpenBK7231T_App/issues/892).<br/>See also [ChargingLimit on forum](https://www.elektroda.com/rtvforum/find.php?q=ChargingLimit). |
| BL0937 | BL0937 is a power-metering chip which uses custom protocol to report data. It requires setting 3 pins in pin config: CF, CF1 and SEL.<br/>See also [BL0937 on forum](https://www.elektroda.com/rtvforum/find.php?q=BL0937). |
| CSE7761 | TODO.<br/>See also [CSE7761 on forum](https://www.elektroda.com/rtvforum/find.php?q=CSE7761). |
| CSE7766 | CSE7766 is a power-metering chip which uses UART protocol for communication. It's usually connected to TX1/RX1 port of BK.<br/>See also [CSE7766 on forum](https://www.elektroda.com/rtvforum/find.php?q=CSE7766). |
| MAX6675 | Thermocouple driver for measuring high temperatures, see [presentation](https://www.elektroda.com/rtvforum/topic4055231.html).<br/>See also [MAX6675 on forum](https://www.elektroda.com/rtvforum/find.php?q=MAX6675). |
| PT6523 | Car radio LCD driver, see [teardown and presentation](https://www.elektroda.com/rtvforum/topic3983111.html).<br/>See also [PT6523 on forum](https://www.elektroda.com/rtvforum/find.php?q=PT6523). |
@ -68,3 +73,4 @@ Do not add anything here, as it will overwritten with next rebuild.
| HD2015 | Driver for 7-segment LED display with I2C-like interface. Seems to be compatible with TM1650. HD2015 is very similiar to GN6932 and TM1637. See [this topic](https://www.elektroda.com/rtvforum/topic4052946.html) for details.<br/>See also [HD2015 on forum](https://www.elektroda.com/rtvforum/find.php?q=HD2015). |
| Battery | Custom mechanism to measure battery level with ADC and an optional relay. See [example here](https://www.elektroda.com/rtvforum/topic3959103.html).<br/>See also [Battery on forum](https://www.elektroda.com/rtvforum/find.php?q=Battery). |
| Bridge | A bridge relay driver, added for [TONGOU TO-Q-SY1-JWT Din Rail Switch](https://www.elektroda.com/rtvforum/topic3934580.html). See linked topic for info.<br/>See also [Bridge on forum](https://www.elektroda.com/rtvforum/find.php?q=Bridge). |
| UART to TCP bridge | UART to TCP, mainly for WiFi Zigbee coordinators.<br/>See also [UART to TCP bridge on forum](https://www.elektroda.com/rtvforum/find.php?q=UART to TCP bridge). |

1
docs/flags.md
View File

@ -56,3 +56,4 @@ Do not add anything here, as it will overwritten with next rebuild.
| 48 | [PWR] Invert AC dir |
| 49 | [HTTP] Hide ON/OFF for relays (only red/green buttons) |
| 50 | [MQTT] Never add get sufix |
| 51 | [WiFi] (RTL/BK) Enhanced fast connect by saving AP data to flash (preferable with Flag 37 & static ip). Quick reset 3 times to connect normally |

2
docs/ioRoles.md
View File

@ -84,4 +84,6 @@ Do not add anything here, as it will overwritten with next rebuild.
| KP18058_CLK | QQQ |
| KP18058_DAT | QQQ |
| DS1820 | vers simple OneWire Temp sensor DS1820 |
| PWM_ScriptOnly | |
| PWM_ScriptOnly_n | |
| Total_Options | Current total number of available IOR roles |

28
docs/json/channelTypes.json
View File

@ -370,7 +370,7 @@
{
"name": "Pressure_div100",
"title": "TODO",
"descr": ".",
"descr": "Pressure in hPa, but divided by 100",
"enum": "Pressure_div100",
"file": "new_pins.h",
"driver": ""
@ -386,7 +386,7 @@
{
"name": "LeakageCurrent_div1000",
"title": "TODO",
"descr": ".",
"descr": "Leakage current in mA",
"enum": "ChType_LeakageCurrent_div1000",
"file": "new_pins.h",
"driver": ""
@ -463,6 +463,30 @@
"file": "new_pins.h",
"driver": ""
},
{
"name": "Frequency_div1000",
"title": "TODO",
"descr": "For TuyaMCU power metering. Not used for BL09** and CSE** sensors. Divider is used by TuyaMCU, because TuyaMCU sends always values as integers so we have to divide them before displaying on UI",
"enum": "ChType_Frequency_div1000",
"file": "new_pins.h",
"driver": ""
},
{
"name": "OpenStopClose",
"title": "OpenStopClose",
"descr": "TODO",
"enum": "ChType_OpenStopClose",
"file": "new_pins.h",
"driver": ""
},
{
"name": "Percent",
"title": "Percent",
"descr": "TODO",
"enum": "ChType_Percent",
"file": "new_pins.h",
"driver": ""
},
{
"name": "Max",
"title": "TODO",

338
docs/json/commands.json
View File

@ -8,6 +8,15 @@
"requires": "",
"examples": ""
},
{
"name": "ACMode",
"args": "CMD_ACMode",
"descr": "",
"fn": "NULL);",
"file": "driver/drv_tclAC.c",
"requires": "",
"examples": ""
},
{
"name": "ADCSmoother",
"args": "[Pindex] [TotalSamples] [SampleIntervalMS] [TargetChannelADCValue] [MarginValue] [TargetChannel0or1]",
@ -233,6 +242,24 @@
"requires": "",
"examples": "Battery_Setup 1500 3000 2 2400 4096"
},
{
"name": "berry",
"args": "CMD_Berry",
"descr": "",
"fn": "NULL);",
"file": "cmnds/cmd_berry.c",
"requires": "",
"examples": ""
},
{
"name": "BL0942opts",
"args": "opts",
"descr": "BL0942opts 0= default mode (as set in config Flag 26), 3= two BL0942 on both UARTs (bit0 BL0942 on UART1, bit1 BL0942 on UART2)",
"fn": "NULL);",
"file": "driver/drv_pwrCal.c",
"requires": "",
"examples": ""
},
{
"name": "BMPI2C_Calibrate",
"args": "[DeltaTemp][DeltaPressure][DeltaHumidity]",
@ -323,6 +350,15 @@
"requires": "",
"examples": ""
},
{
"name": "Buzzer",
"args": "CMD_Buzzer",
"descr": "",
"fn": "NULL);",
"file": "driver/drv_tclAC.c",
"requires": "",
"examples": ""
},
{
"name": "cancelRepeatingEvent",
"args": "[UserIDInteger]",
@ -503,6 +539,24 @@
"requires": "",
"examples": ""
},
{
"name": "CLOCK_CalcDST",
"args": "[nthWeekEnd monthEnd dayEnd hourEnd nthWeekStart monthStart dayStart hourStart [g_DSToffset hours - default is 1 if unset]",
"descr": "Checks, if actual time is during DST or not.",
"fn": "CLOCK_CalcDST",
"file": "driver/drv_ntp.c",
"requires": "",
"examples": ""
},
{
"name": "clock_calcDST",
"args": "CLOCK_CalcDST",
"descr": "",
"fn": "NULL);",
"file": "driver/drv_ntp.c",
"requires": "",
"examples": ""
},
{
"name": "Color",
"args": "[HexValue]",
@ -533,7 +587,7 @@
{
"name": "CT",
"args": "[TempValue]",
"descr": "Same as led_temperature",
"descr": "Sets the LED temperature. Same as led_temperature but with Tasmota syntax.",
"fn": "temperature",
"file": "cmnds/cmd_newLEDDriver.c",
"requires": "",
@ -623,7 +677,7 @@
{
"name": "Dimmer",
"args": "[Value]",
"descr": "Alias for led_dimmer",
"descr": "Alias for led_dimmer, added for Tasmota.",
"fn": "dimmer",
"file": "cmnds/cmd_newLEDDriver.c",
"requires": "",
@ -638,6 +692,24 @@
"requires": "",
"examples": ""
},
{
"name": "Display",
"args": "CMD_Display",
"descr": "",
"fn": "NULL);",
"file": "driver/drv_tclAC.c",
"requires": "",
"examples": ""
},
{
"name": "DS1820_SetResolution",
"args": "[int]",
"descr": "Sets resolution for connected DS1820 sensor (9/10/11/12 bits)",
"fn": "Cmd_SetResolution",
"file": "drv/drv_ds1820_simple.c",
"requires": "",
"examples": ""
},
{
"name": "DSEdge",
"args": "[edgeCode][optionalPinIndex]",
@ -667,8 +739,8 @@
},
{
"name": "EnergyCntReset",
"args": "[OptionalNewValue]",
"descr": "Resets the total Energy Counter, the one that is usually kept after device reboots. After this commands, the counter will start again from 0 (or from the value you specified).",
"args": "[OptionalNewValue][sensorix]",
"descr": "Resets the total Energy Counter, the one that is usually kept after device reboots. After this commands, the counter will start again from 0 (or from the value you specified). sensorix is used in ENABLE_BL_TWIN",
"fn": "BL09XX_ResetEnergyCounter",
"file": "driver/drv_bl_shared.c",
"requires": "",
@ -701,6 +773,15 @@
"requires": "",
"examples": ""
},
{
"name": "FANMode",
"args": "CMD_FANMode",
"descr": "",
"fn": "NULL);",
"file": "driver/drv_tclAC.c",
"requires": "",
"examples": ""
},
{
"name": "flags",
"args": "[IntegerValue]",
@ -863,6 +944,15 @@
"requires": "",
"examples": ""
},
{
"name": "IRAC",
"args": "[TODO]",
"descr": "Sends IR commands for HVAC control (TODO)",
"fn": "IR_AC_Cmd",
"file": "driver/drv_ir.cpp",
"requires": "",
"examples": ""
},
{
"name": "IREnable",
"args": "[Str][1or0]",
@ -872,6 +962,15 @@
"requires": "",
"examples": ""
},
{
"name": "IRParam",
"args": "[MinSize] [Noise Threshold]",
"descr": "Set minimal size of the message and noise threshold",
"fn": "IR_Enable",
"file": "driver/drv_ir.cpp",
"requires": "",
"examples": ""
},
{
"name": "IRSend",
"args": "[PROT-ADDR-CMD-REP-BITS]",
@ -881,6 +980,15 @@
"requires": "",
"examples": ""
},
{
"name": "Json",
"args": "json array of commands",
"descr": "A stub for Tasmota",
"fn": "cmnd_JsonCommand",
"file": "cmnds/cmd_tasmota.c",
"requires": "",
"examples": ""
},
{
"name": "json_test",
"args": "",
@ -1142,6 +1250,15 @@
"requires": "",
"examples": ""
},
{
"name": "lfs_mkdir",
"args": "CMD_LFS_MakeDirectory",
"descr": "",
"fn": "NULL);",
"file": "littlefs/our_lfs.c",
"requires": "",
"examples": ""
},
{
"name": "lfs_mount",
"args": "",
@ -1225,8 +1342,8 @@
},
{
"name": "linkTuyaMCUOutputToChannel",
"args": "[dpId][varType][channelID][bDPCache-Optional][mult-optional][bInverse]",
"descr": "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)",
"args": "[dpId][varType][channelID][bDPCache-Optional][mult-optional][bInverse-Optional][delta-Optional][delta2][delta3]",
"descr": "Used to map between TuyaMCU dpIDs and our internal channels. Mult, inverse and delta are for calibration, they are optional. bDPCache is also optional, 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)",
"fn": "TuyaMCU_LinkTuyaMCUOutputToChannel",
"file": "driver/drv_tuyaMCU.c",
"requires": "",
@ -1421,6 +1538,15 @@
"requires": "",
"examples": ""
},
{
"name": "MqttGroup",
"args": "[ValueString]",
"descr": "Sets the MQTT Group topic. Command keeps Tasmota syntax",
"fn": "cmnd_MqttGroup",
"file": "cmnds/cmd_tasmota.c",
"requires": "",
"examples": ""
},
{
"name": "MqttHost",
"args": "[ValueString]",
@ -1988,6 +2114,15 @@
"requires": "",
"examples": ""
},
{
"name": "setMovingAvg",
"args": "MovingAvg",
"descr": "Moving average value for power and current. <=1 disable, >=2 count of avg values. The setting is temporary and need to be set at startup.",
"fn": "NULL);",
"file": "new_pins.c",
"requires": "",
"examples": ""
},
{
"name": "SetPinChannel",
"args": "[PinIndex][ChannelIndex][optionalChannel2Index]",
@ -2099,7 +2234,7 @@
{
"name": "ShortName",
"args": "[Name]",
"descr": "Sets the short name of the device.",
"descr": "Sets the short name of the device. This is used as topic for MQTT, for example, for cmnd/obk123121/power etc MQTT calls",
"fn": "CMD_ShortName",
"file": "cmnds/cmd_channels.c",
"requires": "",
@ -2411,6 +2546,15 @@
"requires": "",
"examples": ""
},
{
"name": "StartTest",
"args": "Test_Cmd_Start",
"descr": "",
"fn": "NULL);",
"file": "driver/drv_test.c",
"requires": "",
"examples": ""
},
{
"name": "StartupCommand",
"args": "[Command in quotation marks][bRunAfter]",
@ -2447,6 +2591,15 @@
"requires": "",
"examples": ""
},
{
"name": "stopBerry",
"args": "CMD_StopBerryCommand",
"descr": "",
"fn": "NULL);",
"file": "cmnds/cmd_berry.c",
"requires": "",
"examples": ""
},
{
"name": "stopDriver",
"args": "[DriverName]",
@ -2465,6 +2618,33 @@
"requires": "",
"examples": ""
},
{
"name": "SwingH",
"args": "CMD_SwingH",
"descr": "",
"fn": "NULL);",
"file": "driver/drv_tclAC.c",
"requires": "",
"examples": ""
},
{
"name": "SwingV",
"args": "CMD_SwingV",
"descr": "",
"fn": "NULL);",
"file": "driver/drv_tclAC.c",
"requires": "",
"examples": ""
},
{
"name": "TargetTemperature",
"args": "CMD_TargetTemperature",
"descr": "",
"fn": "NULL);",
"file": "driver/drv_tclAC.c",
"requires": "",
"examples": ""
},
{
"name": "TasTeleInterval",
"args": "[SensorInterval][StateInterval]",
@ -2483,6 +2663,24 @@
"requires": "",
"examples": ""
},
{
"name": "testAtoi",
"args": "",
"descr": "Test atoi function",
"fn": "testArgs",
"file": "cmnds/cmd_test.c",
"requires": "",
"examples": ""
},
{
"name": "TestChannelSetToExpression",
"args": "CMD_TestChannelSetToExpression",
"descr": "",
"fn": "NULL);",
"file": "cmnds/cmd_test.c",
"requires": "",
"examples": ""
},
{
"name": "testFloats",
"args": "",
@ -2492,6 +2690,15 @@
"requires": "",
"examples": ""
},
{
"name": "TestIPtoStr",
"args": "CMD_TestIPtoStr",
"descr": "",
"fn": "NULL);",
"file": "cmnds/cmd_test.c",
"requires": "",
"examples": ""
},
{
"name": "testJSON",
"args": "",
@ -2519,6 +2726,42 @@
"requires": "",
"examples": ""
},
{
"name": "TestMemcmp",
"args": "CMD_TestMemcmp",
"descr": "",
"fn": "NULL);",
"file": "cmnds/cmd_test.c",
"requires": "",
"examples": ""
},
{
"name": "TestMemcpy",
"args": "CMD_TestMemcpy",
"descr": "",
"fn": "NULL);",
"file": "cmnds/cmd_test.c",
"requires": "",
"examples": ""
},
{
"name": "TestMemset",
"args": "CMD_TestMemset",
"descr": "",
"fn": "NULL);",
"file": "cmnds/cmd_test.c",
"requires": "",
"examples": ""
},
{
"name": "TestParseIP",
"args": "CMD_TestParseIP",
"descr": "",
"fn": "NULL);",
"file": "cmnds/cmd_test.c",
"requires": "",
"examples": ""
},
{
"name": "testRealloc",
"args": "",
@ -2528,6 +2771,60 @@
"requires": "",
"examples": ""
},
{
"name": "TestSprintfForFloat",
"args": "CMD_TestSprintfForFloat",
"descr": "",
"fn": "NULL);",
"file": "cmnds/cmd_test.c",
"requires": "",
"examples": ""
},
{
"name": "TestSprintfForHex",
"args": "CMD_TestSprintfForHex",
"descr": "",
"fn": "NULL);",
"file": "cmnds/cmd_test.c",
"requires": "",
"examples": ""
},
{
"name": "TestSprintfForInteger",
"args": "CMD_TestSprintfForInteger",
"descr": "",
"fn": "NULL);",
"file": "cmnds/cmd_test.c",
"requires": "",
"examples": ""
},
{
"name": "TestStrcat",
"args": "CMD_TestStrcat",
"descr": "",
"fn": "NULL);",
"file": "cmnds/cmd_test.c",
"requires": "",
"examples": ""
},
{
"name": "TestStrcmp",
"args": "CMD_TestStrcmp",
"descr": "",
"fn": "NULL);",
"file": "cmnds/cmd_test.c",
"requires": "",
"examples": ""
},
{
"name": "TestStrcpy",
"args": "CMD_TestStrcpy",
"descr": "",
"fn": "NULL);",
"file": "cmnds/cmd_test.c",
"requires": "",
"examples": ""
},
{
"name": "testStrdup",
"args": "",
@ -2537,6 +2834,24 @@
"requires": "",
"examples": ""
},
{
"name": "TestStrlen",
"args": "CMD_TestStrlen",
"descr": "",
"fn": "NULL);",
"file": "cmnds/cmd_test.c",
"requires": "",
"examples": ""
},
{
"name": "TestStrncpy",
"args": "CMD_TestStrncpy",
"descr": "",
"fn": "NULL);",
"file": "cmnds/cmd_test.c",
"requires": "",
"examples": ""
},
{
"name": "TimeSize",
"args": "",
@ -2915,6 +3230,15 @@
"requires": "",
"examples": ""
},
{
"name": "WebServer",
"args": "[0 - Stop / 1 - Start]",
"descr": "Setting state of WebServer",
"fn": "CMD_WebServer",
"file": "cmnds/cmd_main.c",
"requires": "",
"examples": ""
},
{
"name": "widget_clearAll",
"args": "",

6
docs/json/constants.json
View File

@ -179,6 +179,12 @@
"descr": "TODO",
"requires": ""
},
{
"name": "$isDST",
"title": "$isDST",
"descr": "TODO",
"requires": ""
},
{
"name": "$sunrise",
"title": "$sunrise",

36
docs/json/drivers.json
View File

@ -17,6 +17,12 @@
"descr": "Freeze is a test driver for watchdog. Enabling this will freeze device main loop.",
"requires": ""
},
{
"name": "PIR",
"title": "TODO",
"descr": "PIR",
"requires": ""
},
{
"name": "PixelAnim",
"title": "TODO",
@ -35,6 +41,12 @@
"descr": "[HGS02](https://www.elektroda.com/rtvforum/viewtopic.php?p=21177061#21177061)",
"requires": ""
},
{
"name": "TCL",
"title": "TCL",
"descr": "TODO",
"requires": ""
},
{
"name": "OpenWeatherMap",
"title": "TODO",
@ -83,6 +95,18 @@
"descr": "This is a fake I2C LED driver, only for testing",
"requires": ""
},
{
"name": "TESTUART",
"title": "TODO",
"descr": "g",
"requires": ""
},
{
"name": "Test",
"title": "TODO",
"descr": "Self test of the device",
"requires": ""
},
{
"name": "I2C",
"title": "TODO",
@ -125,6 +149,12 @@
"descr": "BL0937 is a power-metering chip which uses custom protocol to report data. It requires setting 3 pins in pin config: CF, CF1 and SEL",
"requires": ""
},
{
"name": "CSE7761",
"title": "CSE7761",
"descr": "TODO",
"requires": ""
},
{
"name": "CSE7766",
"title": "TODO",
@ -364,5 +394,11 @@
"title": "TODO",
"descr": "A bridge relay driver, added for [TONGOU TO-Q-SY1-JWT Din Rail Switch](https://www.elektroda.com/rtvforum/topic3934580.html). See linked topic for info.",
"requires": ""
},
{
"name": "UART to TCP bridge",
"title": "TODO",
"descr": "UART to TCP, mainly for WiFi Zigbee coordinators.",
"requires": ""
}
]

7
docs/json/flags.json
View File

@ -355,5 +355,12 @@
"title": "todo",
"file": "new_pins.h",
"descr": "[MQTT] Never add get sufix"
},
{
"index": "51",
"enum": "OBK_FLAG_WIFI_ENHANCED_FAST_CONNECT",
"title": "todo",
"file": "new_pins.h",
"descr": "[WiFi] (RTL/BK) Enhanced fast connect by saving AP data to flash (preferable with Flag 37 & static ip). Quick reset 3 times to connect normally"
}
]

16
docs/json/ioRoles.json
View File

@ -631,6 +631,22 @@
"file": "new_pins.h",
"driver": ""
},
{
"name": "PWM_ScriptOnly",
"title": "TODO",
"descr": "",
"enum": "PWM_ScriptOnly",
"file": "new_pins.h",
"driver": ""
},
{
"name": "PWM_ScriptOnly_n",
"title": "TODO",
"descr": "",
"enum": "PWM_ScriptOnly_n",
"file": "new_pins.h",
"driver": ""
},
{
"name": "Total_Options",
"title": "TODO",

2
docs/safeMode.md
View File

@ -1,2 +1,2 @@
# Safe mode
Device is counting full boots (full boot is a boot after which device worked for 30 seconds). If you power off and on device 5 times in quick succession (but not too quick because device might have capacitors and they need to discharge every time), it will enter open access point mode/safe mode (safe mode means even pin systems are not initialized). Those modes are used to recover devices from bad configs and errors.
Device is counting full boots (full boot is a boot after which device worked for 30 seconds). If you power off and on device multiple times, it will enter open access point mode and safe mode (safe mode means even pin systems are not initialized). Those modes are used to recover devices from bad configs and errors.

56
src/cmnds/cmd_test.c
View File

@ -559,19 +559,75 @@ int CMD_InitTestCommands(){
//cmddetail:"examples":""}
CMD_RegisterCommand("simonirtest", CMD_SimonTest, NULL);
//cmddetail:{"name":"TestSprintfForInteger","args":"CMD_TestSprintfForInteger",
//cmddetail:"descr":"",
//cmddetail:"fn":"NULL);","file":"cmnds/cmd_test.c","requires":"",
//cmddetail:"examples":""}
CMD_RegisterCommand("TestSprintfForInteger", CMD_TestSprintfForInteger, NULL);
//cmddetail:{"name":"TestSprintfForHex","args":"CMD_TestSprintfForHex",
//cmddetail:"descr":"",
//cmddetail:"fn":"NULL);","file":"cmnds/cmd_test.c","requires":"",
//cmddetail:"examples":""}
CMD_RegisterCommand("TestSprintfForHex", CMD_TestSprintfForHex, NULL);
//cmddetail:{"name":"TestSprintfForFloat","args":"CMD_TestSprintfForFloat",
//cmddetail:"descr":"",
//cmddetail:"fn":"NULL);","file":"cmnds/cmd_test.c","requires":"",
//cmddetail:"examples":""}
CMD_RegisterCommand("TestSprintfForFloat", CMD_TestSprintfForFloat, NULL);
//cmddetail:{"name":"TestStrcpy","args":"CMD_TestStrcpy",
//cmddetail:"descr":"",
//cmddetail:"fn":"NULL);","file":"cmnds/cmd_test.c","requires":"",
//cmddetail:"examples":""}
CMD_RegisterCommand("TestStrcpy", CMD_TestStrcpy, NULL);
//cmddetail:{"name":"TestStrncpy","args":"CMD_TestStrncpy",
//cmddetail:"descr":"",
//cmddetail:"fn":"NULL);","file":"cmnds/cmd_test.c","requires":"",
//cmddetail:"examples":""}
CMD_RegisterCommand("TestStrncpy", CMD_TestStrncpy, NULL);
//cmddetail:{"name":"TestStrcmp","args":"CMD_TestStrcmp",
//cmddetail:"descr":"",
//cmddetail:"fn":"NULL);","file":"cmnds/cmd_test.c","requires":"",
//cmddetail:"examples":""}
CMD_RegisterCommand("TestStrcmp", CMD_TestStrcmp, NULL);
//cmddetail:{"name":"TestStrlen","args":"CMD_TestStrlen",
//cmddetail:"descr":"",
//cmddetail:"fn":"NULL);","file":"cmnds/cmd_test.c","requires":"",
//cmddetail:"examples":""}
CMD_RegisterCommand("TestStrlen", CMD_TestStrlen, NULL);
//cmddetail:{"name":"TestStrcat","args":"CMD_TestStrcat",
//cmddetail:"descr":"",
//cmddetail:"fn":"NULL);","file":"cmnds/cmd_test.c","requires":"",
//cmddetail:"examples":""}
CMD_RegisterCommand("TestStrcat", CMD_TestStrcat, NULL);
//cmddetail:{"name":"TestMemset","args":"CMD_TestMemset",
//cmddetail:"descr":"",
//cmddetail:"fn":"NULL);","file":"cmnds/cmd_test.c","requires":"",
//cmddetail:"examples":""}
CMD_RegisterCommand("TestMemset", CMD_TestMemset, NULL);
//cmddetail:{"name":"TestMemcpy","args":"CMD_TestMemcpy",
//cmddetail:"descr":"",
//cmddetail:"fn":"NULL);","file":"cmnds/cmd_test.c","requires":"",
//cmddetail:"examples":""}
CMD_RegisterCommand("TestMemcpy", CMD_TestMemcpy, NULL);
//cmddetail:{"name":"TestMemcmp","args":"CMD_TestMemcmp",
//cmddetail:"descr":"",
//cmddetail:"fn":"NULL);","file":"cmnds/cmd_test.c","requires":"",
//cmddetail:"examples":""}
CMD_RegisterCommand("TestMemcmp", CMD_TestMemcmp, NULL);
//cmddetail:{"name":"TestChannelSetToExpression","args":"CMD_TestChannelSetToExpression",
//cmddetail:"descr":"",
//cmddetail:"fn":"NULL);","file":"cmnds/cmd_test.c","requires":"",
//cmddetail:"examples":""}
CMD_RegisterCommand("TestChannelSetToExpression", CMD_TestChannelSetToExpression, NULL);
//cmddetail:{"name":"TestParseIP","args":"CMD_TestParseIP",
//cmddetail:"descr":"",
//cmddetail:"fn":"NULL);","file":"cmnds/cmd_test.c","requires":"",
//cmddetail:"examples":""}
CMD_RegisterCommand("TestParseIP", CMD_TestParseIP, NULL);
//cmddetail:{"name":"TestIPtoStr","args":"CMD_TestIPtoStr",
//cmddetail:"descr":"",
//cmddetail:"fn":"NULL);","file":"cmnds/cmd_test.c","requires":"",
//cmddetail:"examples":""}
CMD_RegisterCommand("TestIPtoStr", CMD_TestIPtoStr, NULL);
return 0;

5
src/driver/drv_main.c
View File

@ -251,7 +251,12 @@ static driver_t g_drivers[] = {
{ "SM15155E", SM15155E_Init, NULL, NULL, NULL, NULL, NULL, NULL, false },
#endif
#if ENABLE_DRIVER_IRREMOTEESP
//drvdetail:{"name":"IR",
//drvdetail:"title":"TODO",
//drvdetail:"descr":"IRLibrary wrapper, so you can receive remote signals and send them. See [forum discussion here](https://www.elektroda.com/rtvforum/topic3920360.html), also see [LED strip and IR YT video](https://www.youtube.com/watch?v=KU0tDwtjfjw)",
//drvdetail:"requires":""}
{ "IR", DRV_IR_Init, NULL, NULL, DRV_IR_RunFrame, NULL, NULL, NULL, false },
#endif
#if ENABLE_DRIVER_IR

28
src/driver/drv_tclAC.c
View File

@ -678,12 +678,40 @@ void TCL_Init(void) {
UART_InitUART(TCL_baudRate, 2, false);
UART_InitReceiveRingBuffer(TCL_UART_RECEIVE_BUFFER_SIZE);
//cmddetail:{"name":"ACMode","args":"CMD_ACMode",
//cmddetail:"descr":"",
//cmddetail:"fn":"NULL);","file":"driver/drv_tclAC.c","requires":"",
//cmddetail:"examples":""}
CMD_RegisterCommand("ACMode", CMD_ACMode, NULL);
//cmddetail:{"name":"FANMode","args":"CMD_FANMode",
//cmddetail:"descr":"",
//cmddetail:"fn":"NULL);","file":"driver/drv_tclAC.c","requires":"",
//cmddetail:"examples":""}
CMD_RegisterCommand("FANMode", CMD_FANMode, NULL);
//cmddetail:{"name":"SwingH","args":"CMD_SwingH",
//cmddetail:"descr":"",
//cmddetail:"fn":"NULL);","file":"driver/drv_tclAC.c","requires":"",
//cmddetail:"examples":""}
CMD_RegisterCommand("SwingH", CMD_SwingH, NULL);
//cmddetail:{"name":"SwingV","args":"CMD_SwingV",
//cmddetail:"descr":"",
//cmddetail:"fn":"NULL);","file":"driver/drv_tclAC.c","requires":"",
//cmddetail:"examples":""}
CMD_RegisterCommand("SwingV", CMD_SwingV, NULL);
//cmddetail:{"name":"TargetTemperature","args":"CMD_TargetTemperature",
//cmddetail:"descr":"",
//cmddetail:"fn":"NULL);","file":"driver/drv_tclAC.c","requires":"",
//cmddetail:"examples":""}
CMD_RegisterCommand("TargetTemperature", CMD_TargetTemperature, NULL);
//cmddetail:{"name":"Buzzer","args":"CMD_Buzzer",
//cmddetail:"descr":"",
//cmddetail:"fn":"NULL);","file":"driver/drv_tclAC.c","requires":"",
//cmddetail:"examples":""}
CMD_RegisterCommand("Buzzer", CMD_Buzzer, NULL);
//cmddetail:{"name":"Display","args":"CMD_Display",
//cmddetail:"descr":"",
//cmddetail:"fn":"NULL);","file":"driver/drv_tclAC.c","requires":"",
//cmddetail:"examples":""}
CMD_RegisterCommand("Display", CMD_Display, NULL);
}

4
src/driver/drv_test.c
View File

@ -79,6 +79,10 @@ void Test_AppendInformationToHTTPIndexPage(http_request_t *request)
// backlog startDriver Test; StartTest 100;
void Test_Init(void) {
//cmddetail:{"name":"StartTest","args":"Test_Cmd_Start",
//cmddetail:"descr":"",
//cmddetail:"fn":"NULL);","file":"driver/drv_test.c","requires":"",
//cmddetail:"examples":""}
CMD_RegisterCommand("StartTest", Test_Cmd_Start, NULL);
}

4
src/littlefs/our_lfs.c
View File

@ -424,6 +424,10 @@ void LFSAddCmds(){
//cmddetail:"examples":""}
CMD_RegisterCommand("lfs_writeLine", CMD_LFS_WriteLine, NULL);
//cmddetail:{"name":"lfs_mkdir","args":"CMD_LFS_MakeDirectory",
//cmddetail:"descr":"",
//cmddetail:"fn":"NULL);","file":"littlefs/our_lfs.c","requires":"",
//cmddetail:"examples":""}
CMD_RegisterCommand("lfs_mkdir", CMD_LFS_MakeDirectory, NULL);
}