Skip to content

Commit

Permalink
faq and docs update
Browse files Browse the repository at this point in the history
  • Loading branch information
openshwprojects committed Aug 27, 2023
1 parent 8b0c85f commit 43439d8
Show file tree
Hide file tree
Showing 7 changed files with 30 additions and 14 deletions.
10 changes: 5 additions & 5 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 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) (43 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) (41 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) (40 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) (29 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) (40 total) | Channel types are often not required and don't have to be configured, but in some cases they are required for better device control from OpenBeken web panel. Channel types describes the kind of value stored in channel, for example, if you have a Tuya Fan Controller with 3 speeds control, you can set the channel type to LowMidHigh and it will display the correct UI radiobutton on OpenBeken panel.<br>Some channels have '_div10' or '_div100' sufixes. This is for TuyaMCU. This is needed because TuyaMCU sends values as integers, so it sends, for example, 215 for 21.5C temperature, and we store it internally as 215 and only convert to float for display. |
| [FAQ](https://github.com/openshwprojects/OpenBK7231T_App/blob/main/docs/faq.md) (27 total) | Here is a detailed list of questions you may ask. Some information from docs is repeated here. |
| [Channel Types](https://github.com/openshwprojects/OpenBK7231T_App/blob/main/docs/channelTypes.md) (41 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) (29 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) (279 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) (16 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 |
| [Autoexec.bat examples (configs)](https://github.com/openshwprojects/OpenBK7231T_App/blob/main/docs/autoexecExamples.md) (17 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. |
| [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) (279 total) | More details on commands. |
1 change: 1 addition & 0 deletions docs/channelTypes.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,4 +44,5 @@ Do not add anything here, as it will overwritten with next rebuild.
| ReadOnlyLowMidHigh | Like LowMidHigh, but just read only |
| SmokePercent | Smoke percentage |
| Illuminance | Illuminance in Lux |
| Toggle_Inv | Toggle_Inv |
| Max | This is the current total number of available channel types. |
3 changes: 1 addition & 2 deletions docs/drivers.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,8 +36,7 @@ Do not add anything here, as it will overwritten with next rebuild.
| 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.<br/>See also [SM2235 on forum](https://www.elektroda.com/rtvforum/find.php?q=SM2235). |
| CHT8305 | CHT8305 is a Temperature and Humidity sensor with I2C interface.<br/>See also [CHT8305 on forum](https://www.elektroda.com/rtvforum/find.php?q=CHT8305). |
| MCP9808 | MCP9808 is a Temperature sensor with I2C interface and an external wakeup pin, see [docs](https://www.elektroda.pl/rtvforum/topic3988466.html).<br/>See also [MCP9808 on forum](https://www.elektroda.com/rtvforum/find.php?q=MCP9808). |
| KP18068 | KP18068 I2C LED driver. Unfinished due to the lack of the information.<br/>See also [KP18068 on forum](https://www.elektroda.com/rtvforum/find.php?q=KP18068). |
| KP18058 | KP18058 I2C LED driver. Working, see reverse-engineering [topic](https://www.elektroda.pl/rtvforum/topic3991620.html).<br/>See also [KP18058 on forum](https://www.elektroda.com/rtvforum/find.php?q=KP18058). |
| KP18058 | KP18058 I2C LED driver. Supports also KP18068. Working, see reverse-engineering [topic](https://www.elektroda.pl/rtvforum/topic3991620.html).<br/>See also [KP18058 on forum](https://www.elektroda.com/rtvforum/find.php?q=KP18058). |
| MAX72XX | MAX72XX LED matrix display driver with font and simple script interface. See [protocol explanation](https://www.elektroda.pl/rtvforum/viewtopic.php?p=18040628#18040628).<br/>See also [MAX72XX on forum](https://www.elektroda.com/rtvforum/find.php?q=MAX72XX). |
| TM1637 | Driver for 7-segment LED display with DIO/CLK interface.<br/>See also [TM1637 on forum](https://www.elektroda.com/rtvforum/find.php?q=TM1637). |
| GN6932 | Driver for 7-segment LED display with DIO/CLK/STB interface. See [this topic](https://www.elektroda.com/rtvforum/topic3971252.html) for details.<br/>See also [GN6932 on forum](https://www.elektroda.com/rtvforum/find.php?q=GN6932). |
Expand Down
6 changes: 6 additions & 0 deletions docs/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,9 @@ All questions/answers were taken from json file.
**Question:** *I entered wrong SSID and my device is not accessible. How to recover?*<br>**A:** Do five short power on/power off cycles (but not too short, because device might have capacitors and they need to discharge every time). Device will go back to AP mode (aka Safe Mode). Remember that in Safe Mode, pins are disabled, drivers are also not run, so don't worry if you see your device seemingly not responding to buttons, etc, etc.


**Question:** *My BL0937 power metering socket shows visible measurement spikes, what's wrong?*<br>**A:** Enabled PowerSave may cause it. Remove PowerSave 1 command from startup and reboot


**Question:** *How do I enable more logging? How to make more logs visible?*<br>**A:** First type 'loglevel x' in console, where x is 0 to 7, default value is 3 (log all up to info), value 4 will also log debug logs, and value 5 will include 'extradebug'. Then, on online panel, also switch filter to 'All' (both steps must be done for logs to show up)


Expand Down Expand Up @@ -75,6 +78,9 @@ All questions/answers were taken from json file.
**Question:** *I flashed OpenBeken, configured my SSID and pass in AP mode, but now it does not connect to my WiFi, what's wrong?*<br>**A:** Multiple things may have gone wrong. <br>First of all, make sure you power your wifi module from reliable 3.3V power supply. This problem happens frequently on BL602 if you power module outside circuit from cheap 3.3V USB to UART converter.<br>Second issue might be just incorrect SSID/WiFi data - do 5 power off/on cycles to go to Safe Mode and correct the credentials.<br>Third issue happens on some BK modules. They might have RF partition broken. To fix that, use either our BK7231 flash tool, click button 'Restore RF partition', or in our Web Application, in Flash Tab, click 'Restore RF partition' button. This will also assign new MAC.


**Question:** *How to disable MQTT?*<br>**A:** On MQTT configure page, just enter empty host name. Alternatively, use MqttHost "" command


**Question:** *How to configure ping watchdog to do a relay cycle when given IP does not respond for a given amount of time?*<br>**A:** See the following [example here](https://www.elektroda.com/rtvforum/viewtopic.php?p=20368812#20368812)


Expand Down
8 changes: 8 additions & 0 deletions docs/json/channelTypes.json
Original file line number Diff line number Diff line change
Expand Up @@ -311,6 +311,14 @@
"file": "new_pins.h",
"driver": ""
},
{
"name": "Toggle_Inv",
"title": "TODO",
"descr": "Toggle_Inv",
"enum": "ChType_Toggle_Inv",
"file": "new_pins.h",
"driver": ""
},
{
"name": "Max",
"title": "TODO",
Expand Down
8 changes: 1 addition & 7 deletions docs/json/drivers.json
Original file line number Diff line number Diff line change
Expand Up @@ -173,16 +173,10 @@
"descr": "MCP9808 is a Temperature sensor with I2C interface and an external wakeup pin, see [docs](https://www.elektroda.pl/rtvforum/topic3988466.html).",
"requires": ""
},
{
"name": "KP18068",
"title": "TODO",
"descr": "KP18068 I2C LED driver. Unfinished due to the lack of the information.",
"requires": ""
},
{
"name": "KP18058",
"title": "TODO",
"descr": "KP18058 I2C LED driver. Working, see reverse-engineering [topic](https://www.elektroda.pl/rtvforum/topic3991620.html)",
"descr": "KP18058 I2C LED driver. Supports also KP18068. Working, see reverse-engineering [topic](https://www.elektroda.pl/rtvforum/topic3991620.html)",
"requires": ""
},
{
Expand Down
8 changes: 8 additions & 0 deletions docs/json/faq.json
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,10 @@
"question": "I entered wrong SSID and my device is not accessible. How to recover?",
"answer": "Do five short power on/power off cycles (but not too short, because device might have capacitors and they need to discharge every time). Device will go back to AP mode (aka Safe Mode). Remember that in Safe Mode, pins are disabled, drivers are also not run, so don't worry if you see your device seemingly not responding to buttons, etc, etc."
},
{
"question": "My BL0937 power metering socket shows visible measurement spikes, what's wrong?",
"answer": "Enabled PowerSave may cause it. Remove PowerSave 1 command from startup and reboot"
},
{
"question": "How do I enable more logging? How to make more logs visible?",
"answer": "First type 'loglevel x' in console, where x is 0 to 7, default value is 3 (log all up to info), value 4 will also log debug logs, and value 5 will include 'extradebug'. Then, on online panel, also switch filter to 'All' (both steps must be done for logs to show up)"
Expand Down Expand Up @@ -95,6 +99,10 @@
"question": "I flashed OpenBeken, configured my SSID and pass in AP mode, but now it does not connect to my WiFi, what's wrong?",
"answer": "Multiple things may have gone wrong. <br>First of all, make sure you power your wifi module from reliable 3.3V power supply. This problem happens frequently on BL602 if you power module outside circuit from cheap 3.3V USB to UART converter.<br>Second issue might be just incorrect SSID/WiFi data - do 5 power off/on cycles to go to Safe Mode and correct the credentials.<br>Third issue happens on some BK modules. They might have RF partition broken. To fix that, use either our BK7231 flash tool, click button 'Restore RF partition', or in our Web Application, in Flash Tab, click 'Restore RF partition' button. This will also assign new MAC."
},
{
"question": "How to disable MQTT?",
"answer": "On MQTT configure page, just enter empty host name. Alternatively, use MqttHost \"\" command"
},
{
"question": "How to configure ping watchdog to do a relay cycle when given IP does not respond for a given amount of time?",
"answer": "See the following [example here](https://www.elektroda.com/rtvforum/viewtopic.php?p=20368812#20368812)"
Expand Down

0 comments on commit 43439d8

Please sign in to comment.