mirror of
https://github.com/openshwprojects/OpenBK7231T_App.git
synced 2026-02-05 00:15:30 +00:00
docs
This commit is contained in:
openshwprojects
@ -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) (67 total) | You can set pin roles in 'Configure Module' section or use one of predefined templates in Web App. For each pin, you also set coresponding channel value. This is needed for modules with multiple relays. If you have 3 relays and 3 buttons, you need to use channel values like 1, 2, and 3. Just enter '1' in the text field, etc. |
|
||||
| [Flags](https://github.com/openshwprojects/OpenBK7231T_App/blob/main/docs/flags.md) (38 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) (32 total) | Drivers allows you to control certain peripherals or enable certain features that are off by default. |
|
||||
| [IO/Pin Roles](https://github.com/openshwprojects/OpenBK7231T_App/blob/main/docs/ioRoles.md) (70 total) | You can set pin roles in 'Configure Module' section or use one of predefined templates in Web App. For each pin, you also set coresponding channel value. This is needed for modules with multiple relays. If you have 3 relays and 3 buttons, you need to use channel values like 1, 2, and 3. Just enter '1' in the text field, etc. |
|
||||
| [Flags](https://github.com/openshwprojects/OpenBK7231T_App/blob/main/docs/flags.md) (39 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) (35 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) (22 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) (35 total) | Channel types are often not required and don't have to be configured, but in some cases they are required for better device control from OpenBeken web panel. Channel types describes the kind of value stored in channel, for example, if you have a Tuya Fan Controller with 3 speeds control, you can set the channel type to LowMidHigh and it will display the correct UI radiobutton on OpenBeken panel.<br>Some channels have '_div10' or '_div100' sufixes. This is for TuyaMCU. This is needed because TuyaMCU sends values as integers, so it sends, for example, 215 for 21.5C temperature, and we store it internally as 215 and only convert to float for display. |
|
||||
| [FAQ](https://github.com/openshwprojects/OpenBK7231T_App/blob/main/docs/faq.md) (26 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) (238 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) (245 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) (10 total) | Here you can find examples of autoexec.bat configs. The autoexec.bat file can be created in Web Application, under LittleFS tab, and is run every time device reboots (unless device enters safe mode/AP mode). The autoexec.bat file allows you to create more advanced configs, setup TuyaMCU mappings, etc |
|
||||
| [MQTT Topics](https://github.com/openshwprojects/OpenBK7231T_App/blob/main/docs/mqttTopics.md) (25 total) | MQTT topic names and content for incoming and ougoing OBK MQTT publishes |
|
||||
| [Script examples](https://github.com/openshwprojects/OpenBK7231T_App/blob/main/docs/scriptExamples.md) (5 total) | Scripts can be put in autoexec.bat and then they will start automatically on reboot, you can also put script in other LittleFS file and use startScript [fileName] [Label] command to run them. From the firmware point of view, scripts and autoexecs are basically the same thing. There is, however, a little bit more advanced system of execution for scripts which can be written in a form of scripts threads that run over time, can have delays within then, conditional checks and jumps. |
|
||||
| [Console/Script commands [Extended Edition]](https://github.com/openshwprojects/OpenBK7231T_App/blob/main/docs/commands-extended.md) (238 total) | More details on commands. |
|
||||
| [Console/Script commands [Extended Edition]](https://github.com/openshwprojects/OpenBK7231T_App/blob/main/docs/commands-extended.md) (245 total) | More details on commands. |
|
||||
|
||||
@ -107,7 +107,8 @@ Do not add anything here, as it will overwritten with next rebuild.
|
||||
| lfs_test1 | [FileName] | Tests the LFS file reading feature. | File: cmnds/cmd_tasmota.c<br/>Function: cmnd_lfs_test1 |
|
||||
| lfs_test2 | [FileName] | Tests the LFS file reading feature. | File: cmnds/cmd_tasmota.c<br/>Function: cmnd_lfs_test2 |
|
||||
| lfs_test3 | [FileName] | Tests the LFS file reading feature. | File: cmnds/cmd_tasmota.c<br/>Function: cmnd_lfs_test3 |
|
||||
| Battery_Setup | [int][int][float][int][int] | measure battery based on ADC args minbatt and maxbatt in mv. optional V_divider(2), Vref(default 2400) and ADC bits(4096) and <br/>e.g.:Battery_Setup 1500 3000 2 2400 4096 | File: drv/drv_battery.c<br/>Function: Battery_Setup |
|
||||
| AB_Map | [int] | Sets margines for ADC button codes. For given N margins, there are N+1 possible ADC button values (one should be reserved for 'no button') | File: drv/drv_adcButton.c<br/>Function: Cmd_ADCButtonMap |
|
||||
| Battery_Setup | [float][float][float][float][float] | measure battery based on ADC args minbatt and maxbatt in mv. optional V_divider(2), Vref(default 2400) and ADC bits(4096) and <br/>e.g.:Battery_Setup 1500 3000 2 2400 4096 | File: drv/drv_battery.c<br/>Function: Battery_Setup |
|
||||
| Battery_cycle | [int] | change cycle of measurement by default every 10 seconds<br/>e.g.:Battery_Setup 60 | File: drv/drv_battery.c<br/>Function: Battery_cycle |
|
||||
| PowerMax | BL0937_PowerMax | | File: driver/drv_bl0937.c<br/>Function: NULL); |
|
||||
| EnergyCntReset | | Resets the total Energy Counter, the one that is usually kept after device reboots. After this commands, the counter will start again from 0. | File: driver/drv_bl_shared.c<br/>Function: BL09XX_ResetEnergyCounter |
|
||||
@ -122,6 +123,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 | File: driver/drv_bp5758d.c<br/>Function: BP5758D_Map |
|
||||
| BP5758D_Current | [MaxCurrent] | Sets the maximum current limit for BP5758D driver | File: driver/drv_bp5758d.c<br/>Function: BP5758D_Current |
|
||||
| BridgePulseLength | [FloatValue] | Setup value for bridge pulse len | File: driver/drv_bridge_driver.c<br/>Function: Bridge_Pulse_length |
|
||||
| CHT_Calibrate | | Calibrate the CHT Sensor as Tolerance is +/-2 degrees C.<br/>e.g.:SHT_Calibrate -4 10 | File: driver/drv_cht8305.c<br/>Function: CHT_Calibrate |
|
||||
| setButtonColor | [ButtonIndex][Color] | Sets the colour of custom scriptable HTTP page button | File: driver/drv_httpButtons.c<br/>Function: CMD_setButtonColor |
|
||||
| setButtonCommand | [ButtonIndex][Command] | Sets the command of custom scriptable HTTP page button | File: driver/drv_httpButtons.c<br/>Function: CMD_setButtonCommand |
|
||||
| setButtonLabel | [ButtonIndex][Label] | Sets the label of custom scriptable HTTP page button | File: driver/drv_httpButtons.c<br/>Function: CMD_setButtonLabel |
|
||||
@ -147,6 +149,10 @@ Do not add anything here, as it will overwritten with next rebuild.
|
||||
| VoltageSet | Voltage | Measure the real voltage with an external, reliable power meter and enter this voltage via this command to calibrate. The calibration is automatically saved in the flash memory. | File: driver/drv_pwrCal.c<br/>Function: NULL); |
|
||||
| CurrentSet | Current | Measure the real Current with an external, reliable power meter and enter this Current via this command to calibrate. The calibration is automatically saved in the flash memory. | File: driver/drv_pwrCal.c<br/>Function: NULL); |
|
||||
| PowerSet | Power | Measure the real Power with an external, reliable power meter and enter this Power via this command to calibrate. The calibration is automatically saved in the flash memory. | File: driver/drv_pwrCal.c<br/>Function: NULL); |
|
||||
| SGP_cycle | [int] | change cycle of measurement by default every 10 seconds 0 to deactivate<br/>e.g.:SGP_Cycle 60 | File: drv/drv_sgp.c<br/>Function: SGP_cycle |
|
||||
| SGP_GetVersion | | SGP : get version<br/>e.g.:SGP_GetVersion | File: drv/drv_sgp.c<br/>Function: SGP_GetVersion |
|
||||
| SGP_GetBaseline | | SGP Get baseline<br/>e.g.:SGP_GetBaseline | File: drv/drv_sgp.c<br/>Function: SGP_GetBaseline |
|
||||
| SGP_SoftReset | | SGP i2C soft reset<br/>e.g.:SGP_SoftReset | File: drv/drv_sgp.c<br/>Function: SGP_SoftReset |
|
||||
| SHT_cycle | [int] | change cycle of measurement by default every 10 seconds 0 to deactivate<br/>e.g.:SHT_Cycle 60 | File: drv/drv_sht3x.c<br/>Function: SHT_cycle |
|
||||
| SHT_Calibrate | | Calibrate the SHT Sensor as Tolerance is +/-2 degrees C.<br/>e.g.:SHT_Calibrate -4 10 | File: driver/drv_sht3x.c<br/>Function: SHT3X_Calibrate |
|
||||
| SHT_MeasurePer | | Retrieve Periodical measurement for SHT<br/>e.g.:SHT_Measure | File: driver/drv_sht3x.c<br/>Function: SHT3X_MeasurePer |
|
||||
@ -178,6 +184,7 @@ Do not add anything here, as it will overwritten with next rebuild.
|
||||
| DGR_SendRGBCW | [GroupName][HexRGBCW] | Sends a RGBCW message to given Tasmota Device Group with no reliability. Requires no prior setup and can control any group, but won't retransmit. You can use this command in two ways, first is like DGR_SendRGBCW GroupName 255 255 0, etc, second is DGR_SendRGBCW GroupName FF00FF00 etc etc. | File: driver/drv_tasmotaDeviceGroups.c<br/>Function: CMD_DGR_SendRGBCW |
|
||||
| DGR_SendFixedColor | [GroupName][TasColorIndex] | Sends a FixedColor message to given Tasmota Device Group with no reliability. Requires no prior setup and can control any group, but won't retransmit. | File: driver/drv_tasmotaDeviceGroups.c<br/>Function: CMD_DGR_SendFixedColor |
|
||||
| SetupTestPower | | NULL | File: driver/drv_test_drivers.c<br/>Function: TestPower_Setup |
|
||||
| TMGN_SetBit | [CharIndex] [BitIndex] [BitValue] | Set given bit of given digit to 1 or 0. | File: driver/drv_tm1637.c<br/>Function: NULL); |
|
||||
| TMGN_Clear | | This clears the TM1637/GN932/etc display | File: driver/drv_tm_gn_display_shared.c<br/>Function: NULL); |
|
||||
| TMGN_Char | [CharIndex] [CharCode] | This allows you to set binary code for given char, valid chars range is 0 to 15, because this is 7-seg display | File: driver/drv_tm1637.c<br/>Function: NULL); |
|
||||
| TMGN_Print | [StartOfs] [MaxLenOr0] [StringText] [optionalBClampWithZeroesForClock] | This allows you to print string on TM1637/GN932/etc display, it supports variables expansion | File: driver/drv_tm_gn_display_shared.c<br/>Function: NULL); |
|
||||
|
||||
@ -107,7 +107,8 @@ Do not add anything here, as it will overwritten with next rebuild.
|
||||
| lfs_test1 | [FileName] | Tests the LFS file reading feature. |
|
||||
| lfs_test2 | [FileName] | Tests the LFS file reading feature. |
|
||||
| lfs_test3 | [FileName] | Tests the LFS file reading feature. |
|
||||
| Battery_Setup | [int][int][float][int][int] | measure battery based on ADC args minbatt and maxbatt in mv. optional V_divider(2), Vref(default 2400) and ADC bits(4096) and <br/>e.g.:Battery_Setup 1500 3000 2 2400 4096 |
|
||||
| AB_Map | [int] | Sets margines for ADC button codes. For given N margins, there are N+1 possible ADC button values (one should be reserved for 'no button') |
|
||||
| Battery_Setup | [float][float][float][float][float] | measure battery based on ADC args minbatt and maxbatt in mv. optional V_divider(2), Vref(default 2400) and ADC bits(4096) and <br/>e.g.:Battery_Setup 1500 3000 2 2400 4096 |
|
||||
| Battery_cycle | [int] | change cycle of measurement by default every 10 seconds<br/>e.g.:Battery_Setup 60 |
|
||||
| PowerMax | BL0937_PowerMax | |
|
||||
| EnergyCntReset | | Resets the total Energy Counter, the one that is usually kept after device reboots. After this commands, the counter will start again from 0. |
|
||||
@ -122,6 +123,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 |
|
||||
| BP5758D_Current | [MaxCurrent] | Sets the maximum current limit for BP5758D driver |
|
||||
| BridgePulseLength | [FloatValue] | Setup value for bridge pulse len |
|
||||
| CHT_Calibrate | | Calibrate the CHT Sensor as Tolerance is +/-2 degrees C.<br/>e.g.:SHT_Calibrate -4 10 |
|
||||
| setButtonColor | [ButtonIndex][Color] | Sets the colour of custom scriptable HTTP page button |
|
||||
| setButtonCommand | [ButtonIndex][Command] | Sets the command of custom scriptable HTTP page button |
|
||||
| setButtonLabel | [ButtonIndex][Label] | Sets the label of custom scriptable HTTP page button |
|
||||
@ -147,6 +149,10 @@ Do not add anything here, as it will overwritten with next rebuild.
|
||||
| VoltageSet | Voltage | Measure the real voltage with an external, reliable power meter and enter this voltage via this command to calibrate. The calibration is automatically saved in the flash memory. |
|
||||
| CurrentSet | Current | Measure the real Current with an external, reliable power meter and enter this Current via this command to calibrate. The calibration is automatically saved in the flash memory. |
|
||||
| PowerSet | Power | Measure the real Power with an external, reliable power meter and enter this Power via this command to calibrate. The calibration is automatically saved in the flash memory. |
|
||||
| SGP_cycle | [int] | change cycle of measurement by default every 10 seconds 0 to deactivate<br/>e.g.:SGP_Cycle 60 |
|
||||
| SGP_GetVersion | | SGP : get version<br/>e.g.:SGP_GetVersion |
|
||||
| SGP_GetBaseline | | SGP Get baseline<br/>e.g.:SGP_GetBaseline |
|
||||
| SGP_SoftReset | | SGP i2C soft reset<br/>e.g.:SGP_SoftReset |
|
||||
| SHT_cycle | [int] | change cycle of measurement by default every 10 seconds 0 to deactivate<br/>e.g.:SHT_Cycle 60 |
|
||||
| SHT_Calibrate | | Calibrate the SHT Sensor as Tolerance is +/-2 degrees C.<br/>e.g.:SHT_Calibrate -4 10 |
|
||||
| SHT_MeasurePer | | Retrieve Periodical measurement for SHT<br/>e.g.:SHT_Measure |
|
||||
@ -178,6 +184,7 @@ Do not add anything here, as it will overwritten with next rebuild.
|
||||
| DGR_SendRGBCW | [GroupName][HexRGBCW] | Sends a RGBCW message to given Tasmota Device Group with no reliability. Requires no prior setup and can control any group, but won't retransmit. You can use this command in two ways, first is like DGR_SendRGBCW GroupName 255 255 0, etc, second is DGR_SendRGBCW GroupName FF00FF00 etc etc. |
|
||||
| DGR_SendFixedColor | [GroupName][TasColorIndex] | Sends a FixedColor message to given Tasmota Device Group with no reliability. Requires no prior setup and can control any group, but won't retransmit. |
|
||||
| SetupTestPower | | NULL |
|
||||
| TMGN_SetBit | [CharIndex] [BitIndex] [BitValue] | Set given bit of given digit to 1 or 0. |
|
||||
| TMGN_Clear | | This clears the TM1637/GN932/etc display |
|
||||
| TMGN_Char | [CharIndex] [CharCode] | This allows you to set binary code for given char, valid chars range is 0 to 15, because this is 7-seg display |
|
||||
| TMGN_Print | [StartOfs] [MaxLenOr0] [StringText] [optionalBClampWithZeroesForClock] | This allows you to print string on TM1637/GN932/etc display, it supports variables expansion |
|
||||
|
||||
@ -27,15 +27,18 @@ Do not add anything here, as it will overwritten with next rebuild.
|
||||
| PWMToggler | PWMToggler is a custom abstraction layer that can run on top of raw PWM channels. It provides ability to turn off/on the PWM while keeping it's value, which is not possible by direct channel operations. It can be used for some custom devices with extra lights/lasers. See example [here](https://www.elektroda.com/rtvforum/topic3939064.html). |
|
||||
| DoorSensor | DoorSensor is using deep sleep to preserve battery. This is used for devices without TuyaMCU, where BK deep sleep and wakeup on GPIO is used. This drives requires you to set a DoorSensor pin. Change on door sensor pin wakes up the device. If there are no changes for some time, device goes to sleep. See example [here](https://www.elektroda.com/rtvforum/topic3960149.html). |
|
||||
| MAX72XX_Clock | Simple hardcoded driver for MAX72XX clock. Requirex manual start of MAX72XX driver with MAX72XX setup and NTP start. |
|
||||
| ADCButton | This allows you to connect multiple buttons on single ADC pin. Each button must have a different resistor value, this works by probing the voltage on ADC from a resistor divider. You need to select AB_Map first. See forum post for [details](https://www.elektroda.com/rtvforum/viewtopic.php?p=20541973#20541973). |
|
||||
| SM2135 | SM2135 custom-'I2C' LED driver for RGBCW lights. This will start automatically if you set both SM2135 pin roles. This may need you to remap the RGBCW indexes with SM2135_Map command |
|
||||
| BP5758D | BP5758D custom-'I2C' LED driver for RGBCW lights. This will start automatically if you set both BP5758D pin roles. This may need you to remap the RGBCW indexes with BP5758D_Map command. This driver is used in some of BL602/Sonoff bulbs, see [video flashing tutorial here](https://www.youtube.com/watch?v=L6d42IMGhHw) |
|
||||
| BP1658CJ | BP1658CJ custom-'I2C' LED driver for RGBCW lights. This will start automatically if you set both BP1658CJ pin roles. This may need you to remap the RGBCW indexes with BP1658CJ_Map command |
|
||||
| SM2235 | SM2335 andd SM2235 custom-'I2C' LED driver for RGBCW lights. This will start automatically if you set both SM2235 pin roles. This may need you to remap the RGBCW indexes with SM2235_Map command |
|
||||
| CHT8305 | TODO |
|
||||
| MAX72XX | WIP driver |
|
||||
| CHT8305 | CHT8305 is a Temperature and Humidity sensor with I2C interface. |
|
||||
| KP18068 | KP18068 I2C LED driver |
|
||||
| MAX72XX | MAX72XX LED matrix display driver with font and simple script interface. |
|
||||
| TM1637 | Driver for 7-segment LED display with DIO/CLK interface |
|
||||
| GN6932 | Driver for 7-segment LED display with DIO/CLK/STB interface |
|
||||
| GN6932 | Driver for 7-segment LED display with DIO/CLK/STB interface. See [this topic](https://www.elektroda.com/rtvforum/topic3971252.html) for details. |
|
||||
| SHT3X | Humidity/temperature sensor. See [SHT Sensor tutorial topic here](https://www.elektroda.com/rtvforum/topic3958369.html), also see [this sensor teardown](https://www.elektroda.com/rtvforum/topic3945688.html) |
|
||||
| SGP | SGP Air Quality sensor with I2C interface. |
|
||||
| ShiftRegister | ShiftRegisterShiftRegisterShiftRegisterShiftRegister |
|
||||
| Battery | Custom mechanism to measure battery level with ADC and an optional relay. See [example here](https://www.elektroda.com/rtvforum/topic3959103.html). |
|
||||
| Bridge | TODO |
|
||||
|
||||
@ -43,3 +43,4 @@ Do not add anything here, as it will overwritten with next rebuild.
|
||||
| 35 | [HASS] Deactivate avty_t flag for sensor when publishing to HASS (permit to keep value) |
|
||||
| 36 | [DRV] Deactivate Autostart of all drivers |
|
||||
| 37 | [WiFi] Quick connect to WiFi on reboot (TODO: check if it works for you and report on github) |
|
||||
| 38 | [Power] Set power and current to zero if all relays are open |
|
||||
|
||||
@ -71,4 +71,7 @@ Do not add anything here, as it will overwritten with next rebuild.
|
||||
| TM1637_CLK | TM1637 LED display driver CLK pin. Setting all required TM1637 pins will autostart related driver |
|
||||
| BL0937_SEL_n | Inverted SEL alternative for BL0937. Choose only one, either SEL or SEL_n. SEL_n may be needed in rare cases. |
|
||||
| DoorSensorWithDeepSleep_pd | As DoorSensorWithDeepSleep, but with pulldown resistor |
|
||||
| SGP_CLK | SGP Quality Sensor Clock line. will autostart related driver |
|
||||
| SGP_DAT | SGP Quality Sensor Data line. will autostart related driver |
|
||||
| ADC_Button | Single ADC with multiple buttons connected.d |
|
||||
| Total_Options | Current total number of available IOR roles |
|
||||
|
||||
@ -917,9 +917,18 @@
|
||||
"requires": "",
|
||||
"examples": ""
|
||||
},
|
||||
{
|
||||
"name": "AB_Map",
|
||||
"args": "[int]",
|
||||
"descr": "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')",
|
||||
"fn": "Cmd_ADCButtonMap",
|
||||
"file": "drv/drv_adcButton.c",
|
||||
"requires": "",
|
||||
"examples": ""
|
||||
},
|
||||
{
|
||||
"name": "Battery_Setup",
|
||||
"args": "[int][int][float][int][int]",
|
||||
"args": "[float][float][float][float][float]",
|
||||
"descr": "measure battery based on ADC args minbatt and maxbatt in mv. optional V_divider(2), Vref(default 2400) and ADC bits(4096) and ",
|
||||
"fn": "Battery_Setup",
|
||||
"file": "drv/drv_battery.c",
|
||||
@ -1052,6 +1061,15 @@
|
||||
"requires": "",
|
||||
"examples": ""
|
||||
},
|
||||
{
|
||||
"name": "CHT_Calibrate",
|
||||
"args": "",
|
||||
"descr": "Calibrate the CHT Sensor as Tolerance is +/-2 degrees C.",
|
||||
"fn": "CHT_Calibrate",
|
||||
"file": "driver/drv_cht8305.c",
|
||||
"requires": "",
|
||||
"examples": "SHT_Calibrate -4 10"
|
||||
},
|
||||
{
|
||||
"name": "setButtonColor",
|
||||
"args": "[ButtonIndex][Color]",
|
||||
@ -1277,6 +1295,42 @@
|
||||
"requires": "",
|
||||
"examples": ""
|
||||
},
|
||||
{
|
||||
"name": "SGP_cycle",
|
||||
"args": "[int]",
|
||||
"descr": "change cycle of measurement by default every 10 seconds 0 to deactivate",
|
||||
"fn": "SGP_cycle",
|
||||
"file": "drv/drv_sgp.c",
|
||||
"requires": "",
|
||||
"examples": "SGP_Cycle 60"
|
||||
},
|
||||
{
|
||||
"name": "SGP_GetVersion",
|
||||
"args": "",
|
||||
"descr": "SGP : get version",
|
||||
"fn": "SGP_GetVersion",
|
||||
"file": "drv/drv_sgp.c",
|
||||
"requires": "",
|
||||
"examples": "SGP_GetVersion"
|
||||
},
|
||||
{
|
||||
"name": "SGP_GetBaseline",
|
||||
"args": "",
|
||||
"descr": "SGP Get baseline",
|
||||
"fn": "SGP_GetBaseline",
|
||||
"file": "drv/drv_sgp.c",
|
||||
"requires": "",
|
||||
"examples": "SGP_GetBaseline"
|
||||
},
|
||||
{
|
||||
"name": "SGP_SoftReset",
|
||||
"args": "",
|
||||
"descr": "SGP i2C soft reset",
|
||||
"fn": "SGP_SoftReset",
|
||||
"file": "drv/drv_sgp.c",
|
||||
"requires": "",
|
||||
"examples": "SGP_SoftReset"
|
||||
},
|
||||
{
|
||||
"name": "SHT_cycle",
|
||||
"args": "[int]",
|
||||
@ -1556,6 +1610,15 @@
|
||||
"requires": "",
|
||||
"examples": ""
|
||||
},
|
||||
{
|
||||
"name": "TMGN_SetBit",
|
||||
"args": "[CharIndex] [BitIndex] [BitValue]",
|
||||
"descr": "Set given bit of given digit to 1 or 0.",
|
||||
"fn": "NULL);",
|
||||
"file": "driver/drv_tm1637.c",
|
||||
"requires": "",
|
||||
"examples": ""
|
||||
},
|
||||
{
|
||||
"name": "TMGN_Clear",
|
||||
"args": "",
|
||||
|
||||
@ -119,6 +119,12 @@
|
||||
"descr": "Simple hardcoded driver for MAX72XX clock. Requirex manual start of MAX72XX driver with MAX72XX setup and NTP start.",
|
||||
"requires": ""
|
||||
},
|
||||
{
|
||||
"name": "ADCButton",
|
||||
"title": "TODO",
|
||||
"descr": "This allows you to connect multiple buttons on single ADC pin. Each button must have a different resistor value, this works by probing the voltage on ADC from a resistor divider. You need to select AB_Map first. See forum post for [details](https://www.elektroda.com/rtvforum/viewtopic.php?p=20541973#20541973).",
|
||||
"requires": ""
|
||||
},
|
||||
{
|
||||
"name": "SM2135",
|
||||
"title": "TODO",
|
||||
@ -146,13 +152,19 @@
|
||||
{
|
||||
"name": "CHT8305",
|
||||
"title": "TODO",
|
||||
"descr": "TODO",
|
||||
"descr": "CHT8305 is a Temperature and Humidity sensor with I2C interface.",
|
||||
"requires": ""
|
||||
},
|
||||
{
|
||||
"name": "KP18068",
|
||||
"title": "TODO",
|
||||
"descr": "KP18068 I2C LED driver",
|
||||
"requires": ""
|
||||
},
|
||||
{
|
||||
"name": "MAX72XX",
|
||||
"title": "TODO",
|
||||
"descr": "WIP driver",
|
||||
"descr": "MAX72XX LED matrix display driver with font and simple script interface.",
|
||||
"requires": ""
|
||||
},
|
||||
{
|
||||
@ -164,7 +176,7 @@
|
||||
{
|
||||
"name": "GN6932",
|
||||
"title": "TODO",
|
||||
"descr": "Driver for 7-segment LED display with DIO/CLK/STB interface",
|
||||
"descr": "Driver for 7-segment LED display with DIO/CLK/STB interface. See [this topic](https://www.elektroda.com/rtvforum/topic3971252.html) for details.",
|
||||
"requires": ""
|
||||
},
|
||||
{
|
||||
@ -173,6 +185,12 @@
|
||||
"descr": "Humidity/temperature sensor. See [SHT Sensor tutorial topic here](https://www.elektroda.com/rtvforum/topic3958369.html), also see [this sensor teardown](https://www.elektroda.com/rtvforum/topic3945688.html)",
|
||||
"requires": ""
|
||||
},
|
||||
{
|
||||
"name": "SGP",
|
||||
"title": "TODO",
|
||||
"descr": "SGP Air Quality sensor with I2C interface.",
|
||||
"requires": ""
|
||||
},
|
||||
{
|
||||
"name": "ShiftRegister",
|
||||
"title": "TODO",
|
||||
|
||||
@ -264,5 +264,12 @@
|
||||
"title": "todo",
|
||||
"file": "new_pins.h",
|
||||
"descr": "[WiFi] Quick connect to WiFi on reboot (TODO: check if it works for you and report on github)"
|
||||
},
|
||||
{
|
||||
"index": "38",
|
||||
"enum": "OBK_FLAG_POWER_FORCE_ZERO_IF_RELAYS_OPEN",
|
||||
"title": "todo",
|
||||
"file": "new_pins.h",
|
||||
"descr": "[Power] Set power and current to zero if all relays are open"
|
||||
}
|
||||
]
|
||||
@ -527,6 +527,30 @@
|
||||
"file": "new_pins.h",
|
||||
"driver": ""
|
||||
},
|
||||
{
|
||||
"name": "SGP_CLK",
|
||||
"title": "TODO",
|
||||
"descr": "SGP Quality Sensor Clock line. will autostart related driver",
|
||||
"enum": "IOR_SGP_CLK",
|
||||
"file": "new_pins.h",
|
||||
"driver": ""
|
||||
},
|
||||
{
|
||||
"name": "SGP_DAT",
|
||||
"title": "TODO",
|
||||
"descr": "SGP Quality Sensor Data line. will autostart related driver",
|
||||
"enum": "IOR_SGP_DAT",
|
||||
"file": "new_pins.h",
|
||||
"driver": ""
|
||||
},
|
||||
{
|
||||
"name": "ADC_Button",
|
||||
"title": "TODO",
|
||||
"descr": "Single ADC with multiple buttons connected.d",
|
||||
"enum": "ADC_Button",
|
||||
"file": "new_pins.h",
|
||||
"driver": ""
|
||||
},
|
||||
{
|
||||
"name": "Total_Options",
|
||||
"title": "TODO",
|
||||
|
||||
@ -52,7 +52,7 @@ void DRV_ADCButton_Init() {
|
||||
|
||||
|
||||
//cmddetail:{"name":"AB_Map","args":"[int]",
|
||||
//cmddetail:"descr":"cqqqqs",
|
||||
//cmddetail:"descr":"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')",
|
||||
//cmddetail:"fn":"Cmd_ADCButtonMap","file":"drv/drv_adcButton.c","requires":"",
|
||||
//cmddetail:"examples":""}
|
||||
CMD_RegisterCommand("AB_Map", Cmd_ADCButtonMap, NULL);
|
||||
|
||||
@ -123,7 +123,7 @@ commandResult_t Battery_cycle(const void* context, const char* cmd, const char*
|
||||
// startDriver Battery
|
||||
void Batt_Init() {
|
||||
|
||||
//cmddetail:{"name":"Battery_Setup","args":"[int][int][float][int][int]",
|
||||
//cmddetail:{"name":"Battery_Setup","args":"[float][float][float][float][float]",
|
||||
//cmddetail:"descr":"measure battery based on ADC args minbatt and maxbatt in mv. optional V_divider(2), Vref(default 2400) and ADC bits(4096) and ",
|
||||
//cmddetail:"fn":"Battery_Setup","file":"drv/drv_battery.c","requires":"",
|
||||
//cmddetail:"examples":"Battery_Setup 1500 3000 2 2400 4096"}
|
||||
|
||||
@ -189,7 +189,7 @@ static driver_t g_drivers[] = {
|
||||
{ "MAX72XX_Clock", DRV_MAX72XX_Clock_Init, DRV_MAX72XX_Clock_OnEverySecond, NULL, DRV_MAX72XX_Clock_RunFrame, NULL, NULL, false },
|
||||
//drvdetail:{"name":"ADCButton",
|
||||
//drvdetail:"title":"TODO",
|
||||
//drvdetail:"descr":".",
|
||||
//drvdetail:"descr":"This allows you to connect multiple buttons on single ADC pin. Each button must have a different resistor value, this works by probing the voltage on ADC from a resistor divider. You need to select AB_Map first. See forum post for [details](https://www.elektroda.com/rtvforum/viewtopic.php?p=20541973#20541973).",
|
||||
//drvdetail:"requires":""}
|
||||
{ "ADCButton", DRV_ADCButton_Init, NULL, NULL, DRV_ADCButton_RunFrame, NULL, NULL, false },
|
||||
#endif
|
||||
@ -218,7 +218,7 @@ static driver_t g_drivers[] = {
|
||||
#if defined(PLATFORM_BEKEN) || defined(WINDOWS)
|
||||
//drvdetail:{"name":"CHT8305",
|
||||
//drvdetail:"title":"TODO",
|
||||
//drvdetail:"descr":"TODO",
|
||||
//drvdetail:"descr":"CHT8305 is a Temperature and Humidity sensor with I2C interface.",
|
||||
//drvdetail:"requires":""}
|
||||
{ "CHT8305", CHT8305_Init, CHT8305_OnEverySecond, CHT8305_AppendInformationToHTTPIndexPage, NULL, NULL, NULL, false },
|
||||
//drvdetail:{"name":"KP18068",
|
||||
@ -228,7 +228,7 @@ static driver_t g_drivers[] = {
|
||||
{ "KP18068", KP18068_Init, NULL, NULL, NULL, NULL, NULL, false },
|
||||
//drvdetail:{"name":"MAX72XX",
|
||||
//drvdetail:"title":"TODO",
|
||||
//drvdetail:"descr":"WIP driver",
|
||||
//drvdetail:"descr":"MAX72XX LED matrix display driver with font and simple script interface.",
|
||||
//drvdetail:"requires":""}
|
||||
{ "MAX72XX", DRV_MAX72XX_Init, NULL, NULL, NULL, NULL, NULL, false },
|
||||
//drvdetail:{"name":"TM1637",
|
||||
@ -238,7 +238,7 @@ static driver_t g_drivers[] = {
|
||||
{ "TM1637", TM1637_Init, NULL, NULL, NULL, NULL, NULL, false },
|
||||
//drvdetail:{"name":"GN6932",
|
||||
//drvdetail:"title":"TODO",
|
||||
//drvdetail:"descr":"Driver for 7-segment LED display with DIO/CLK/STB interface",
|
||||
//drvdetail:"descr":"Driver for 7-segment LED display with DIO/CLK/STB interface. See [this topic](https://www.elektroda.com/rtvforum/topic3971252.html) for details.",
|
||||
//drvdetail:"requires":""}
|
||||
{ "GN6932", GN6932_Init, NULL, NULL, NULL, NULL, NULL, false },
|
||||
//drvdetail:{"name":"SHT3X",
|
||||
@ -248,7 +248,7 @@ static driver_t g_drivers[] = {
|
||||
{ "SHT3X", SHT3X_Init, SHT3X_OnEverySecond, SHT3X_AppendInformationToHTTPIndexPage, NULL, SHT3X_StopDriver, NULL, false },
|
||||
//drvdetail:{"name":"SGP",
|
||||
//drvdetail:"title":"TODO",
|
||||
//drvdetail:"descr":"Air Quality sensor.",
|
||||
//drvdetail:"descr":"SGP Air Quality sensor with I2C interface.",
|
||||
//drvdetail:"requires":""}
|
||||
{ "SGP", SGP_Init, SGP_OnEverySecond, SGP_AppendInformationToHTTPIndexPage, NULL, SGP_StopDriver, NULL, false },
|
||||
|
||||
|
||||
Reference in New Issue
Block a user