diff --git a/docs/commands-extended.md b/docs/commands-extended.md index ef72c5891..a59905a88 100644 --- a/docs/commands-extended.md +++ b/docs/commands-extended.md @@ -262,17 +262,17 @@ Do not add anything here, as it will overwritten with next rebuild. | testMallocFree | | Test malloc and free functionality to see if the device crashes.

See also [testMallocFree on forum](https://www.elektroda.com/rtvforum/find.php?q=testMallocFree). | File: cmnds/cmd_test.c
Function: testMallocFree | | testRealloc | | Test realloc and free functions to see if the device crashes.

See also [testRealloc on forum](https://www.elektroda.com/rtvforum/find.php?q=testRealloc). | File: cmnds/cmd_test.c
Function: testRealloc | | testStrdup | | Test strdup function to see if it allocs news string correctly, also test freeing the string.

See also [testStrdup on forum](https://www.elektroda.com/rtvforum/find.php?q=testStrdup). | File: cmnds/cmd_test.c
Function: testStrdup | -| TimeSize | CMD_TimeSize | .

See also [TimeSize on forum](https://www.elektroda.com/rtvforum/find.php?q=TimeSize). | File: cmnds/cmd_main.c
Function: NULL); | +| TimeSize | | Prints the size of time_t on current platform - sizeof(time_t), only for testing purposes.

See also [TimeSize on forum](https://www.elektroda.com/rtvforum/find.php?q=TimeSize). | File: cmnds/cmd_main.c
Function: NULL); | | TM1650_Test | CMD_TM1650_Test | .

See also [TM1650_Test on forum](https://www.elektroda.com/rtvforum/find.php?q=TM1650_Test). | File: driver/drv_tm1637.c
Function: NULL); | | TMGN_Brightness | [Brigthness0to7][bOn] | This allows you to change brightness and state of TM1637/GN932/etc display.

See also [TMGN_Brightness on forum](https://www.elektroda.com/rtvforum/find.php?q=TMGN_Brightness). | File: driver/drv_tm_gn_display_shared.c
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.

See also [TMGN_Char on forum](https://www.elektroda.com/rtvforum/find.php?q=TMGN_Char). | File: driver/drv_tm1637.c
Function: NULL); | | TMGN_Clear | | This clears the TM1637/GN932/etc display.

See also [TMGN_Clear on forum](https://www.elektroda.com/rtvforum/find.php?q=TMGN_Clear). | File: driver/drv_tm_gn_display_shared.c
Function: NULL); | | TMGN_Map | [Map0][Map1, etc] | This allows you to remap characters order for TM1637/GN932/etc. My TM1637 module from Aliexpress has a strange characters order.

See also [TMGN_Map on forum](https://www.elektroda.com/rtvforum/find.php?q=TMGN_Map). | File: driver/drv_tm_gn_display_shared.c
Function: NULL); | | TMGN_Print | [StartOfs] [MaxLenOr0] [StringText] [optionalBClampWithZeroesForClock] | This allows you to print string on TM1637/GN932/etc display, it supports variables expansion.

See also [TMGN_Print on forum](https://www.elektroda.com/rtvforum/find.php?q=TMGN_Print). | File: driver/drv_tm_gn_display_shared.c
Function: NULL); | -| TMGN_Read | CMD_TMGN_Read | .

See also [TMGN_Read on forum](https://www.elektroda.com/rtvforum/find.php?q=TMGN_Read). | File: driver/drv_tm1637.c
Function: NULL); | +| TMGN_Read | | Executes a single buttons read on TM/GN LED driver.

See also [TMGN_Read on forum](https://www.elektroda.com/rtvforum/find.php?q=TMGN_Read). | File: driver/drv_tm1637.c
Function: NULL); | | TMGN_SetBit | [CharIndex] [BitIndex] [BitValue] | Set given bit of given digit to 1 or 0.

See also [TMGN_SetBit on forum](https://www.elektroda.com/rtvforum/find.php?q=TMGN_SetBit). | File: driver/drv_tm1637.c
Function: NULL); | -| TMGN_SetupButtons | CMD_TMGN_SetupButtons | .

See also [TMGN_SetupButtons on forum](https://www.elektroda.com/rtvforum/find.php?q=TMGN_SetupButtons). | File: driver/drv_tm1637.c
Function: NULL); | -| TMGN_Test | CMD_TMGN_Test | .

See also [TMGN_Test on forum](https://www.elektroda.com/rtvforum/find.php?q=TMGN_Test). | File: driver/drv_tm_gn_display_shared.c
Function: NULL); | +| TMGN_SetupButtons | [Interval] | Setups periodic buttons read on TM/GN LED driver.

See also [TMGN_SetupButtons on forum](https://www.elektroda.com/rtvforum/find.php?q=TMGN_SetupButtons). | File: driver/drv_tm1637.c
Function: NULL); | +| TMGN_Test | | .

See also [TMGN_Test on forum](https://www.elektroda.com/rtvforum/find.php?q=TMGN_Test). | File: driver/drv_tm_gn_display_shared.c
Function: NULL); | | ToggleChannel | [ChannelIndex] | Toggles given channel value. Non-zero becomes zero, zero becomes 1.

See also [ToggleChannel on forum](https://www.elektroda.com/rtvforum/find.php?q=ToggleChannel). | File: cmnds/cmd_channels.c
Function: CMD_ToggleChannel | | toggler_channel | [ChannelIndex] | Handles toggler_channel0, toggler_channel1. Sets channel linked to given toggler slot.

See also [toggler_channel on forum](https://www.elektroda.com/rtvforum/find.php?q=toggler_channel). | File: driver/drv_pwmToggler.c
Function: Toggler_ChannelX | | toggler_enable | [1or0] | Sets the given output ON or OFF. handles toggler_enable0, toggler_enable1, etc.

See also [toggler_enable on forum](https://www.elektroda.com/rtvforum/find.php?q=toggler_enable). | File: driver/drv_pwmToggler.c
Function: Toggler_EnableX | diff --git a/docs/commands.md b/docs/commands.md index 1b8d499e6..54d2825fe 100644 --- a/docs/commands.md +++ b/docs/commands.md @@ -265,17 +265,17 @@ Do not add anything here, as it will overwritten with next rebuild. | testMallocFree | | Test malloc and free functionality to see if the device crashes.

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.

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.

See also [testStrdup on forum](https://www.elektroda.com/rtvforum/find.php?q=testStrdup). | -| TimeSize | CMD_TimeSize | .

See also [TimeSize on forum](https://www.elektroda.com/rtvforum/find.php?q=TimeSize). | +| TimeSize | | Prints the size of time_t on current platform - sizeof(time_t), only for testing purposes.

See also [TimeSize on forum](https://www.elektroda.com/rtvforum/find.php?q=TimeSize). | | TM1650_Test | CMD_TM1650_Test | .

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.

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.

See also [TMGN_Char on forum](https://www.elektroda.com/rtvforum/find.php?q=TMGN_Char). | | TMGN_Clear | | This clears the TM1637/GN932/etc display.

See also [TMGN_Clear on forum](https://www.elektroda.com/rtvforum/find.php?q=TMGN_Clear). | | TMGN_Map | [Map0][Map1, etc] | This allows you to remap characters order for TM1637/GN932/etc. My TM1637 module from Aliexpress has a strange characters order.

See also [TMGN_Map on forum](https://www.elektroda.com/rtvforum/find.php?q=TMGN_Map). | | TMGN_Print | [StartOfs] [MaxLenOr0] [StringText] [optionalBClampWithZeroesForClock] | This allows you to print string on TM1637/GN932/etc display, it supports variables expansion.

See also [TMGN_Print on forum](https://www.elektroda.com/rtvforum/find.php?q=TMGN_Print). | -| TMGN_Read | CMD_TMGN_Read | .

See also [TMGN_Read on forum](https://www.elektroda.com/rtvforum/find.php?q=TMGN_Read). | +| TMGN_Read | | Executes a single buttons read on TM/GN LED driver.

See also [TMGN_Read on forum](https://www.elektroda.com/rtvforum/find.php?q=TMGN_Read). | | TMGN_SetBit | [CharIndex] [BitIndex] [BitValue] | Set given bit of given digit to 1 or 0.

See also [TMGN_SetBit on forum](https://www.elektroda.com/rtvforum/find.php?q=TMGN_SetBit). | -| TMGN_SetupButtons | CMD_TMGN_SetupButtons | .

See also [TMGN_SetupButtons on forum](https://www.elektroda.com/rtvforum/find.php?q=TMGN_SetupButtons). | -| TMGN_Test | CMD_TMGN_Test | .

See also [TMGN_Test on forum](https://www.elektroda.com/rtvforum/find.php?q=TMGN_Test). | +| TMGN_SetupButtons | [Interval] | Setups periodic buttons read on TM/GN LED driver.

See also [TMGN_SetupButtons on forum](https://www.elektroda.com/rtvforum/find.php?q=TMGN_SetupButtons). | +| TMGN_Test | | .

See also [TMGN_Test on forum](https://www.elektroda.com/rtvforum/find.php?q=TMGN_Test). | | ToggleChannel | [ChannelIndex] | Toggles given channel value. Non-zero becomes zero, zero becomes 1.

See also [ToggleChannel on forum](https://www.elektroda.com/rtvforum/find.php?q=ToggleChannel). | | toggler_channel | [ChannelIndex] | Handles toggler_channel0, toggler_channel1. Sets channel linked to given toggler slot.

See also [toggler_channel on forum](https://www.elektroda.com/rtvforum/find.php?q=toggler_channel). | | toggler_enable | [1or0] | Sets the given output ON or OFF. handles toggler_enable0, toggler_enable1, etc.

See also [toggler_enable on forum](https://www.elektroda.com/rtvforum/find.php?q=toggler_enable). | diff --git a/docs/json/commands.json b/docs/json/commands.json index 0b538a582..2d626ccd4 100644 --- a/docs/json/commands.json +++ b/docs/json/commands.json @@ -2314,8 +2314,8 @@ }, { "name": "TimeSize", - "args": "CMD_TimeSize", - "descr": "", + "args": "", + "descr": "Prints the size of time_t on current platform - sizeof(time_t), only for testing purposes.", "fn": "NULL);", "file": "cmnds/cmd_main.c", "requires": "", @@ -2377,8 +2377,8 @@ }, { "name": "TMGN_Read", - "args": "CMD_TMGN_Read", - "descr": "", + "args": "", + "descr": "Executes a single buttons read on TM/GN LED driver", "fn": "NULL);", "file": "driver/drv_tm1637.c", "requires": "", @@ -2395,8 +2395,8 @@ }, { "name": "TMGN_SetupButtons", - "args": "CMD_TMGN_SetupButtons", - "descr": "", + "args": "[Interval]", + "descr": "Setups periodic buttons read on TM/GN LED driver", "fn": "NULL);", "file": "driver/drv_tm1637.c", "requires": "", @@ -2404,7 +2404,7 @@ }, { "name": "TMGN_Test", - "args": "CMD_TMGN_Test", + "args": "", "descr": "", "fn": "NULL);", "file": "driver/drv_tm_gn_display_shared.c", diff --git a/src/driver/drv_tm_gn_display_shared.c b/src/driver/drv_tm_gn_display_shared.c index 41910a836..00c8b7395 100644 --- a/src/driver/drv_tm_gn_display_shared.c +++ b/src/driver/drv_tm_gn_display_shared.c @@ -682,7 +682,7 @@ void TM_GN_Display_SharedInit(tmGnType_t type) { //cmddetail:"fn":"NULL);","file":"driver/drv_tm_gn_display_shared.c","requires":"", //cmddetail:"examples":""} CMD_RegisterCommand("TMGN_Print", CMD_TMGN_Print, NULL); - //cmddetail:{"name":"TMGN_Test","args":"CMD_TMGN_Test", + //cmddetail:{"name":"TMGN_Test","args":"", //cmddetail:"descr":"", //cmddetail:"fn":"NULL);","file":"driver/drv_tm_gn_display_shared.c","requires":"", //cmddetail:"examples":""} @@ -702,13 +702,13 @@ void TM_GN_Display_SharedInit(tmGnType_t type) { //cmddetail:"fn":"NULL);","file":"driver/drv_tm1637.c","requires":"", //cmddetail:"examples":""} CMD_RegisterCommand("TM1650_Test", CMD_TM1650_Test, NULL); - //cmddetail:{"name":"TMGN_Read","args":"CMD_TMGN_Read", - //cmddetail:"descr":"", + //cmddetail:{"name":"TMGN_Read","args":"", + //cmddetail:"descr":"Executes a single buttons read on TM/GN LED driver", //cmddetail:"fn":"NULL);","file":"driver/drv_tm1637.c","requires":"", //cmddetail:"examples":""} CMD_RegisterCommand("TMGN_Read", CMD_TMGN_Read, NULL); - //cmddetail:{"name":"TMGN_SetupButtons","args":"CMD_TMGN_SetupButtons", - //cmddetail:"descr":"", + //cmddetail:{"name":"TMGN_SetupButtons","args":"[Interval]", + //cmddetail:"descr":"Setups periodic buttons read on TM/GN LED driver", //cmddetail:"fn":"NULL);","file":"driver/drv_tm1637.c","requires":"", //cmddetail:"examples":""} CMD_RegisterCommand("TMGN_SetupButtons", CMD_TMGN_SetupButtons, NULL);