diff --git a/docs/README.md b/docs/README.md index 397deee2d..6ec48e206 100644 --- a/docs/README.md +++ b/docs/README.md @@ -11,8 +11,8 @@ Do not add anything here, as it will overwritten with next rebuild. | [Script constants](https://github.com/openshwprojects/OpenBK7231T_App/blob/main/docs/constants.md) (18 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.
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) (22 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) (225 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) (226 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) (6 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) (7 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 | | [Script examples](https://github.com/openshwprojects/OpenBK7231T_App/blob/main/docs/scriptExamples.md) (4 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 advananced 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) (225 total) | More details on commands. | +| [Console/Script commands [Extended Edition]](https://github.com/openshwprojects/OpenBK7231T_App/blob/main/docs/commands-extended.md) (226 total) | More details on commands. | diff --git a/docs/commands-extended.md b/docs/commands-extended.md index fbd303554..f892de187 100644 --- a/docs/commands-extended.md +++ b/docs/commands-extended.md @@ -65,6 +65,7 @@ Do not add anything here, as it will overwritten with next rebuild. | HSBColor3 | [Brightness] | Tasmota-style colour access. Sets brightness in 0 to 100 range. | File: cmnds/cmd_newLEDDriver.c
Function: setBrightness | | led_finishFullLerp | | This will force-finish LED color interpolation. You can call it after setting the colour to skip the interpolation/smooth transition time. Of course, it makes only sense if you enabled smooth colour transitions. | File: cmnds/cmd_newLEDDriver.c
Function: led_finishFullLerp | | led_gammaCtrl | sub-cmd [par] | control LED Gamma Correction and Calibration
e.g.:led_gammaCtrl on | File: cmnds/cmd_rgbGamma.c
Function: rgb_gamma_control | +| CTRange | ctRange | | File: cmnds/cmd_newLEDDriver.c
Function: NULL); | | addRepeatingEvent | [IntervalSeconds][RepeatsOr-1][CommandToRun] | Starts a timer/interval command. Use 'backlog' to fit multiple commands in a single string. | File: cmnds/cmd_repeatingEvents.c
Function: RepeatingEvents_Cmd_AddRepeatingEvent | | addRepeatingEventID | [IntervalSeconds][RepeatsOr-1][UserID][CommandToRun] | as addRepeatingEvent, but with a given ID. You can later cancel it with cancelRepeatingEvent.
e.g.:addRepeatingEventID 2 -1 123 Power0 Toggle | File: cmnds/cmd_repeatingEvents.c
Function: RepeatingEvents_Cmd_AddRepeatingEvent | | cancelRepeatingEvent | [UserIDInteger] | Stops a given repeating event with a specified ID | File: cmnds/cmd_repeatingEvents.c
Function: RepeatingEvents_Cmd_CancelRepeatingEvent | diff --git a/docs/commands.md b/docs/commands.md index 896a65d4a..af0b401fc 100644 --- a/docs/commands.md +++ b/docs/commands.md @@ -65,6 +65,7 @@ Do not add anything here, as it will overwritten with next rebuild. | HSBColor3 | [Brightness] | Tasmota-style colour access. Sets brightness in 0 to 100 range. | | led_finishFullLerp | | This will force-finish LED color interpolation. You can call it after setting the colour to skip the interpolation/smooth transition time. Of course, it makes only sense if you enabled smooth colour transitions. | | led_gammaCtrl | sub-cmd [par] | control LED Gamma Correction and Calibration
e.g.:led_gammaCtrl on | +| CTRange | ctRange | | | addRepeatingEvent | [IntervalSeconds][RepeatsOr-1][CommandToRun] | Starts a timer/interval command. Use 'backlog' to fit multiple commands in a single string. | | addRepeatingEventID | [IntervalSeconds][RepeatsOr-1][UserID][CommandToRun] | as addRepeatingEvent, but with a given ID. You can later cancel it with cancelRepeatingEvent.
e.g.:addRepeatingEventID 2 -1 123 Power0 Toggle | | cancelRepeatingEvent | [UserIDInteger] | Stops a given repeating event with a specified ID | diff --git a/docs/json/commands.json b/docs/json/commands.json index 74ba41268..fa2f7f99b 100644 --- a/docs/json/commands.json +++ b/docs/json/commands.json @@ -539,6 +539,15 @@ "requires": "", "examples": "led_gammaCtrl on" }, + { + "name": "CTRange", + "args": "ctRange", + "descr": "", + "fn": "NULL);", + "file": "cmnds/cmd_newLEDDriver.c", + "requires": "", + "examples": "" + }, { "name": "addRepeatingEvent", "args": "[IntervalSeconds][RepeatsOr-1][CommandToRun]", diff --git a/docs/scriptExamples.md b/docs/scriptExamples.md index 60a906422..068bcdb4f 100644 --- a/docs/scriptExamples.md +++ b/docs/scriptExamples.md @@ -3,7 +3,7 @@ Loop demo
Features a 'goto' script command (for use within script) and, obviously, a label. -
Requirements:
+
Requirements: - channel 1 - output relay
```again: @@ -21,7 +21,7 @@ Loop & if demo
This example shows how you can use a dummy channel as a variable to create a loop -
Requirements:
+
Requirements: - channel 1 - output relay
- channel 11 - loop variable counter
@@ -52,7 +52,7 @@ done: Thread cancelation demo and exclude self demo
This example shows how you can create a script thread with an unique ID and use this ID to cancel the thread later -
Requirements:
+
Requirements: - channel 1 - output relay
- pin 8 - button
- pin 9 - button
@@ -105,7 +105,7 @@ label2: Using channel value as a variable demo
-
Requirements:
+
Requirements: - channel 1 - output relay
- channel 11 - you may use it as ADC, or just use setChannel 11 100 or setChannel 11 500 in console to change delay
diff --git a/scripts/getcommands.js b/scripts/getcommands.js index 794780126..039603c12 100644 --- a/scripts/getcommands.js +++ b/scripts/getcommands.js @@ -825,7 +825,7 @@ for (let i = 0; i < scriptExamples.length; i++) { scriptsmdshort += "" + scr.description + ""; scriptsmdshort += '\n'; scriptsmdshort += '
'; - scriptsmdshort += 'Requirements:
'; + scriptsmdshort += 'Requirements:'; scriptsmdshort += '\n'; for (let j = 0; j < scr.requirements.length; j++) { scriptsmdshort += '- ' + scr.requirements[j] + '
'; diff --git a/src/cmnds/cmd_newLEDDriver.c b/src/cmnds/cmd_newLEDDriver.c index 99fb20d3e..ff0447cd7 100644 --- a/src/cmnds/cmd_newLEDDriver.c +++ b/src/cmnds/cmd_newLEDDriver.c @@ -1513,6 +1513,10 @@ void NewLED_InitCommands(){ //cmddetail:"fn":"rgb_gamma_control","file":"cmnds/cmd_rgbGamma.c","requires":"", //cmddetail:"examples":"led_gammaCtrl on"} CMD_RegisterCommand("led_gammaCtrl", led_gamma_control, NULL); + //cmddetail:{"name":"CTRange","args":"ctRange", + //cmddetail:"descr":"", + //cmddetail:"fn":"NULL);","file":"cmnds/cmd_newLEDDriver.c","requires":"", + //cmddetail:"examples":""} CMD_RegisterCommand("CTRange", ctRange, NULL); } diff --git a/src/selftest/selftest_role_toggleAll_2.c b/src/selftest/selftest_role_toggleAll_2.c index 4f9a36edc..bb352a426 100644 --- a/src/selftest/selftest_role_toggleAll_2.c +++ b/src/selftest/selftest_role_toggleAll_2.c @@ -78,7 +78,7 @@ void Test_Role_ToggleAll_2() { } // this check will fail obviously! - SELFTEST_ASSERT_CHANNEL(5, 666); + //SELFTEST_ASSERT_CHANNEL(5, 666); }