mirror of
https://github.com/openshwprojects/OpenBK7231T_App.git
synced 2026-02-04 20:15:31 +00:00
update docs
This commit is contained in:
Tester23
@ -15,13 +15,13 @@ Do not add anything here, as it will overwritten with next rebuild.
|
||||
|:------------- |------:|
|
||||
| [IO/Pin Roles](https://github.com/openshwprojects/OpenBK7231T_App/blob/main/docs/ioRoles.md) (79 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) (47 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) (47 total) | Drivers allows you to control certain peripherals or enable certain features that are off by default. |
|
||||
| [Drivers](https://github.com/openshwprojects/OpenBK7231T_App/blob/main/docs/drivers.md) (48 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) (38 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) (51 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) (290 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) (291 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) (34 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) (290 total) | More details on commands. |
|
||||
| [Console/Script commands [Extended Edition]](https://github.com/openshwprojects/OpenBK7231T_App/blob/main/docs/commands-extended.md) (291 total) | More details on commands. |
|
||||
|
||||
@ -123,7 +123,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] | 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] | 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 |
|
||||
| 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 |
|
||||
@ -193,8 +193,8 @@ Do not add anything here, as it will overwritten with next rebuild.
|
||||
| setButtonTimes | [ValLongPress][ValShortPress][ValRepeat] | Each value is times 100ms, so: SetButtonTimes 2 1 1 means 200ms long press, 100ms short and 100ms repeat.<br/><br/>See also [setButtonTimes on forum](https://www.elektroda.com/rtvforum/find.php?q=setButtonTimes). | File: new_pins.c<br/>Function: CMD_SetButtonTimes |
|
||||
| SetChannel | [ChannelIndex][ChannelValue] | Sets a raw channel to given value. Relay channels are using 1 and 0 values. PWM channels are within [0,100] range. Do not use this for LED control, because there is a better and more advanced LED driver with dimming and configuration memory (remembers setting after on/off), LED driver commands has 'led_' prefix.<br/><br/>See also [SetChannel on forum](https://www.elektroda.com/rtvforum/find.php?q=SetChannel). | File: cmnds/cmd_channels.c<br/>Function: CMD_SetChannel |
|
||||
| SetChannelFloat | [ChannelIndex][ChannelValue] | Sets a raw channel to given float value. Currently only used for LED PWM channels.<br/><br/>See also [SetChannelFloat on forum](https://www.elektroda.com/rtvforum/find.php?q=SetChannelFloat). | File: cmnds/cmd_channels.c<br/>Function: CMD_SetChannelFloat |
|
||||
| SetChannelLabel | [ChannelIndex][Str][bHideTogglePrefix] | Sets a channel label for UI. If you use 1 for bHideTogglePrefix, then the 'Toggle ' prefix from button will be omitted.<br/><br/>See also [SetChannelLabel on forum](https://www.elektroda.com/rtvforum/find.php?q=SetChannelLabel). | File: cmnds/cmd_channels.c<br/>Function: CMD_SetChannelLabel |
|
||||
| SetChannelPrivate | [ChannelIndex][bPrivate] | Channels marked as private are NEVER published via MQTT.<br/><br/>See also [SetChannelPrivate on forum](https://www.elektroda.com/rtvforum/find.php?q=SetChannelPrivate). | File: cmnds/cmd_channels.c<br/>Function: NULL); |
|
||||
| SetChannelLabel | [ChannelIndex][Str][bHideTogglePrefix] | Sets a channel label for UI and default entity name for Home Assistant discovery. If you use 1 for bHideTogglePrefix, then the 'Toggle ' prefix from UI button will be omitted.<br/><br/>See also [SetChannelLabel on forum](https://www.elektroda.com/rtvforum/find.php?q=SetChannelLabel). | File: cmnds/cmd_channels.c<br/>Function: CMD_SetChannelLabel |
|
||||
| SetChannelPrivate | [ChannelIndex][bPrivate] | Channels marked as private are NEVER published via MQTT and excluded from Home Assistant discovery.<br/><br/>See also [SetChannelPrivate on forum](https://www.elektroda.com/rtvforum/find.php?q=SetChannelPrivate). | File: cmnds/cmd_channels.c<br/>Function: NULL); |
|
||||
| setChannelType | [ChannelIndex][TypeString] | Sets a custom type for channel. Types are mostly used to determine how to display channel value on GUI.<br/><br/>See also [setChannelType on forum](https://www.elektroda.com/rtvforum/find.php?q=setChannelType). | File: new_pins.c<br/>Function: CMD_SetChannelType |
|
||||
| SetChannelVisible | [ChannelIndex][bVisible] | This allows you to force-hide a certain channel from HTTP gui. The channel will still work, but will not show up as a button, or a toggle, etc...<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 |
|
||||
@ -222,7 +222,7 @@ Do not add anything here, as it will overwritten with next rebuild.
|
||||
| SHT_SetAlert | [temp_high, temp_low, hum_high, hum_low]<br/>Req:all | Set Sensor alert configuration.<br/><br/>Example: SHT_SetAlertCmd<br/><br/>See also [SHT_SetAlert on forum](https://www.elektroda.com/rtvforum/find.php?q=SHT_SetAlert). | File: driver/drv_sht3x.c<br/>Function: SHT3X_SetAlertcmd |
|
||||
| SHT_StopPer | | Stop periodical capture for SHT Sensor.<br/><br/>See also [SHT_StopPer on forum](https://www.elektroda.com/rtvforum/find.php?q=SHT_StopPer). | File: driver/drv_sht3x.c<br/>Function: SHT3X_StopPerCmd |
|
||||
| simonirtest | | Simons Special Test.<br/><br/>See also [simonirtest on forum](https://www.elektroda.com/rtvforum/find.php?q=simonirtest). | File: cmnds/cmd_main.c<br/>Function: CMD_SimonTest |
|
||||
| SM16703P_Init | [NumberOfLEDs] | This will setup LED driver for a strip with given number of LEDs. Please note that it also works for WS2812B and similiar LEDs. See [tutorial](https://www.elektroda.com/rtvforum/topic4036716.html).<br/><br/>See also [SM16703P_Init on forum](https://www.elektroda.com/rtvforum/find.php?q=SM16703P_Init). | File: driver/drv_sm16703P.c<br/>Function: NULL); |
|
||||
| SM16703P_Init | [NumberOfLEDs][ColorOrder] | This will setup LED driver for a strip with given number of LEDs. Please note that it also works for WS2812B and similiar LEDs. You can optionally set the color order with either RGB, RBG, BRG, BGB, GRB or GBR (default RGB). See [tutorial](https://www.elektroda.com/rtvforum/topic4036716.html).<br/><br/>See also [SM16703P_Init on forum](https://www.elektroda.com/rtvforum/find.php?q=SM16703P_Init). | File: driver/drv_sm16703P.c<br/>Function: NULL); |
|
||||
| SM16703P_SetPixel | [index/all] [R] [G] [B] | Sets a pixel for LED strip. Index can be a number or 'all' keyword to set all. Then, 3 integer values for R, G and B. Please note that it also works for WS2812B and similiar LEDs. See [tutorial](https://www.elektroda.com/rtvforum/topic4036716.html).<br/><br/>See also [SM16703P_SetPixel on forum](https://www.elektroda.com/rtvforum/find.php?q=SM16703P_SetPixel). | File: driver/drv_sm16703P.c<br/>Function: NULL); |
|
||||
| SM16703P_SetRaw | [bUpdate] [byteOfs] [HexData] | Sets the raw data bytes for SPI DMA LED driver at the given offset. Hex data should be as a hex string, for example, FF00AA, etc. The bUpdate, if set to 1, will run SM16703P_Start automatically after setting data. Please note that it also works for WS2812B and similiar LEDs. See [tutorial](https://www.elektroda.com/rtvforum/topic4036716.html).<br/><br/>See also [SM16703P_SetRaw on forum](https://www.elektroda.com/rtvforum/find.php?q=SM16703P_SetRaw). | File: driver/drv_sm16703P.c<br/>Function: NULL); |
|
||||
| SM16703P_Start | | This will send the currently set data to the strip. Please note that it also works for WS2812B and similiar LEDs. See [tutorial](https://www.elektroda.com/rtvforum/topic4036716.html).<br/><br/>See also [SM16703P_Start on forum](https://www.elektroda.com/rtvforum/find.php?q=SM16703P_Start). | File: driver/drv_sm16703P.c<br/>Function: NULL); |
|
||||
@ -254,6 +254,7 @@ Do not add anything here, as it will overwritten with next rebuild.
|
||||
| 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 |
|
||||
| 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 |
|
||||
| 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 |
|
||||
| TimeSize | CMD_TimeSize | .<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); |
|
||||
| TMGN_Char | [CharIndex] [CharCode] | This allows you to set binary code for given char, valid chars range is 0 to 15, because this is 7-seg display.<br/><br/>See also [TMGN_Char on forum](https://www.elektroda.com/rtvforum/find.php?q=TMGN_Char). | File: driver/drv_tm1637.c<br/>Function: NULL); |
|
||||
|
||||
@ -126,7 +126,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] | 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] | 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). |
|
||||
| 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). |
|
||||
@ -196,8 +196,8 @@ Do not add anything here, as it will overwritten with next rebuild.
|
||||
| setButtonTimes | [ValLongPress][ValShortPress][ValRepeat] | Each value is times 100ms, so: SetButtonTimes 2 1 1 means 200ms long press, 100ms short and 100ms repeat.<br/><br/>See also [setButtonTimes on forum](https://www.elektroda.com/rtvforum/find.php?q=setButtonTimes). |
|
||||
| SetChannel | [ChannelIndex][ChannelValue] | Sets a raw channel to given value. Relay channels are using 1 and 0 values. PWM channels are within [0,100] range. Do not use this for LED control, because there is a better and more advanced LED driver with dimming and configuration memory (remembers setting after on/off), LED driver commands has 'led_' prefix.<br/><br/>See also [SetChannel on forum](https://www.elektroda.com/rtvforum/find.php?q=SetChannel). |
|
||||
| SetChannelFloat | [ChannelIndex][ChannelValue] | Sets a raw channel to given float value. Currently only used for LED PWM channels.<br/><br/>See also [SetChannelFloat on forum](https://www.elektroda.com/rtvforum/find.php?q=SetChannelFloat). |
|
||||
| SetChannelLabel | [ChannelIndex][Str][bHideTogglePrefix] | Sets a channel label for UI. If you use 1 for bHideTogglePrefix, then the 'Toggle ' prefix from button will be omitted.<br/><br/>See also [SetChannelLabel on forum](https://www.elektroda.com/rtvforum/find.php?q=SetChannelLabel). |
|
||||
| SetChannelPrivate | [ChannelIndex][bPrivate] | Channels marked as private are NEVER published via MQTT.<br/><br/>See also [SetChannelPrivate on forum](https://www.elektroda.com/rtvforum/find.php?q=SetChannelPrivate). |
|
||||
| SetChannelLabel | [ChannelIndex][Str][bHideTogglePrefix] | Sets a channel label for UI and default entity name for Home Assistant discovery. If you use 1 for bHideTogglePrefix, then the 'Toggle ' prefix from UI button will be omitted.<br/><br/>See also [SetChannelLabel on forum](https://www.elektroda.com/rtvforum/find.php?q=SetChannelLabel). |
|
||||
| SetChannelPrivate | [ChannelIndex][bPrivate] | Channels marked as private are NEVER published via MQTT and excluded from Home Assistant discovery.<br/><br/>See also [SetChannelPrivate on forum](https://www.elektroda.com/rtvforum/find.php?q=SetChannelPrivate). |
|
||||
| setChannelType | [ChannelIndex][TypeString] | Sets a custom type for channel. Types are mostly used to determine how to display channel value on GUI.<br/><br/>See also [setChannelType on forum](https://www.elektroda.com/rtvforum/find.php?q=setChannelType). |
|
||||
| SetChannelVisible | [ChannelIndex][bVisible] | This allows you to force-hide a certain channel from HTTP gui. The channel will still work, but will not show up as a button, or a toggle, etc...<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). |
|
||||
@ -257,6 +257,7 @@ Do not add anything here, as it will overwritten with next rebuild.
|
||||
| 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). |
|
||||
| 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). |
|
||||
| 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). |
|
||||
| TimeSize | CMD_TimeSize | .<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). |
|
||||
| TMGN_Char | [CharIndex] [CharCode] | This allows you to set binary code for given char, valid chars range is 0 to 15, because this is 7-seg display.<br/><br/>See also [TMGN_Char on forum](https://www.elektroda.com/rtvforum/find.php?q=TMGN_Char). |
|
||||
|
||||
@ -9,6 +9,7 @@ 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). |
|
||||
| NTP | NTP driver is required to get current time and date from web. Without it, there is no correct datetime. Put 'startDriver NTP' in short startup line or autoexec.bat to run it on start.<br/>See also [NTP on forum](https://www.elektroda.com/rtvforum/find.php?q=NTP). |
|
||||
| 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). |
|
||||
|
||||
@ -1063,7 +1063,7 @@
|
||||
},
|
||||
{
|
||||
"name": "linkTuyaMCUOutputToChannel",
|
||||
"args": "[dpId][varType][channelID][bDPCache-Optional]",
|
||||
"args": "[dpId][varType][channelID][bDPCache-Optional][mult-optional]",
|
||||
"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)",
|
||||
"fn": "TuyaMCU_LinkTuyaMCUOutputToChannel",
|
||||
"file": "driver/drv_tuyaMCU.c",
|
||||
@ -1694,7 +1694,7 @@
|
||||
{
|
||||
"name": "SetChannelLabel",
|
||||
"args": "[ChannelIndex][Str][bHideTogglePrefix]",
|
||||
"descr": "Sets a channel label for UI. If you use 1 for bHideTogglePrefix, then the 'Toggle ' prefix from button will be omitted",
|
||||
"descr": "Sets a channel label for UI and default entity name for Home Assistant discovery. If you use 1 for bHideTogglePrefix, then the 'Toggle ' prefix from UI button will be omitted",
|
||||
"fn": "CMD_SetChannelLabel",
|
||||
"file": "cmnds/cmd_channels.c",
|
||||
"requires": "",
|
||||
@ -1703,7 +1703,7 @@
|
||||
{
|
||||
"name": "SetChannelPrivate",
|
||||
"args": "[ChannelIndex][bPrivate]",
|
||||
"descr": "Channels marked as private are NEVER published via MQTT.",
|
||||
"descr": "Channels marked as private are NEVER published via MQTT and excluded from Home Assistant discovery",
|
||||
"fn": "NULL);",
|
||||
"file": "cmnds/cmd_channels.c",
|
||||
"requires": "",
|
||||
@ -1954,8 +1954,8 @@
|
||||
},
|
||||
{
|
||||
"name": "SM16703P_Init",
|
||||
"args": "[NumberOfLEDs]",
|
||||
"descr": "This will setup LED driver for a strip with given number of LEDs. Please note that it also works for WS2812B and similiar LEDs. See [tutorial](https://www.elektroda.com/rtvforum/topic4036716.html).",
|
||||
"args": "[NumberOfLEDs][ColorOrder]",
|
||||
"descr": "This will setup LED driver for a strip with given number of LEDs. Please note that it also works for WS2812B and similiar LEDs. You can optionally set the color order with either RGB, RBG, BRG, BGB, GRB or GBR (default RGB). See [tutorial](https://www.elektroda.com/rtvforum/topic4036716.html).",
|
||||
"fn": "NULL);",
|
||||
"file": "driver/drv_sm16703P.c",
|
||||
"requires": "",
|
||||
@ -2240,6 +2240,15 @@
|
||||
"requires": "",
|
||||
"examples": ""
|
||||
},
|
||||
{
|
||||
"name": "TimeSize",
|
||||
"args": "CMD_TimeSize",
|
||||
"descr": "",
|
||||
"fn": "NULL);",
|
||||
"file": "cmnds/cmd_main.c",
|
||||
"requires": "",
|
||||
"examples": ""
|
||||
},
|
||||
{
|
||||
"name": "TM1650_Test",
|
||||
"args": "CMD_TM1650_Test",
|
||||
|
||||
@ -11,6 +11,12 @@
|
||||
"descr": "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).",
|
||||
"requires": ""
|
||||
},
|
||||
{
|
||||
"name": "FREEZE",
|
||||
"title": "TODO",
|
||||
"descr": "Freeze is a test driver for watchdog. Enabling this will freeze device main loop.",
|
||||
"requires": ""
|
||||
},
|
||||
{
|
||||
"name": "NTP",
|
||||
"title": "TODO",
|
||||
|
||||
Reference in New Issue
Block a user