diff --git a/package.json b/package.json index cfc78c6bd..1a027178c 100644 --- a/package.json +++ b/package.json @@ -4,7 +4,8 @@ "description": "Gulp based script content builder", "main": "gulpfile.js", "scripts": { - "test": "echo \"Error: no test specified\" && exit 1" + "test": "echo \"Error: no test specified\" && exit 1", + "getcommands": "node scripts/getcommands.js" }, "repository": { "type": "git", diff --git a/scripts/getcommands.js b/scripts/getcommands.js new file mode 100644 index 000000000..72012f81f --- /dev/null +++ b/scripts/getcommands.js @@ -0,0 +1,186 @@ +let fs = require('fs'); + +let commands = []; +let cmdindex = {}; + +let inFile = 0; + +function mytrim(text){ + text = text.trim(); + if (text.startsWith('"')) text = text.slice(1, -1); + return text; +} + + +function getFolder(name, cb){ + //console.log('dir:'+name); + + let list = fs.readdirSync(name); + for (let i = 0; i < list.length; i++){ + let file = name + '/' + list[i]; + let s = fs.statSync(file); + + if (s.isDirectory()){ + getFolder(file, cb); + } else { + if (file.toLowerCase().endsWith('.c') || + file.toLowerCase().endsWith('.cpp')){ + inFile++; + //console.log('file:'+file); + let data = fs.readFileSync(file); + let text = data.toString('utf-8'); + let lines = text.split('\n'); + let newlines = []; + let modified = 0; + for (let i = 0; i < lines.length; i++){ + let line = lines[i].trim(); + // like CMD_RegisterCommand("SetChannel", "", CMD_SetChannel, "qqqqq0", NULL); + if (line.startsWith('//cmddetail:')){ + let commentlines = []; + let j; + for (j = i; j < lines.length; j++){ + let l = lines[j].trim(); + if (l.startsWith('//cmddetail:')){ + l = l.slice(12); + commentlines.push(l); + newlines.push(lines[j]); + } else { + break; + } + } + // move our parsing forward to skip all found + i = j; + let json = commentlines.join('\n'); + try{ + let cmd = JSON.parse(json); + if (cmdindex[cmd.name]){ + console.error('duplicate command docs at file: '+file+' line: '+line); + console.error(line); + } else { + commands.push(cmd); + cmdindex[cmd.name] = cmd; + } + } catch(e) { + console.error('error in json at file: '+file+' line: '+line); + console.error(json); + } + } + + // i may have changed... + line = lines[i].trim(); + + if (line.startsWith('CMD_RegisterCommand(')){ + line = line.slice('CMD_RegisterCommand('.length); + parts = line.split(','); + //cmddetail:{"name":"SetChannel", "args":"TODO", "fn":"CMD_SetChannel", "descr":"qqqqq0", "example":"", "file":""); + + let cmd = { + name: mytrim(parts[0]), + args: mytrim(parts[1]), + descr: mytrim(parts[3]), + fn: mytrim(parts[2]), + file: file.slice(6), + requires:"", + examples: "", + }; + + if (cmd.descr !== 'NULL'){ + console.log('replace "'+cmd.descr+'" with NULL'); + lines[i] = lines[i].replace('"'+cmd.descr+'"', 'NULL'); + modified++; + } + + if (!cmdindex[cmd.name]){ + // it did not have a doc line before + let json = JSON.stringify(cmd); + // insert CR at "fn": + json = json.split('"descr":'); + json = json.join('\n"descr":'); + json = json.split('"fn":'); + json = json.join('\n"fn":'); + json = json.split('"examples":'); + json = json.join('\n"examples":'); + let jsonlines = json.split('\n'); + for (let j = 0; j < jsonlines.length; j++){ + jsonlines[j] = '\t//cmddetail:'+jsonlines[j]; + } + newlines.push(... jsonlines); + modified++; + commands.push(cmd); + cmdindex[cmd.name] = cmd; + } + } + + newlines.push(lines[i]); + } + if (modified){ + let newdata = newlines.join('\n'); + try{ + fs.writeFileSync(file, newdata); + console.log('updated '+file); + } catch (e){ + console.error('failed to update '+file); + } + } + + inFile--; + + if (!inFile){ + //if (cb) cb(); + } + } + } + } +} + + +console.log('starting'); + +getFolder('./src'); + + +let mdshort = +`# Commands + +| Command | Arguments | Description | +|:------------- |:------------- | -----:| +`; + +let mdlong = +`# Commands + +| Command | Arguments | Description | Loc | +|:------------- |:-------------:|:----- | ------:| +`; + +for (let i = 0; i < commands.length; i++){ + + /* like: + | Command | Arguments | Description | + | ------------- |:-------------:| -----:| + | 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. | + | addChannel | [ChannelIndex][ValueToAdd][ClampMin][ClampMax] | Ads a given value to the channel. Can be used to change PWM brightness. Clamp min and max arguments are optional. | + */ + let cmd = commands[i]; + + let textshort = `| ${cmd.name} | ${cmd.args}${cmd.requires?'\nReq:'+cmd.requires:''} | ${cmd.descr}${cmd.examples?'\ne.g.:'+cmd.examples:''} |`; + let textlong = `| ${cmd.name} | ${cmd.args}${cmd.requires?'\nReq:'+cmd.requires:''} | ${cmd.descr}${cmd.examples?'\ne.g.:'+cmd.examples:''} | ${cmd.file}\n${cmd.fn} |`; + + // allow multi-row entries in table entries. + textshort = textshort.replace(/\n/g, '
'); + textlong = textlong.replace(/\n/g, '
'); + + mdshort += textshort; + mdshort += '\n'; + mdlong += textlong; + mdlong += '\n'; +} + +mdshort += '\n'; +mdlong += '\n'; + +fs.writeFileSync('docs/commands.md', mdshort); +console.log('wrote commands.md'); +fs.writeFileSync('docs/commands-extended.md', mdlong); +console.log('wrote commands-extended.md'); + diff --git a/src/cmnds/cmd_channels.c b/src/cmnds/cmd_channels.c index ee5c4bf30..2844fc7d6 100644 --- a/src/cmnds/cmd_channels.c +++ b/src/cmnds/cmd_channels.c @@ -200,14 +200,50 @@ static int CMD_ShortName(const void *context, const char *cmd, const char *args, return 1; } void CMD_InitChannelCommands(){ - CMD_RegisterCommand("SetChannel", "", CMD_SetChannel, "qqqqq0", NULL); - CMD_RegisterCommand("ToggleChannel", "", CMD_ToggleChannel, "qqqqq0", NULL); - CMD_RegisterCommand("AddChannel", "", CMD_AddChannel, "qqqqq0", NULL); - CMD_RegisterCommand("ClampChannel", "", CMD_ClampChannel, "qqqqq0", NULL); - CMD_RegisterCommand("SetPinRole", "", CMD_SetPinRole, "qqqqq0", NULL); - CMD_RegisterCommand("SetPinChannel", "", CMD_SetPinChannel, "qqqqq0", NULL); - CMD_RegisterCommand("GetChannel", "", CMD_GetChannel, "qqqqq0", NULL); - CMD_RegisterCommand("GetReadings", "", CMD_GetReadings, "qqqqq0", NULL); - CMD_RegisterCommand("ShortName", "", CMD_ShortName, "qqqqq0", NULL); + //cmddetail:{"name":"SetChannel","args":"", + //cmddetail:"descr":"qqqqq0", + //cmddetail:"fn":"CMD_SetChannel","file":"cmnds/cmd_channels.c","requires":"", + //cmddetail:"examples":""} + CMD_RegisterCommand("SetChannel", "", CMD_SetChannel, NULL, NULL); + //cmddetail:{"name":"ToggleChannel","args":"", + //cmddetail:"descr":"qqqqq0", + //cmddetail:"fn":"CMD_ToggleChannel","file":"cmnds/cmd_channels.c","requires":"", + //cmddetail:"examples":""} + CMD_RegisterCommand("ToggleChannel", "", CMD_ToggleChannel, NULL, NULL); + //cmddetail:{"name":"AddChannel","args":"", + //cmddetail:"descr":"qqqqq0", + //cmddetail:"fn":"CMD_AddChannel","file":"cmnds/cmd_channels.c","requires":"", + //cmddetail:"examples":""} + CMD_RegisterCommand("AddChannel", "", CMD_AddChannel, NULL, NULL); + //cmddetail:{"name":"ClampChannel","args":"", + //cmddetail:"descr":"qqqqq0", + //cmddetail:"fn":"CMD_ClampChannel","file":"cmnds/cmd_channels.c","requires":"", + //cmddetail:"examples":""} + CMD_RegisterCommand("ClampChannel", "", CMD_ClampChannel, NULL, NULL); + //cmddetail:{"name":"SetPinRole","args":"", + //cmddetail:"descr":"qqqqq0", + //cmddetail:"fn":"CMD_SetPinRole","file":"cmnds/cmd_channels.c","requires":"", + //cmddetail:"examples":""} + CMD_RegisterCommand("SetPinRole", "", CMD_SetPinRole, NULL, NULL); + //cmddetail:{"name":"SetPinChannel","args":"", + //cmddetail:"descr":"qqqqq0", + //cmddetail:"fn":"CMD_SetPinChannel","file":"cmnds/cmd_channels.c","requires":"", + //cmddetail:"examples":""} + CMD_RegisterCommand("SetPinChannel", "", CMD_SetPinChannel, NULL, NULL); + //cmddetail:{"name":"GetChannel","args":"", + //cmddetail:"descr":"qqqqq0", + //cmddetail:"fn":"CMD_GetChannel","file":"cmnds/cmd_channels.c","requires":"", + //cmddetail:"examples":""} + CMD_RegisterCommand("GetChannel", "", CMD_GetChannel, NULL, NULL); + //cmddetail:{"name":"GetReadings","args":"", + //cmddetail:"descr":"qqqqq0", + //cmddetail:"fn":"CMD_GetReadings","file":"cmnds/cmd_channels.c","requires":"", + //cmddetail:"examples":""} + CMD_RegisterCommand("GetReadings", "", CMD_GetReadings, NULL, NULL); + //cmddetail:{"name":"ShortName","args":"", + //cmddetail:"descr":"qqqqq0", + //cmddetail:"fn":"CMD_ShortName","file":"cmnds/cmd_channels.c","requires":"", + //cmddetail:"examples":""} + CMD_RegisterCommand("ShortName", "", CMD_ShortName, NULL, NULL); } diff --git a/src/cmnds/cmd_eventHandlers.c b/src/cmnds/cmd_eventHandlers.c index b67d18297..629bc26c3 100644 --- a/src/cmnds/cmd_eventHandlers.c +++ b/src/cmnds/cmd_eventHandlers.c @@ -477,10 +477,26 @@ static int CMD_ListEvents(const void *context, const char *cmd, const char *args } void EventHandlers_Init() { - CMD_RegisterCommand("AddEventHandler", "", CMD_AddEventHandler, "qqqqq0", NULL); - CMD_RegisterCommand("AddChangeHandler", "", CMD_AddChangeHandler, "qqqqq0", NULL); - CMD_RegisterCommand("listEvents", "", CMD_ListEvents, "qqqqq0", NULL); - CMD_RegisterCommand("clearAllHandlers", "", CMD_ClearAllHandlers, "qqqqq0", NULL); + //cmddetail:{"name":"AddEventHandler","args":"", + //cmddetail:"descr":"qqqqq0", + //cmddetail:"fn":"CMD_AddEventHandler","file":"cmnds/cmd_eventHandlers.c","requires":"", + //cmddetail:"examples":""} + CMD_RegisterCommand("AddEventHandler", "", CMD_AddEventHandler, NULL, NULL); + //cmddetail:{"name":"AddChangeHandler","args":"", + //cmddetail:"descr":"qqqqq0", + //cmddetail:"fn":"CMD_AddChangeHandler","file":"cmnds/cmd_eventHandlers.c","requires":"", + //cmddetail:"examples":""} + CMD_RegisterCommand("AddChangeHandler", "", CMD_AddChangeHandler, NULL, NULL); + //cmddetail:{"name":"listEvents","args":"", + //cmddetail:"descr":"qqqqq0", + //cmddetail:"fn":"CMD_ListEvents","file":"cmnds/cmd_eventHandlers.c","requires":"", + //cmddetail:"examples":""} + CMD_RegisterCommand("listEvents", "", CMD_ListEvents, NULL, NULL); + //cmddetail:{"name":"clearAllHandlers","args":"", + //cmddetail:"descr":"qqqqq0", + //cmddetail:"fn":"CMD_ClearAllHandlers","file":"cmnds/cmd_eventHandlers.c","requires":"", + //cmddetail:"examples":""} + CMD_RegisterCommand("clearAllHandlers", "", CMD_ClearAllHandlers, NULL, NULL); } diff --git a/src/cmnds/cmd_main.c b/src/cmnds/cmd_main.c index 74186348c..904396958 100644 --- a/src/cmnds/cmd_main.c +++ b/src/cmnds/cmd_main.c @@ -90,12 +90,36 @@ static int CMD_Echo(const void *context, const char *cmd, const char *args, int void CMD_Init() { - CMD_RegisterCommand("echo", "", CMD_Echo, "qqqe", NULL); - CMD_RegisterCommand("restart", "", CMD_Restart, "Reboots the module", NULL); - CMD_RegisterCommand("clearConfig", "", CMD_ClearConfig, "Clears all config", NULL); - CMD_RegisterCommand("clearAll", "", CMD_ClearAll, "Clears all things", NULL); - CMD_RegisterCommand("simonirtest", "", CMD_SimonTest, "Simons Special Test", NULL); - CMD_RegisterCommand("if", "", CMD_If, "", NULL); + //cmddetail:{"name":"echo","args":"", + //cmddetail:"descr":"qqqe", + //cmddetail:"fn":"CMD_Echo","file":"cmnds/cmd_main.c","requires":"", + //cmddetail:"examples":""} + CMD_RegisterCommand("echo", "", CMD_Echo, NULL, NULL); + //cmddetail:{"name":"restart","args":"", + //cmddetail:"descr":"Reboots the module", + //cmddetail:"fn":"CMD_Restart","file":"cmnds/cmd_main.c","requires":"", + //cmddetail:"examples":""} + CMD_RegisterCommand("restart", "", CMD_Restart, NULL, NULL); + //cmddetail:{"name":"clearConfig","args":"", + //cmddetail:"descr":"Clears all config", + //cmddetail:"fn":"CMD_ClearConfig","file":"cmnds/cmd_main.c","requires":"", + //cmddetail:"examples":""} + CMD_RegisterCommand("clearConfig", "", CMD_ClearConfig, NULL, NULL); + //cmddetail:{"name":"clearAll","args":"", + //cmddetail:"descr":"Clears all things", + //cmddetail:"fn":"CMD_ClearAll","file":"cmnds/cmd_main.c","requires":"", + //cmddetail:"examples":""} + CMD_RegisterCommand("clearAll", "", CMD_ClearAll, NULL, NULL); + //cmddetail:{"name":"simonirtest","args":"", + //cmddetail:"descr":"Simons Special Test", + //cmddetail:"fn":"CMD_SimonTest","file":"cmnds/cmd_main.c","requires":"", + //cmddetail:"examples":""} + CMD_RegisterCommand("simonirtest", "", CMD_SimonTest, NULL, NULL); + //cmddetail:{"name":"if","args":"", + //cmddetail:"descr":"", + //cmddetail:"fn":"CMD_If","file":"cmnds/cmd_main.c","requires":"", + //cmddetail:"examples":""} + CMD_RegisterCommand("if", NULL, CMD_If, NULL, NULL); if(CFG_HasFlag(OBK_FLAG_CMD_ENABLETCPRAWPUTTYSERVER)) { CMD_StartTCPCommandLine(); } diff --git a/src/cmnds/cmd_newLEDDriver.c b/src/cmnds/cmd_newLEDDriver.c index 35990a3ab..029fdee1a 100644 --- a/src/cmnds/cmd_newLEDDriver.c +++ b/src/cmnds/cmd_newLEDDriver.c @@ -878,18 +878,66 @@ void NewLED_InitCommands(){ // set, but do not apply (force a refresh) LED_SetTemperature(led_temperature_current,0); - CMD_RegisterCommand("led_dimmer", "", dimmer, "set output dimmer 0..100", NULL); - CMD_RegisterCommand("add_dimmer", "", add_dimmer, "set output dimmer 0..100", NULL); - CMD_RegisterCommand("led_enableAll", "", enableAll, "qqqq", NULL); - CMD_RegisterCommand("led_basecolor_rgb", "", basecolor_rgb, "set PWN color using #RRGGBB", NULL); - CMD_RegisterCommand("led_basecolor_rgbcw", "", basecolor_rgbcw, "set PWN color using #RRGGBB[cw][ww]", NULL); - CMD_RegisterCommand("led_temperature", "", temperature, "set qqqq", NULL); - CMD_RegisterCommand("led_brightnessMult", "", brightnessMult, "set qqqq", NULL); - CMD_RegisterCommand("led_colorMult", "", colorMult, "set qqqq", NULL); - CMD_RegisterCommand("led_saturation", "", setSaturation, "set qqqq", NULL); - CMD_RegisterCommand("led_hue", "", setHue, "set qqqq", NULL); - CMD_RegisterCommand("led_nextColor", "", nextColor, "set qqqq", NULL); - CMD_RegisterCommand("led_lerpSpeed", "", lerpSpeed, "set qqqq", NULL); + //cmddetail:{"name":"led_dimmer","args":"", + //cmddetail:"descr":"set output dimmer 0..100", + //cmddetail:"fn":"dimmer","file":"cmnds/cmd_newLEDDriver.c","requires":"", + //cmddetail:"examples":""} + CMD_RegisterCommand("led_dimmer", "", dimmer, NULL, NULL); + //cmddetail:{"name":"add_dimmer","args":"", + //cmddetail:"descr":"set output dimmer 0..100", + //cmddetail:"fn":"add_dimmer","file":"cmnds/cmd_newLEDDriver.c","requires":"", + //cmddetail:"examples":""} + CMD_RegisterCommand("add_dimmer", "", add_dimmer, NULL, NULL); + //cmddetail:{"name":"led_enableAll","args":"", + //cmddetail:"descr":"qqqq", + //cmddetail:"fn":"enableAll","file":"cmnds/cmd_newLEDDriver.c","requires":"", + //cmddetail:"examples":""} + CMD_RegisterCommand("led_enableAll", "", enableAll, NULL, NULL); + //cmddetail:{"name":"led_basecolor_rgb","args":"", + //cmddetail:"descr":"set PWN color using #RRGGBB", + //cmddetail:"fn":"basecolor_rgb","file":"cmnds/cmd_newLEDDriver.c","requires":"", + //cmddetail:"examples":""} + CMD_RegisterCommand("led_basecolor_rgb", "", basecolor_rgb, NULL, NULL); + //cmddetail:{"name":"led_basecolor_rgbcw","args":"", + //cmddetail:"descr":"set PWN color using #RRGGBB[cw][ww]", + //cmddetail:"fn":"basecolor_rgbcw","file":"cmnds/cmd_newLEDDriver.c","requires":"", + //cmddetail:"examples":""} + CMD_RegisterCommand("led_basecolor_rgbcw", "", basecolor_rgbcw, NULL, NULL); + //cmddetail:{"name":"led_temperature","args":"", + //cmddetail:"descr":"set qqqq", + //cmddetail:"fn":"temperature","file":"cmnds/cmd_newLEDDriver.c","requires":"", + //cmddetail:"examples":""} + CMD_RegisterCommand("led_temperature", "", temperature, NULL, NULL); + //cmddetail:{"name":"led_brightnessMult","args":"", + //cmddetail:"descr":"set qqqq", + //cmddetail:"fn":"brightnessMult","file":"cmnds/cmd_newLEDDriver.c","requires":"", + //cmddetail:"examples":""} + CMD_RegisterCommand("led_brightnessMult", "", brightnessMult, NULL, NULL); + //cmddetail:{"name":"led_colorMult","args":"", + //cmddetail:"descr":"set qqqq", + //cmddetail:"fn":"colorMult","file":"cmnds/cmd_newLEDDriver.c","requires":"", + //cmddetail:"examples":""} + CMD_RegisterCommand("led_colorMult", "", colorMult, NULL, NULL); + //cmddetail:{"name":"led_saturation","args":"", + //cmddetail:"descr":"set qqqq", + //cmddetail:"fn":"setSaturation","file":"cmnds/cmd_newLEDDriver.c","requires":"", + //cmddetail:"examples":""} + CMD_RegisterCommand("led_saturation", "", setSaturation, NULL, NULL); + //cmddetail:{"name":"led_hue","args":"", + //cmddetail:"descr":"set qqqq", + //cmddetail:"fn":"setHue","file":"cmnds/cmd_newLEDDriver.c","requires":"", + //cmddetail:"examples":""} + CMD_RegisterCommand("led_hue", "", setHue, NULL, NULL); + //cmddetail:{"name":"led_nextColor","args":"", + //cmddetail:"descr":"set qqqq", + //cmddetail:"fn":"nextColor","file":"cmnds/cmd_newLEDDriver.c","requires":"", + //cmddetail:"examples":""} + CMD_RegisterCommand("led_nextColor", "", nextColor, NULL, NULL); + //cmddetail:{"name":"led_lerpSpeed","args":"", + //cmddetail:"descr":"set qqqq", + //cmddetail:"fn":"lerpSpeed","file":"cmnds/cmd_newLEDDriver.c","requires":"", + //cmddetail:"examples":""} + CMD_RegisterCommand("led_lerpSpeed", "", lerpSpeed, NULL, NULL); } diff --git a/src/cmnds/cmd_repeatingEvents.c b/src/cmnds/cmd_repeatingEvents.c index f6745e3b1..3e060eb76 100644 --- a/src/cmnds/cmd_repeatingEvents.c +++ b/src/cmnds/cmd_repeatingEvents.c @@ -160,12 +160,24 @@ int RepeatingEvents_Cmd_CancelRepeatingEvent(const void *context, const char *cm void RepeatingEvents_Init() { // addRepeatingEvent [DelaySeconds] [Repeats] [Command With Spaces Allowed] // addRepeatingEvent 5 -1 Power0 Toggle - CMD_RegisterCommand("addRepeatingEvent","",RepeatingEvents_Cmd_AddRepeatingEvent, "qqqq", NULL); + //cmddetail:{"name":"addRepeatingEvent","args":"", + //cmddetail:"descr":"qqqq", + //cmddetail:"fn":"RepeatingEvents_Cmd_AddRepeatingEvent","file":"cmnds/cmd_repeatingEvents.c","requires":"", + //cmddetail:"examples":""} + CMD_RegisterCommand("addRepeatingEvent","",RepeatingEvents_Cmd_AddRepeatingEvent, NULL, NULL); // addRepeatingEventID [DelaySeconds] [Repeats] [UserIDInteger] [Command With Spaces Allowed] // addRepeatingEventID 2 -1 123 Power0 Toggle - CMD_RegisterCommand("addRepeatingEventID","",RepeatingEvents_Cmd_AddRepeatingEvent, "qqqq", NULL); + //cmddetail:{"name":"addRepeatingEventID","args":"", + //cmddetail:"descr":"qqqq", + //cmddetail:"fn":"RepeatingEvents_Cmd_AddRepeatingEvent","file":"cmnds/cmd_repeatingEvents.c","requires":"", + //cmddetail:"examples":""} + CMD_RegisterCommand("addRepeatingEventID","",RepeatingEvents_Cmd_AddRepeatingEvent, NULL, NULL); // cancelRepeatingEvent [UserIDInteger] - CMD_RegisterCommand("cancelRepeatingEvent","",RepeatingEvents_Cmd_CancelRepeatingEvent, "qqqq", NULL); + //cmddetail:{"name":"cancelRepeatingEvent","args":"", + //cmddetail:"descr":"qqqq", + //cmddetail:"fn":"RepeatingEvents_Cmd_CancelRepeatingEvent","file":"cmnds/cmd_repeatingEvents.c","requires":"", + //cmddetail:"examples":""} + CMD_RegisterCommand("cancelRepeatingEvent","",RepeatingEvents_Cmd_CancelRepeatingEvent, NULL, NULL); } diff --git a/src/cmnds/cmd_script.c b/src/cmnds/cmd_script.c index a4fd544dc..87bdeefdb 100644 --- a/src/cmnds/cmd_script.c +++ b/src/cmnds/cmd_script.c @@ -740,15 +740,51 @@ static int CMD_resetSVM(const void *context, const char *cmd, const char *args, return 1; } void CMD_InitScripting(){ - CMD_RegisterCommand("startScript", "", CMD_StartScript, "qqqqq0", NULL); - CMD_RegisterCommand("stopScript", "", CMD_StopScript, "qqqqq0", NULL); - CMD_RegisterCommand("stopAllScripts", "", CMD_StopAllScripts, "qqqqq0", NULL); - CMD_RegisterCommand("listScripts", "", CMD_ListScripts, "qqqqq0", NULL); - CMD_RegisterCommand("goto", "", CMD_GoTo, "qqqqq0", NULL); - CMD_RegisterCommand("delay_s", "", CMD_Delay_s, "qqqqq0", NULL); - CMD_RegisterCommand("delay_ms", "", CMD_Delay_ms, "qqqqq0", NULL); - CMD_RegisterCommand("return", "", CMD_Return, "qqqqq0", NULL); - CMD_RegisterCommand("resetSVM", "", CMD_resetSVM, "qqqqq0", NULL); + //cmddetail:{"name":"startScript","args":"", + //cmddetail:"descr":"qqqqq0", + //cmddetail:"fn":"CMD_StartScript","file":"cmnds/cmd_script.c","requires":"", + //cmddetail:"examples":""} + CMD_RegisterCommand("startScript", "", CMD_StartScript, NULL, NULL); + //cmddetail:{"name":"stopScript","args":"", + //cmddetail:"descr":"qqqqq0", + //cmddetail:"fn":"CMD_StopScript","file":"cmnds/cmd_script.c","requires":"", + //cmddetail:"examples":""} + CMD_RegisterCommand("stopScript", "", CMD_StopScript, NULL, NULL); + //cmddetail:{"name":"stopAllScripts","args":"", + //cmddetail:"descr":"qqqqq0", + //cmddetail:"fn":"CMD_StopAllScripts","file":"cmnds/cmd_script.c","requires":"", + //cmddetail:"examples":""} + CMD_RegisterCommand("stopAllScripts", "", CMD_StopAllScripts, NULL, NULL); + //cmddetail:{"name":"listScripts","args":"", + //cmddetail:"descr":"qqqqq0", + //cmddetail:"fn":"CMD_ListScripts","file":"cmnds/cmd_script.c","requires":"", + //cmddetail:"examples":""} + CMD_RegisterCommand("listScripts", "", CMD_ListScripts, NULL, NULL); + //cmddetail:{"name":"goto","args":"", + //cmddetail:"descr":"qqqqq0", + //cmddetail:"fn":"CMD_GoTo","file":"cmnds/cmd_script.c","requires":"", + //cmddetail:"examples":""} + CMD_RegisterCommand("goto", "", CMD_GoTo, NULL, NULL); + //cmddetail:{"name":"delay_s","args":"", + //cmddetail:"descr":"qqqqq0", + //cmddetail:"fn":"CMD_Delay_s","file":"cmnds/cmd_script.c","requires":"", + //cmddetail:"examples":""} + CMD_RegisterCommand("delay_s", "", CMD_Delay_s, NULL, NULL); + //cmddetail:{"name":"delay_ms","args":"", + //cmddetail:"descr":"qqqqq0", + //cmddetail:"fn":"CMD_Delay_ms","file":"cmnds/cmd_script.c","requires":"", + //cmddetail:"examples":""} + CMD_RegisterCommand("delay_ms", "", CMD_Delay_ms, NULL, NULL); + //cmddetail:{"name":"return","args":"", + //cmddetail:"descr":"qqqqq0", + //cmddetail:"fn":"CMD_Return","file":"cmnds/cmd_script.c","requires":"", + //cmddetail:"examples":""} + CMD_RegisterCommand("return", "", CMD_Return, NULL, NULL); + //cmddetail:{"name":"resetSVM","args":"", + //cmddetail:"descr":"qqqqq0", + //cmddetail:"fn":"CMD_resetSVM","file":"cmnds/cmd_script.c","requires":"", + //cmddetail:"examples":""} + CMD_RegisterCommand("resetSVM", "", CMD_resetSVM, NULL, NULL); } diff --git a/src/cmnds/cmd_send.c b/src/cmnds/cmd_send.c index c0b756ec6..24f195f66 100644 --- a/src/cmnds/cmd_send.c +++ b/src/cmnds/cmd_send.c @@ -21,7 +21,11 @@ static int CMD_SendGET(const void *context, const char *cmd, const char *args, i int CMD_InitSendCommands(){ - CMD_RegisterCommand("sendGet", "", CMD_SendGET, "qq", NULL); + //cmddetail:{"name":"sendGet","args":"", + //cmddetail:"descr":"qq", + //cmddetail:"fn":"CMD_SendGET","file":"cmnds/cmd_send.c","requires":"", + //cmddetail:"examples":""} + CMD_RegisterCommand("sendGet", "", CMD_SendGET, NULL, NULL); return 0; } diff --git a/src/cmnds/cmd_tasmota.c b/src/cmnds/cmd_tasmota.c index c447b37c5..3d83619f1 100644 --- a/src/cmnds/cmd_tasmota.c +++ b/src/cmnds/cmd_tasmota.c @@ -408,14 +408,50 @@ static int cmnd_lfs_test3(const void * context, const char *cmd, const char *arg return 1; } int taslike_commands_init(){ - CMD_RegisterCommand("power", "", power, "set output POWERn 0..100", NULL); - CMD_RegisterCommand("powerStateOnly", "", powerStateOnly, "ensures that device is on or off without changing pwm values", NULL); - CMD_RegisterCommand("powerAll", "", powerAll, "set all outputs", NULL); - CMD_RegisterCommand("color", "", color, "set PWN color using #RRGGBB[cw][ww]", NULL); - CMD_RegisterCommand("backlog", "", cmnd_backlog, "run a sequence of ; separated commands", NULL); - CMD_RegisterCommand("exec", "", cmnd_lfsexec, "exec - run autoexec.bat or other file from LFS if present", NULL); - CMD_RegisterCommand("lfs_test1", "", cmnd_lfs_test1, "", NULL); - CMD_RegisterCommand("lfs_test2", "", cmnd_lfs_test2, "", NULL); - CMD_RegisterCommand("lfs_test3", "", cmnd_lfs_test3, "", NULL); + //cmddetail:{"name":"power","args":"", + //cmddetail:"descr":"set output POWERn 0..100", + //cmddetail:"fn":"power","file":"cmnds/cmd_tasmota.c","requires":"", + //cmddetail:"examples":""} + CMD_RegisterCommand("power", "", power, NULL, NULL); + //cmddetail:{"name":"powerStateOnly","args":"", + //cmddetail:"descr":"ensures that device is on or off without changing pwm values", + //cmddetail:"fn":"powerStateOnly","file":"cmnds/cmd_tasmota.c","requires":"", + //cmddetail:"examples":""} + CMD_RegisterCommand("powerStateOnly", "", powerStateOnly, NULL, NULL); + //cmddetail:{"name":"powerAll","args":"", + //cmddetail:"descr":"set all outputs", + //cmddetail:"fn":"powerAll","file":"cmnds/cmd_tasmota.c","requires":"", + //cmddetail:"examples":""} + CMD_RegisterCommand("powerAll", "", powerAll, NULL, NULL); + //cmddetail:{"name":"color","args":"", + //cmddetail:"descr":"set PWN color using #RRGGBB[cw][ww]", + //cmddetail:"fn":"color","file":"cmnds/cmd_tasmota.c","requires":"", + //cmddetail:"examples":""} + CMD_RegisterCommand("color", "", color, NULL, NULL); + //cmddetail:{"name":"backlog","args":"", + //cmddetail:"descr":"run a sequence of ; separated commands", + //cmddetail:"fn":"cmnd_backlog","file":"cmnds/cmd_tasmota.c","requires":"", + //cmddetail:"examples":""} + CMD_RegisterCommand("backlog", "", cmnd_backlog, NULL, NULL); + //cmddetail:{"name":"exec","args":"", + //cmddetail:"descr":"exec - run autoexec.bat or other file from LFS if present", + //cmddetail:"fn":"cmnd_lfsexec","file":"cmnds/cmd_tasmota.c","requires":"", + //cmddetail:"examples":""} + CMD_RegisterCommand("exec", "", cmnd_lfsexec, NULL, NULL); + //cmddetail:{"name":"lfs_test1","args":"", + //cmddetail:"descr":"", + //cmddetail:"fn":"cmnd_lfs_test1","file":"cmnds/cmd_tasmota.c","requires":"", + //cmddetail:"examples":""} + CMD_RegisterCommand("lfs_test1", NULL, cmnd_lfs_test1, NULL, NULL); + //cmddetail:{"name":"lfs_test2","args":"", + //cmddetail:"descr":"", + //cmddetail:"fn":"cmnd_lfs_test2","file":"cmnds/cmd_tasmota.c","requires":"", + //cmddetail:"examples":""} + CMD_RegisterCommand("lfs_test2", NULL, cmnd_lfs_test2, NULL, NULL); + //cmddetail:{"name":"lfs_test3","args":"", + //cmddetail:"descr":"", + //cmddetail:"fn":"cmnd_lfs_test3","file":"cmnds/cmd_tasmota.c","requires":"", + //cmddetail:"examples":""} + CMD_RegisterCommand("lfs_test3", NULL, cmnd_lfs_test3, NULL, NULL); return 0; } diff --git a/src/cmnds/cmd_test.c b/src/cmnds/cmd_test.c index 0321b07e3..1f4dd9061 100644 --- a/src/cmnds/cmd_test.c +++ b/src/cmnds/cmd_test.c @@ -57,7 +57,11 @@ static int alias(const void * context, const char *cmd, const char *args, int cm ADDLOG_INFO(LOG_FEATURE_CMD, "New alias has been set: %s runs %s", alias, ocmd); - CMD_RegisterCommand(aliasMem, "", runcmd, "custom", cmdMem); + //cmddetail:{"name":"aliasMem","args":"", + //cmddetail:"descr":"custom", + //cmddetail:"fn":"runcmd","file":"cmnds/cmd_test.c","requires":"", + //cmddetail:"examples":""} + CMD_RegisterCommand(aliasMem, "", runcmd, NULL, cmdMem); return 1; } @@ -236,15 +240,47 @@ static int testJSON(const void * context, const char *cmd, const char *args, int return 0; } int fortest_commands_init(){ - CMD_RegisterCommand("alias", "", alias, "add a custom command", NULL); - CMD_RegisterCommand("testMallocFree", "", testMallocFree, "", NULL); - CMD_RegisterCommand("testRealloc", "", testRealloc, "", NULL); - CMD_RegisterCommand("testJSON", "", testJSON, "", NULL); - CMD_RegisterCommand("testLog", "", testLog, "", NULL); - CMD_RegisterCommand("testFloats", "", testFloats, "", NULL); + //cmddetail:{"name":"alias","args":"", + //cmddetail:"descr":"add a custom command", + //cmddetail:"fn":"alias","file":"cmnds/cmd_test.c","requires":"", + //cmddetail:"examples":""} + CMD_RegisterCommand("alias", "", alias, NULL, NULL); + //cmddetail:{"name":"testMallocFree","args":"", + //cmddetail:"descr":"", + //cmddetail:"fn":"testMallocFree","file":"cmnds/cmd_test.c","requires":"", + //cmddetail:"examples":""} + CMD_RegisterCommand("testMallocFree", NULL, testMallocFree, NULL, NULL); + //cmddetail:{"name":"testRealloc","args":"", + //cmddetail:"descr":"", + //cmddetail:"fn":"testRealloc","file":"cmnds/cmd_test.c","requires":"", + //cmddetail:"examples":""} + CMD_RegisterCommand("testRealloc", NULL, testRealloc, NULL, NULL); + //cmddetail:{"name":"testJSON","args":"", + //cmddetail:"descr":"", + //cmddetail:"fn":"testJSON","file":"cmnds/cmd_test.c","requires":"", + //cmddetail:"examples":""} + CMD_RegisterCommand("testJSON", NULL, testJSON, NULL, NULL); + //cmddetail:{"name":"testLog","args":"", + //cmddetail:"descr":"", + //cmddetail:"fn":"testLog","file":"cmnds/cmd_test.c","requires":"", + //cmddetail:"examples":""} + CMD_RegisterCommand("testLog", NULL, testLog, NULL, NULL); + //cmddetail:{"name":"testFloats","args":"", + //cmddetail:"descr":"", + //cmddetail:"fn":"testFloats","file":"cmnds/cmd_test.c","requires":"", + //cmddetail:"examples":""} + CMD_RegisterCommand("testFloats", NULL, testFloats, NULL, NULL); - CMD_RegisterCommand("testArgs", "", testArgs, "", NULL); - CMD_RegisterCommand("testStrdup", "", testStrdup, "", NULL); + //cmddetail:{"name":"testArgs","args":"", + //cmddetail:"descr":"", + //cmddetail:"fn":"testArgs","file":"cmnds/cmd_test.c","requires":"", + //cmddetail:"examples":""} + CMD_RegisterCommand("testArgs", NULL, testArgs, NULL, NULL); + //cmddetail:{"name":"testStrdup","args":"", + //cmddetail:"descr":"", + //cmddetail:"fn":"testStrdup","file":"cmnds/cmd_test.c","requires":"", + //cmddetail:"examples":""} + CMD_RegisterCommand("testStrdup", NULL, testStrdup, NULL, NULL); return 0; } diff --git a/src/driver/drv_bl0937.c b/src/driver/drv_bl0937.c index d36a0d2bb..b4fb88bbc 100644 --- a/src/driver/drv_bl0937.c +++ b/src/driver/drv_bl0937.c @@ -228,13 +228,41 @@ void BL0937_Init() { BL_Shared_Init(); - CMD_RegisterCommand("PowerSet","",BL0937_PowerSet, "Sets current power value for calibration", NULL); - CMD_RegisterCommand("VoltageSet","",BL0937_VoltageSet, "Sets current V value for calibration", NULL); - CMD_RegisterCommand("CurrentSet","",BL0937_CurrentSet, "Sets current I value for calibration", NULL); - CMD_RegisterCommand("PREF","",BL0937_PowerRef, "Sets the calibration multiplier", NULL); - CMD_RegisterCommand("VREF","",BL0937_VoltageRef, "Sets the calibration multiplier", NULL); - CMD_RegisterCommand("IREF","",BL0937_CurrentRef, "Sets the calibration multiplier", NULL); - CMD_RegisterCommand("PowerMax","",BL0937_PowerMax, "Sets Maximum power value measurement limiter", NULL); + //cmddetail:{"name":"PowerSet","args":"", + //cmddetail:"descr":"Sets current power value for calibration", + //cmddetail:"fn":"BL0937_PowerSet","file":"driver/drv_bl0937.c","requires":"", + //cmddetail:"examples":""} + CMD_RegisterCommand("PowerSet","",BL0937_PowerSet, NULL, NULL); + //cmddetail:{"name":"VoltageSet","args":"", + //cmddetail:"descr":"Sets current V value for calibration", + //cmddetail:"fn":"BL0937_VoltageSet","file":"driver/drv_bl0937.c","requires":"", + //cmddetail:"examples":""} + CMD_RegisterCommand("VoltageSet","",BL0937_VoltageSet, NULL, NULL); + //cmddetail:{"name":"CurrentSet","args":"", + //cmddetail:"descr":"Sets current I value for calibration", + //cmddetail:"fn":"BL0937_CurrentSet","file":"driver/drv_bl0937.c","requires":"", + //cmddetail:"examples":""} + CMD_RegisterCommand("CurrentSet","",BL0937_CurrentSet, NULL, NULL); + //cmddetail:{"name":"PREF","args":"", + //cmddetail:"descr":"Sets the calibration multiplier", + //cmddetail:"fn":"BL0937_PowerRef","file":"driver/drv_bl0937.c","requires":"", + //cmddetail:"examples":""} + CMD_RegisterCommand("PREF","",BL0937_PowerRef, NULL, NULL); + //cmddetail:{"name":"VREF","args":"", + //cmddetail:"descr":"Sets the calibration multiplier", + //cmddetail:"fn":"BL0937_VoltageRef","file":"driver/drv_bl0937.c","requires":"", + //cmddetail:"examples":""} + CMD_RegisterCommand("VREF","",BL0937_VoltageRef, NULL, NULL); + //cmddetail:{"name":"IREF","args":"", + //cmddetail:"descr":"Sets the calibration multiplier", + //cmddetail:"fn":"BL0937_CurrentRef","file":"driver/drv_bl0937.c","requires":"", + //cmddetail:"examples":""} + CMD_RegisterCommand("IREF","",BL0937_CurrentRef, NULL, NULL); + //cmddetail:{"name":"PowerMax","args":"", + //cmddetail:"descr":"Sets Maximum power value measurement limiter", + //cmddetail:"fn":"BL0937_PowerMax","file":"driver/drv_bl0937.c","requires":"", + //cmddetail:"examples":""} + CMD_RegisterCommand("PowerMax","",BL0937_PowerMax, NULL, NULL); BL0937_Init_Pins(); } diff --git a/src/driver/drv_bl0942.c b/src/driver/drv_bl0942.c index fc7a72ddc..d495bca6d 100644 --- a/src/driver/drv_bl0942.c +++ b/src/driver/drv_bl0942.c @@ -237,12 +237,12 @@ void BL0942_Init() UART_InitUART(BL0942_BAUD_RATE); UART_InitReceiveRingBuffer(256); - CMD_RegisterCommand("PowerSet","",BL0942_PowerSet, "Sets current power value for calibration", NULL); - CMD_RegisterCommand("VoltageSet","",BL0942_VoltageSet, "Sets current V value for calibration", NULL); - CMD_RegisterCommand("CurrentSet","",BL0942_CurrentSet, "Sets current I value for calibration", NULL); - CMD_RegisterCommand("PREF","",BL0942_PowerRef, "Sets the calibration multiplier", NULL); - CMD_RegisterCommand("VREF","",BL0942_VoltageRef, "Sets the calibration multiplier", NULL); - CMD_RegisterCommand("IREF","",BL0942_CurrentRef, "Sets the calibration multiplier", NULL); + CMD_RegisterCommand("PowerSet","",BL0942_PowerSet, NULL, NULL); + CMD_RegisterCommand("VoltageSet","",BL0942_VoltageSet, NULL, NULL); + CMD_RegisterCommand("CurrentSet","",BL0942_CurrentSet, NULL, NULL); + CMD_RegisterCommand("PREF","",BL0942_PowerRef, NULL, NULL); + CMD_RegisterCommand("VREF","",BL0942_VoltageRef, NULL, NULL); + CMD_RegisterCommand("IREF","",BL0942_CurrentRef, NULL, NULL); } void BL0942_RunFrame() { int len; diff --git a/src/driver/drv_bl_shared.c b/src/driver/drv_bl_shared.c index d2025f68a..b94b71a71 100644 --- a/src/driver/drv_bl_shared.c +++ b/src/driver/drv_bl_shared.c @@ -633,9 +633,21 @@ void BL_Shared_Init() //int HAL_SetEnergyMeterStatus(ENERGY_METERING_DATA *data); - CMD_RegisterCommand("EnergyCntReset", "", BL09XX_ResetEnergyCounter, "Reset Energy Counter", NULL); - CMD_RegisterCommand("SetupEnergyStats", "", BL09XX_SetupEnergyStatistic, "Setup Energy Statistic Parameters: [enable<0|1>] [sample_time<10..900>] [sample_count<10..180>]", NULL); - CMD_RegisterCommand("ConsumptionThresold", "", BL09XX_SetupConsumptionThreshold, "Setup value for automatic save of consumption data [1..100]", NULL); + //cmddetail:{"name":"EnergyCntReset","args":"", + //cmddetail:"descr":"Reset Energy Counter", + //cmddetail:"fn":"BL09XX_ResetEnergyCounter","file":"driver/drv_bl_shared.c","requires":"", + //cmddetail:"examples":""} + CMD_RegisterCommand("EnergyCntReset", "", BL09XX_ResetEnergyCounter, NULL, NULL); + //cmddetail:{"name":"SetupEnergyStats","args":"", + //cmddetail:"descr":"Setup Energy Statistic Parameters: [enable<0|1>] [sample_time<10..900>] [sample_count<10..180>]", + //cmddetail:"fn":"BL09XX_SetupEnergyStatistic","file":"driver/drv_bl_shared.c","requires":"", + //cmddetail:"examples":""} + CMD_RegisterCommand("SetupEnergyStats", "", BL09XX_SetupEnergyStatistic, NULL, NULL); + //cmddetail:{"name":"ConsumptionThresold","args":"", + //cmddetail:"descr":"Setup value for automatic save of consumption data [1..100]", + //cmddetail:"fn":"BL09XX_SetupConsumptionThreshold","file":"driver/drv_bl_shared.c","requires":"", + //cmddetail:"examples":""} + CMD_RegisterCommand("ConsumptionThresold", "", BL09XX_SetupConsumptionThreshold, NULL, NULL); } // OBK_POWER etc diff --git a/src/driver/drv_bp1658cj.c b/src/driver/drv_bp1658cj.c index cb8c870e6..351835446 100644 --- a/src/driver/drv_bp1658cj.c +++ b/src/driver/drv_bp1658cj.c @@ -209,8 +209,16 @@ void BP1658CJ_Init() { BP1658CJ_PreInit(); - CMD_RegisterCommand("BP1658CJ_RGBCW", "", BP1658CJ_RGBCW, "qq", NULL); - CMD_RegisterCommand("BP1658CJ_Map", "", BP1658CJ_Map, "qq", NULL); + //cmddetail:{"name":"BP1658CJ_RGBCW","args":"", + //cmddetail:"descr":"qq", + //cmddetail:"fn":"BP1658CJ_RGBCW","file":"driver/drv_bp1658cj.c","requires":"", + //cmddetail:"examples":""} + CMD_RegisterCommand("BP1658CJ_RGBCW", "", BP1658CJ_RGBCW, NULL, NULL); + //cmddetail:{"name":"BP1658CJ_Map","args":"", + //cmddetail:"descr":"qq", + //cmddetail:"fn":"BP1658CJ_Map","file":"driver/drv_bp1658cj.c","requires":"", + //cmddetail:"examples":""} + CMD_RegisterCommand("BP1658CJ_Map", "", BP1658CJ_Map, NULL, NULL); } void BP1658CJ_RunFrame() { diff --git a/src/driver/drv_bp5758d.c b/src/driver/drv_bp5758d.c index 024f211f5..a12c219d3 100644 --- a/src/driver/drv_bp5758d.c +++ b/src/driver/drv_bp5758d.c @@ -277,9 +277,21 @@ void BP5758D_Init() { BP5758D_PreInit(); - CMD_RegisterCommand("BP5758D_RGBCW", "", BP5758D_RGBCW, "qq", NULL); - CMD_RegisterCommand("BP5758D_Map", "", BP5758D_Map, "qq", NULL); - CMD_RegisterCommand("BP5758D_Current", "", BP5758D_Current, "qq", NULL); + //cmddetail:{"name":"BP5758D_RGBCW","args":"", + //cmddetail:"descr":"qq", + //cmddetail:"fn":"BP5758D_RGBCW","file":"driver/drv_bp5758d.c","requires":"", + //cmddetail:"examples":""} + CMD_RegisterCommand("BP5758D_RGBCW", "", BP5758D_RGBCW, NULL, NULL); + //cmddetail:{"name":"BP5758D_Map","args":"", + //cmddetail:"descr":"qq", + //cmddetail:"fn":"BP5758D_Map","file":"driver/drv_bp5758d.c","requires":"", + //cmddetail:"examples":""} + CMD_RegisterCommand("BP5758D_Map", "", BP5758D_Map, NULL, NULL); + //cmddetail:{"name":"BP5758D_Current","args":"", + //cmddetail:"descr":"qq", + //cmddetail:"fn":"BP5758D_Current","file":"driver/drv_bp5758d.c","requires":"", + //cmddetail:"examples":""} + CMD_RegisterCommand("BP5758D_Current", "", BP5758D_Current, NULL, NULL); } void BP5758D_RunFrame() { diff --git a/src/driver/drv_cse7766.c b/src/driver/drv_cse7766.c index 31aef9b88..7f7390fd6 100644 --- a/src/driver/drv_cse7766.c +++ b/src/driver/drv_cse7766.c @@ -309,12 +309,12 @@ void CSE7766_Init() UART_InitUART(CSE7766_BAUD_RATE); UART_InitReceiveRingBuffer(512); - CMD_RegisterCommand("PowerSet","",CSE7766_PowerSet, "Sets current power value for calibration", NULL); - CMD_RegisterCommand("VoltageSet","",CSE7766_VoltageSet, "Sets current V value for calibration", NULL); - CMD_RegisterCommand("CurrentSet","",CSE7766_CurrentSet, "Sets current I value for calibration", NULL); - CMD_RegisterCommand("PREF","",CSE7766_PowerRef, "Sets the calibration multiplier", NULL); - CMD_RegisterCommand("VREF","",CSE7766_VoltageRef, "Sets the calibration multiplier", NULL); - CMD_RegisterCommand("IREF","",CSE7766_CurrentRef, "Sets the calibration multiplier", NULL); + CMD_RegisterCommand("PowerSet","",CSE7766_PowerSet, NULL, NULL); + CMD_RegisterCommand("VoltageSet","",CSE7766_VoltageSet, NULL, NULL); + CMD_RegisterCommand("CurrentSet","",CSE7766_CurrentSet, NULL, NULL); + CMD_RegisterCommand("PREF","",CSE7766_PowerRef, NULL, NULL); + CMD_RegisterCommand("VREF","",CSE7766_VoltageRef, NULL, NULL); + CMD_RegisterCommand("IREF","",CSE7766_CurrentRef, NULL, NULL); } void CSE7766_RunFrame() { diff --git a/src/driver/drv_ir.cpp b/src/driver/drv_ir.cpp index 5796c8d29..9da5f1c93 100644 --- a/src/driver/drv_ir.cpp +++ b/src/driver/drv_ir.cpp @@ -626,8 +626,16 @@ extern "C" void DRV_IR_Init(){ pIRsend = pIRsendTemp; //bk_pwm_stop((bk_pwm_t)pIRsend->pwmIndex); - CMD_RegisterCommand("IRSend","",IR_Send_Cmd, "Sends IR commands in the form PROT-ADDR-CMD-REP, e.g. NEC-1-1A-0", NULL); - CMD_RegisterCommand("IREnable", "", IR_Enable, "Enable/disable aspects of IR. IREnable RXTX 0/1 - enable Rx whilst Tx. IREnable [protocolname] 0/1 - enable/disable a specified protocol", NULL); + //cmddetail:{"name":"IRSend","args":"", + //cmddetail:"descr":"Sends IR commands in the form PROT-ADDR-CMD-REP, e.g. NEC-1-1A-0", + //cmddetail:"fn":"IR_Send_Cmd","file":"driver/drv_ir.cpp","requires":"", + //cmddetail:"examples":""} + CMD_RegisterCommand("IRSend",NULL,IR_Send_Cmd, NULL, NULL); + //cmddetail:{"name":"IREnable","args":"", + //cmddetail:"descr":"Enable/disable aspects of IR. IREnable RXTX 0/1 - enable Rx whilst Tx. IREnable [protocolname] 0/1 - enable/disable a specified protocol", + //cmddetail:"fn":"IR_Enable","file":"driver/drv_ir.cpp","requires":"", + //cmddetail:"examples":""} + CMD_RegisterCommand("IREnable", "", IR_Enable, NULL, NULL); } } if ((pin > 0) || (txpin > 0)){ diff --git a/src/driver/drv_main.c b/src/driver/drv_main.c index 80e69dd4d..8cb97e642 100644 --- a/src/driver/drv_main.c +++ b/src/driver/drv_main.c @@ -246,8 +246,16 @@ static int DRV_Stop(const void* context, const char* cmd, const char* args, int } void DRV_Generic_Init() { - CMD_RegisterCommand("startDriver", "", DRV_Start, "Starts driver", NULL); - CMD_RegisterCommand("stopDriver", "", DRV_Stop, "Stops driver", NULL); + //cmddetail:{"name":"startDriver","args":"", + //cmddetail:"descr":"Starts driver", + //cmddetail:"fn":"DRV_Start","file":"driver/drv_main.c","requires":"", + //cmddetail:"examples":""} + CMD_RegisterCommand("startDriver", "", DRV_Start, NULL, NULL); + //cmddetail:{"name":"stopDriver","args":"", + //cmddetail:"descr":"Stops driver", + //cmddetail:"fn":"DRV_Stop","file":"driver/drv_main.c","requires":"", + //cmddetail:"examples":""} + CMD_RegisterCommand("stopDriver", "", DRV_Stop, NULL, NULL); } void DRV_AppendInformationToHTTPIndexPage(http_request_t* request) { int i, j; diff --git a/src/driver/drv_ntp.c b/src/driver/drv_ntp.c index 5a314cf7f..6b2ca3365 100644 --- a/src/driver/drv_ntp.c +++ b/src/driver/drv_ntp.c @@ -102,9 +102,21 @@ int NTP_Info(const void *context, const char *cmd, const char *args, int cmdFlag void NTP_Init() { - CMD_RegisterCommand("ntp_timeZoneOfs","",NTP_SetTimeZoneOfs, "Sets the time zone offset in hours", NULL); - CMD_RegisterCommand("ntp_setServer", "", NTP_SetServer, "Sets the NTP server", NULL); - CMD_RegisterCommand("ntp_info", "", NTP_Info, "Display NTP related settings", NULL); + //cmddetail:{"name":"ntp_timeZoneOfs","args":"", + //cmddetail:"descr":"Sets the time zone offset in hours", + //cmddetail:"fn":"NTP_SetTimeZoneOfs","file":"driver/drv_ntp.c","requires":"", + //cmddetail:"examples":""} + CMD_RegisterCommand("ntp_timeZoneOfs","",NTP_SetTimeZoneOfs, NULL, NULL); + //cmddetail:{"name":"ntp_setServer","args":"", + //cmddetail:"descr":"Sets the NTP server", + //cmddetail:"fn":"NTP_SetServer","file":"driver/drv_ntp.c","requires":"", + //cmddetail:"examples":""} + CMD_RegisterCommand("ntp_setServer", "", NTP_SetServer, NULL, NULL); + //cmddetail:{"name":"ntp_info","args":"", + //cmddetail:"descr":"Display NTP related settings", + //cmddetail:"fn":"NTP_Info","file":"driver/drv_ntp.c","requires":"", + //cmddetail:"examples":""} + CMD_RegisterCommand("ntp_info", "", NTP_Info, NULL, NULL); addLogAdv(LOG_INFO, LOG_FEATURE_NTP, "NTP driver initialized with server=%s, offset=%d\n", CFG_GetNTPServer(), g_timeOffsetHours); g_synced = false; diff --git a/src/driver/drv_sm2135.c b/src/driver/drv_sm2135.c index 9978e3eb4..3879622ae 100644 --- a/src/driver/drv_sm2135.c +++ b/src/driver/drv_sm2135.c @@ -230,9 +230,21 @@ void SM2135_Init() { g_pin_clk = PIN_FindPinIndexForRole(IOR_SM2135_CLK,g_pin_clk); g_pin_data = PIN_FindPinIndexForRole(IOR_SM2135_DAT,g_pin_data); - CMD_RegisterCommand("SM2135_RGBCW", "", SM2135_RGBCW, "qq", NULL); - CMD_RegisterCommand("SM2135_Map", "", SM2135_Map, "qq", NULL); - CMD_RegisterCommand("SM2135_Current", "", SM2135_Current, "qq", NULL); + //cmddetail:{"name":"SM2135_RGBCW","args":"", + //cmddetail:"descr":"qq", + //cmddetail:"fn":"SM2135_RGBCW","file":"driver/drv_sm2135.c","requires":"", + //cmddetail:"examples":""} + CMD_RegisterCommand("SM2135_RGBCW", "", SM2135_RGBCW, NULL, NULL); + //cmddetail:{"name":"SM2135_Map","args":"", + //cmddetail:"descr":"qq", + //cmddetail:"fn":"SM2135_Map","file":"driver/drv_sm2135.c","requires":"", + //cmddetail:"examples":""} + CMD_RegisterCommand("SM2135_Map", "", SM2135_Map, NULL, NULL); + //cmddetail:{"name":"SM2135_Current","args":"", + //cmddetail:"descr":"qq", + //cmddetail:"fn":"SM2135_Current","file":"driver/drv_sm2135.c","requires":"", + //cmddetail:"examples":""} + CMD_RegisterCommand("SM2135_Current", "", SM2135_Current, NULL, NULL); } void SM2135_RunFrame() { diff --git a/src/driver/drv_ssdp.c b/src/driver/drv_ssdp.c index 1a640c6fd..7ef80b536 100644 --- a/src/driver/drv_ssdp.c +++ b/src/driver/drv_ssdp.c @@ -429,7 +429,11 @@ void DRV_SSDP_Init() DRV_SSDP_CreateSocket_Receive(); HTTP_RegisterCallback("/ssdp.xml", HTTP_GET, DRV_SSDP_Service_Http); - CMD_RegisterCommand("obkDeviceList", "", Cmd_obkDeviceList, "qqq", NULL); + //cmddetail:{"name":"obkDeviceList","args":"", + //cmddetail:"descr":"qqq", + //cmddetail:"fn":"Cmd_obkDeviceList","file":"driver/drv_ssdp.c","requires":"", + //cmddetail:"examples":""} + CMD_RegisterCommand("obkDeviceList", "", Cmd_obkDeviceList, NULL, NULL); HTTP_RegisterCallback("/obkdevicelist", HTTP_GET, http_rest_get_devicelist); diff --git a/src/driver/drv_tasmotaDeviceGroups.c b/src/driver/drv_tasmotaDeviceGroups.c index f8e8d91a1..b169443c0 100644 --- a/src/driver/drv_tasmotaDeviceGroups.c +++ b/src/driver/drv_tasmotaDeviceGroups.c @@ -822,10 +822,26 @@ void DRV_DGR_Init() DRV_DGR_CreateSocket_Send(); #endif - CMD_RegisterCommand("DGR_SendPower", "", CMD_DGR_SendPower, "qqq", NULL); - CMD_RegisterCommand("DGR_SendBrightness", "", CMD_DGR_SendBrightness, "qqq", NULL); - CMD_RegisterCommand("DGR_SendRGBCW", "", CMD_DGR_SendRGBCW, "qqq", NULL); - CMD_RegisterCommand("DGR_SendFixedColor", "", CMD_DGR_SendFixedColor, "qqq", NULL); + //cmddetail:{"name":"DGR_SendPower","args":"", + //cmddetail:"descr":"qqq", + //cmddetail:"fn":"CMD_DGR_SendPower","file":"driver/drv_tasmotaDeviceGroups.c","requires":"", + //cmddetail:"examples":""} + CMD_RegisterCommand("DGR_SendPower", "", CMD_DGR_SendPower, NULL, NULL); + //cmddetail:{"name":"DGR_SendBrightness","args":"", + //cmddetail:"descr":"qqq", + //cmddetail:"fn":"CMD_DGR_SendBrightness","file":"driver/drv_tasmotaDeviceGroups.c","requires":"", + //cmddetail:"examples":""} + CMD_RegisterCommand("DGR_SendBrightness", "", CMD_DGR_SendBrightness, NULL, NULL); + //cmddetail:{"name":"DGR_SendRGBCW","args":"", + //cmddetail:"descr":"qqq", + //cmddetail:"fn":"CMD_DGR_SendRGBCW","file":"driver/drv_tasmotaDeviceGroups.c","requires":"", + //cmddetail:"examples":""} + CMD_RegisterCommand("DGR_SendRGBCW", "", CMD_DGR_SendRGBCW, NULL, NULL); + //cmddetail:{"name":"DGR_SendFixedColor","args":"", + //cmddetail:"descr":"qqq", + //cmddetail:"fn":"CMD_DGR_SendFixedColor","file":"driver/drv_tasmotaDeviceGroups.c","requires":"", + //cmddetail:"examples":""} + CMD_RegisterCommand("DGR_SendFixedColor", "", CMD_DGR_SendFixedColor, NULL, NULL); } diff --git a/src/driver/drv_tuyaMCU.c b/src/driver/drv_tuyaMCU.c index 4e376e12c..6ae1f1aff 100644 --- a/src/driver/drv_tuyaMCU.c +++ b/src/driver/drv_tuyaMCU.c @@ -1193,20 +1193,72 @@ void TuyaMCU_Init() UART_InitUART(g_baudRate); UART_InitReceiveRingBuffer(256); // uartSendHex 55AA0008000007 - CMD_RegisterCommand("tuyaMcu_testSendTime","",TuyaMCU_Send_SetTime_Example, "Sends a example date by TuyaMCU to clock/callendar MCU", NULL); - CMD_RegisterCommand("tuyaMcu_sendCurTime","",TuyaMCU_Send_SetTime_Current, "Sends a current date by TuyaMCU to clock/callendar MCU", NULL); - CMD_RegisterCommand("uartSendHex","",TuyaMCU_Send_Hex, "Sends raw data by TuyaMCU UART, you must write whole packet with checksum yourself", NULL); - CMD_RegisterCommand("tuyaMcu_fakeHex","",TuyaMCU_Fake_Hex, "qq", NULL); + //cmddetail:{"name":"tuyaMcu_testSendTime","args":"", + //cmddetail:"descr":"Sends a example date by TuyaMCU to clock/callendar MCU", + //cmddetail:"fn":"TuyaMCU_Send_SetTime_Example","file":"driver/drv_tuyaMCU.c","requires":"", + //cmddetail:"examples":""} + CMD_RegisterCommand("tuyaMcu_testSendTime","",TuyaMCU_Send_SetTime_Example, NULL, NULL); + //cmddetail:{"name":"tuyaMcu_sendCurTime","args":"", + //cmddetail:"descr":"Sends a current date by TuyaMCU to clock/callendar MCU", + //cmddetail:"fn":"TuyaMCU_Send_SetTime_Current","file":"driver/drv_tuyaMCU.c","requires":"", + //cmddetail:"examples":""} + CMD_RegisterCommand("tuyaMcu_sendCurTime","",TuyaMCU_Send_SetTime_Current, NULL, NULL); + //cmddetail:{"name":"uartSendHex","args":"", + //cmddetail:"descr":"Sends raw data by TuyaMCU UART, you must write whole packet with checksum yourself", + //cmddetail:"fn":"TuyaMCU_Send_Hex","file":"driver/drv_tuyaMCU.c","requires":"", + //cmddetail:"examples":""} + CMD_RegisterCommand("uartSendHex",NULL,TuyaMCU_Send_Hex, NULL, NULL); + //cmddetail:{"name":"tuyaMcu_fakeHex","args":"", + //cmddetail:"descr":"qq", + //cmddetail:"fn":"TuyaMCU_Fake_Hex","file":"driver/drv_tuyaMCU.c","requires":"", + //cmddetail:"examples":""} + CMD_RegisterCommand("tuyaMcu_fakeHex","",TuyaMCU_Fake_Hex, NULL, NULL); ///CMD_RegisterCommand("tuyaMcu_sendSimple","",TuyaMCU_Send_Simple, "Appends a 0x55 0xAA header to a data, append a checksum at end and send"); - CMD_RegisterCommand("linkTuyaMCUOutputToChannel","",TuyaMCU_LinkTuyaMCUOutputToChannel, "Map value send from TuyaMCU (eg. humidity or temperature) to channel", NULL); - CMD_RegisterCommand("tuyaMcu_setDimmerRange","",TuyaMCU_SetDimmerRange, "Set dimmer range used by TuyaMCU", NULL); - CMD_RegisterCommand("tuyaMcu_sendHeartbeat","",TuyaMCU_SendHeartbeat, "Send heartbeat to TuyaMCU", NULL); - CMD_RegisterCommand("tuyaMcu_sendQueryState","",TuyaMCU_SendQueryState, "Send query state command", NULL); - CMD_RegisterCommand("tuyaMcu_sendProductInformation","",TuyaMCU_SendQueryProductInformation, "Send qqq", NULL); - CMD_RegisterCommand("tuyaMcu_sendState","",TuyaMCU_SendStateCmd, "Send set state command", NULL); - CMD_RegisterCommand("tuyaMcu_sendMCUConf","",TuyaMCU_SendMCUConf, "Send MCU conf command", NULL); - CMD_RegisterCommand("fakeTuyaPacket","",TuyaMCU_FakePacket, "qq", NULL); - CMD_RegisterCommand("tuyaMcu_setBaudRate","",TuyaMCU_SetBaudRate, "Set the serial baud rate used to communicate with the TuyaMCU", NULL); + //cmddetail:{"name":"linkTuyaMCUOutputToChannel","args":"", + //cmddetail:"descr":"Map value send from TuyaMCU (eg. humidity or temperature) to channel", + //cmddetail:"fn":"TuyaMCU_LinkTuyaMCUOutputToChannel","file":"driver/drv_tuyaMCU.c","requires":"", + //cmddetail:"examples":""} + CMD_RegisterCommand("linkTuyaMCUOutputToChannel","",TuyaMCU_LinkTuyaMCUOutputToChannel, NULL, NULL); + //cmddetail:{"name":"tuyaMcu_setDimmerRange","args":"", + //cmddetail:"descr":"Set dimmer range used by TuyaMCU", + //cmddetail:"fn":"TuyaMCU_SetDimmerRange","file":"driver/drv_tuyaMCU.c","requires":"", + //cmddetail:"examples":""} + CMD_RegisterCommand("tuyaMcu_setDimmerRange","",TuyaMCU_SetDimmerRange, NULL, NULL); + //cmddetail:{"name":"tuyaMcu_sendHeartbeat","args":"", + //cmddetail:"descr":"Send heartbeat to TuyaMCU", + //cmddetail:"fn":"TuyaMCU_SendHeartbeat","file":"driver/drv_tuyaMCU.c","requires":"", + //cmddetail:"examples":""} + CMD_RegisterCommand("tuyaMcu_sendHeartbeat","",TuyaMCU_SendHeartbeat, NULL, NULL); + //cmddetail:{"name":"tuyaMcu_sendQueryState","args":"", + //cmddetail:"descr":"Send query state command", + //cmddetail:"fn":"TuyaMCU_SendQueryState","file":"driver/drv_tuyaMCU.c","requires":"", + //cmddetail:"examples":""} + CMD_RegisterCommand("tuyaMcu_sendQueryState","",TuyaMCU_SendQueryState, NULL, NULL); + //cmddetail:{"name":"tuyaMcu_sendProductInformation","args":"", + //cmddetail:"descr":"Send qqq", + //cmddetail:"fn":"TuyaMCU_SendQueryProductInformation","file":"driver/drv_tuyaMCU.c","requires":"", + //cmddetail:"examples":""} + CMD_RegisterCommand("tuyaMcu_sendProductInformation","",TuyaMCU_SendQueryProductInformation, NULL, NULL); + //cmddetail:{"name":"tuyaMcu_sendState","args":"", + //cmddetail:"descr":"Send set state command", + //cmddetail:"fn":"TuyaMCU_SendStateCmd","file":"driver/drv_tuyaMCU.c","requires":"", + //cmddetail:"examples":""} + CMD_RegisterCommand("tuyaMcu_sendState","",TuyaMCU_SendStateCmd, NULL, NULL); + //cmddetail:{"name":"tuyaMcu_sendMCUConf","args":"", + //cmddetail:"descr":"Send MCU conf command", + //cmddetail:"fn":"TuyaMCU_SendMCUConf","file":"driver/drv_tuyaMCU.c","requires":"", + //cmddetail:"examples":""} + CMD_RegisterCommand("tuyaMcu_sendMCUConf","",TuyaMCU_SendMCUConf, NULL, NULL); + //cmddetail:{"name":"fakeTuyaPacket","args":"", + //cmddetail:"descr":"qq", + //cmddetail:"fn":"TuyaMCU_FakePacket","file":"driver/drv_tuyaMCU.c","requires":"", + //cmddetail:"examples":""} + CMD_RegisterCommand("fakeTuyaPacket","",TuyaMCU_FakePacket, NULL, NULL); + //cmddetail:{"name":"tuyaMcu_setBaudRate","args":"", + //cmddetail:"descr":"Set the serial baud rate used to communicate with the TuyaMCU", + //cmddetail:"fn":"TuyaMCU_SetBaudRate","file":"driver/drv_tuyaMCU.c","requires":"", + //cmddetail:"examples":""} + CMD_RegisterCommand("tuyaMcu_setBaudRate","",TuyaMCU_SetBaudRate, NULL, NULL); } // Door sensor with TuyaMCU version 0 (not 3), so all replies have x00 and not 0x03 byte // fakeTuyaPacket 55AA0008000C00010101010101030400010223 diff --git a/src/driver/drv_ucs1912.c b/src/driver/drv_ucs1912.c index dcfe3512d..ca74dd11a 100644 --- a/src/driver/drv_ucs1912.c +++ b/src/driver/drv_ucs1912.c @@ -76,7 +76,11 @@ void UCS1912_Init() { HAL_PIN_Setup_Output(g_pin_di); - CMD_RegisterCommand("UCS1912_Test", "", UCS1912_Test, "qq", NULL); + //cmddetail:{"name":"UCS1912_Test","args":"", + //cmddetail:"descr":"qq", + //cmddetail:"fn":"UCS1912_Test","file":"driver/drv_ucs1912.c","requires":"", + //cmddetail:"examples":""} + CMD_RegisterCommand("UCS1912_Test", "", UCS1912_Test, NULL, NULL); } diff --git a/src/i2c/drv_i2c_lcd_pcf8574t.c b/src/i2c/drv_i2c_lcd_pcf8574t.c index b724b1402..923a16f30 100644 --- a/src/i2c/drv_i2c_lcd_pcf8574t.c +++ b/src/i2c/drv_i2c_lcd_pcf8574t.c @@ -326,10 +326,26 @@ static int g_i2c_cmds_lcd_init = 0; void DRV_I2C_Commands_Init() { - CMD_RegisterCommand("lcd_clearAndGoto","",DRV_I2C_LCD_PCF8574_ClearAndGoTo, "Adds a new I2C device", NULL); - CMD_RegisterCommand("lcd_goto","",DRV_I2C_LCD_PCF8574_GoTo, "Adds a new I2C device", NULL); - CMD_RegisterCommand("lcd_print","",DRV_I2C_LCD_PCF8574_Print, "Adds a new I2C device", NULL); - CMD_RegisterCommand("lcd_clear","",DRV_I2C_LCD_PCF8574_Clear, "Adds a new I2C device", NULL); + //cmddetail:{"name":"lcd_clearAndGoto","args":"", + //cmddetail:"descr":"Adds a new I2C device", + //cmddetail:"fn":"DRV_I2C_LCD_PCF8574_ClearAndGoTo","file":"i2c/drv_i2c_lcd_pcf8574t.c","requires":"", + //cmddetail:"examples":""} + CMD_RegisterCommand("lcd_clearAndGoto","",DRV_I2C_LCD_PCF8574_ClearAndGoTo, NULL, NULL); + //cmddetail:{"name":"lcd_goto","args":"", + //cmddetail:"descr":"Adds a new I2C device", + //cmddetail:"fn":"DRV_I2C_LCD_PCF8574_GoTo","file":"i2c/drv_i2c_lcd_pcf8574t.c","requires":"", + //cmddetail:"examples":""} + CMD_RegisterCommand("lcd_goto","",DRV_I2C_LCD_PCF8574_GoTo, NULL, NULL); + //cmddetail:{"name":"lcd_print","args":"", + //cmddetail:"descr":"Adds a new I2C device", + //cmddetail:"fn":"DRV_I2C_LCD_PCF8574_Print","file":"i2c/drv_i2c_lcd_pcf8574t.c","requires":"", + //cmddetail:"examples":""} + CMD_RegisterCommand("lcd_print","",DRV_I2C_LCD_PCF8574_Print, NULL, NULL); + //cmddetail:{"name":"lcd_clear","args":"", + //cmddetail:"descr":"Adds a new I2C device", + //cmddetail:"fn":"DRV_I2C_LCD_PCF8574_Clear","file":"i2c/drv_i2c_lcd_pcf8574t.c","requires":"", + //cmddetail:"examples":""} + CMD_RegisterCommand("lcd_clear","",DRV_I2C_LCD_PCF8574_Clear, NULL, NULL); } /// backlog startDriver I2C; addI2CDevice_LCD_PCF8574 I2C1 0x23 0 0 0 // lcd_print I2C1 0x23 Hello123 diff --git a/src/i2c/drv_i2c_main.c b/src/i2c/drv_i2c_main.c index cc08cb0f6..57c8c2cb5 100644 --- a/src/i2c/drv_i2c_main.c +++ b/src/i2c/drv_i2c_main.c @@ -290,11 +290,31 @@ int DRV_I2C_AddDevice_LCM1602(const void *context, const char *cmd, const char * void DRV_I2C_Init() { - CMD_RegisterCommand("addI2CDevice_TC74","",DRV_I2C_AddDevice_TC74, "Adds a new I2C device", NULL); - CMD_RegisterCommand("addI2CDevice_MCP23017","",DRV_I2C_AddDevice_MCP23017, "Adds a new I2C device", NULL); - CMD_RegisterCommand("addI2CDevice_LCM1602","",DRV_I2C_AddDevice_LCM1602, "Adds a new I2C device", NULL); - CMD_RegisterCommand("addI2CDevice_LCD_PCF8574","",DRV_I2C_AddDevice_PCF8574, "Adds a new I2C device", NULL); - CMD_RegisterCommand("MCP23017_MapPinToChannel","",DRV_I2C_MCP23017_MapPinToChannel, "Adds a new I2C device", NULL); + //cmddetail:{"name":"addI2CDevice_TC74","args":"", + //cmddetail:"descr":"Adds a new I2C device", + //cmddetail:"fn":"DRV_I2C_AddDevice_TC74","file":"i2c/drv_i2c_main.c","requires":"", + //cmddetail:"examples":""} + CMD_RegisterCommand("addI2CDevice_TC74","",DRV_I2C_AddDevice_TC74, NULL, NULL); + //cmddetail:{"name":"addI2CDevice_MCP23017","args":"", + //cmddetail:"descr":"Adds a new I2C device", + //cmddetail:"fn":"DRV_I2C_AddDevice_MCP23017","file":"i2c/drv_i2c_main.c","requires":"", + //cmddetail:"examples":""} + CMD_RegisterCommand("addI2CDevice_MCP23017","",DRV_I2C_AddDevice_MCP23017, NULL, NULL); + //cmddetail:{"name":"addI2CDevice_LCM1602","args":"", + //cmddetail:"descr":"Adds a new I2C device", + //cmddetail:"fn":"DRV_I2C_AddDevice_LCM1602","file":"i2c/drv_i2c_main.c","requires":"", + //cmddetail:"examples":""} + CMD_RegisterCommand("addI2CDevice_LCM1602","",DRV_I2C_AddDevice_LCM1602, NULL, NULL); + //cmddetail:{"name":"addI2CDevice_LCD_PCF8574","args":"", + //cmddetail:"descr":"Adds a new I2C device", + //cmddetail:"fn":"DRV_I2C_AddDevice_PCF8574","file":"i2c/drv_i2c_main.c","requires":"", + //cmddetail:"examples":""} + CMD_RegisterCommand("addI2CDevice_LCD_PCF8574","",DRV_I2C_AddDevice_PCF8574, NULL, NULL); + //cmddetail:{"name":"MCP23017_MapPinToChannel","args":"", + //cmddetail:"descr":"Adds a new I2C device", + //cmddetail:"fn":"DRV_I2C_MCP23017_MapPinToChannel","file":"i2c/drv_i2c_main.c","requires":"", + //cmddetail:"examples":""} + CMD_RegisterCommand("MCP23017_MapPinToChannel","",DRV_I2C_MCP23017_MapPinToChannel, NULL, NULL); } void DRC_I2C_RunDevice(i2cDevice_t *dev) diff --git a/src/littlefs/our_lfs.c b/src/littlefs/our_lfs.c index 5b80bcbec..b0f6f19f8 100644 --- a/src/littlefs/our_lfs.c +++ b/src/littlefs/our_lfs.c @@ -199,10 +199,26 @@ static int CMD_LFS_Format(const void *context, const char *cmd, const char *args } void LFSAddCmds(){ - CMD_RegisterCommand("lfssize", NULL, CMD_LFS_Size, "Log or Set LFS size - will apply and re-format next boot, usage setlfssize 0x10000", NULL); - CMD_RegisterCommand("lfsunmount", NULL, CMD_LFS_Unmount, "Un-mount LFS", NULL); - CMD_RegisterCommand("lfsmount", NULL, CMD_LFS_Mount, "Mount LFS", NULL); - CMD_RegisterCommand("lfsformat", NULL, CMD_LFS_Format, "Unmount and format LFS. Optionally add new size as argument", NULL); + //cmddetail:{"name":"lfssize","args":"NULL", + //cmddetail:"descr":"Log or Set LFS size - will apply and re-format next boot, usage setlfssize 0x10000", + //cmddetail:"fn":"CMD_LFS_Size","file":"littlefs/our_lfs.c","requires":"", + //cmddetail:"examples":""} + CMD_RegisterCommand("lfssize", NULL, CMD_LFS_Size, NULL, NULL); + //cmddetail:{"name":"lfsunmount","args":"NULL", + //cmddetail:"descr":"Un-mount LFS", + //cmddetail:"fn":"CMD_LFS_Unmount","file":"littlefs/our_lfs.c","requires":"", + //cmddetail:"examples":""} + CMD_RegisterCommand("lfsunmount", NULL, CMD_LFS_Unmount, NULL, NULL); + //cmddetail:{"name":"lfsmount","args":"NULL", + //cmddetail:"descr":"Mount LFS", + //cmddetail:"fn":"CMD_LFS_Mount","file":"littlefs/our_lfs.c","requires":"", + //cmddetail:"examples":""} + CMD_RegisterCommand("lfsmount", NULL, CMD_LFS_Mount, NULL, NULL); + //cmddetail:{"name":"lfsformat","args":"NULL", + //cmddetail:"descr":"Unmount and format LFS. Optionally add new size as argument", + //cmddetail:"fn":"CMD_LFS_Format","file":"littlefs/our_lfs.c","requires":"", + //cmddetail:"examples":""} + CMD_RegisterCommand("lfsformat", NULL, CMD_LFS_Format, NULL, NULL); } diff --git a/src/logging/logging.c b/src/logging/logging.c index b66cbd069..d6a82046b 100644 --- a/src/logging/logging.c +++ b/src/logging/logging.c @@ -265,10 +265,26 @@ static void initLog(void) HTTP_RegisterCallback("/logs", HTTP_GET, http_getlog); HTTP_RegisterCallback("/lograw", HTTP_GET, http_getlograw); - CMD_RegisterCommand("loglevel", "", log_command, "set log level <0..6>", NULL); - CMD_RegisterCommand("logfeature", "", log_command, "set log feature filter, <0..10> <0|1>", NULL); - CMD_RegisterCommand("logtype", "", log_command, "logtype direct|all - direct logs only to serial immediately", NULL); - CMD_RegisterCommand("logdelay", "", log_command, "logdelay 0..n - impose ms delay after every log", NULL); + //cmddetail:{"name":"loglevel","args":"", + //cmddetail:"descr":"set log level <0..6>", + //cmddetail:"fn":"log_command","file":"logging/logging.c","requires":"", + //cmddetail:"examples":""} + CMD_RegisterCommand("loglevel", "", log_command, NULL, NULL); + //cmddetail:{"name":"logfeature","args":"", + //cmddetail:"descr":"set log feature filter, <0..10> <0|1>", + //cmddetail:"fn":"log_command","file":"logging/logging.c","requires":"", + //cmddetail:"examples":""} + CMD_RegisterCommand("logfeature", NULL, log_command, NULL, NULL); + //cmddetail:{"name":"logtype","args":"", + //cmddetail:"descr":"logtype direct|all - direct logs only to serial immediately", + //cmddetail:"fn":"log_command","file":"logging/logging.c","requires":"", + //cmddetail:"examples":""} + CMD_RegisterCommand("logtype", "", log_command, NULL, NULL); + //cmddetail:{"name":"logdelay","args":"", + //cmddetail:"descr":"logdelay 0..n - impose ms delay after every log", + //cmddetail:"fn":"log_command","file":"logging/logging.c","requires":"", + //cmddetail:"examples":""} + CMD_RegisterCommand("logdelay", "", log_command, NULL, NULL); bk_printf("Commands registered!\r\n"); bk_printf("initLog() done!\r\n"); @@ -722,6 +738,7 @@ int log_command(const void* context, const char* cmd, const char* args, int cmdF else { direct_serial_log = 0; } + result = 1; break; } if (!stricmp(cmd, "logdelay")) { @@ -733,6 +750,7 @@ int log_command(const void* context, const char* cmd, const char* args, int cmdF else { log_delay = 0; } + result = 1; break; } diff --git a/src/mqtt/new_mqtt.c b/src/mqtt/new_mqtt.c index f1b6d7cb8..614c92e62 100644 --- a/src/mqtt/new_mqtt.c +++ b/src/mqtt/new_mqtt.c @@ -1123,10 +1123,26 @@ void MQTT_init() mqtt_initialised = 1; - CMD_RegisterCommand(MQTT_COMMAND_PUBLISH, "", MQTT_PublishCommand, "Sqqq", NULL); - CMD_RegisterCommand(MQTT_COMMAND_PUBLISH_ALL, "", MQTT_PublishAll, "Sqqq", NULL); - CMD_RegisterCommand(MQTT_COMMAND_PUBLISH_CHANNELS, "", MQTT_PublishChannels, "Sqqq", NULL); - CMD_RegisterCommand(MQTT_COMMAND_PUBLISH_BENCHMARK, "", MQTT_StartMQTTTestThread, "", NULL); + //cmddetail:{"name":"MQTT_COMMAND_PUBLISH","args":"", + //cmddetail:"descr":"Sqqq", + //cmddetail:"fn":"MQTT_PublishCommand","file":"mqtt/new_mqtt.c","requires":"", + //cmddetail:"examples":""} + CMD_RegisterCommand(MQTT_COMMAND_PUBLISH, "", MQTT_PublishCommand, NULL, NULL); + //cmddetail:{"name":"MQTT_COMMAND_PUBLISH_ALL","args":"", + //cmddetail:"descr":"Sqqq", + //cmddetail:"fn":"MQTT_PublishAll","file":"mqtt/new_mqtt.c","requires":"", + //cmddetail:"examples":""} + CMD_RegisterCommand(MQTT_COMMAND_PUBLISH_ALL, "", MQTT_PublishAll, NULL, NULL); + //cmddetail:{"name":"MQTT_COMMAND_PUBLISH_CHANNELS","args":"", + //cmddetail:"descr":"Sqqq", + //cmddetail:"fn":"MQTT_PublishChannels","file":"mqtt/new_mqtt.c","requires":"", + //cmddetail:"examples":""} + CMD_RegisterCommand(MQTT_COMMAND_PUBLISH_CHANNELS, "", MQTT_PublishChannels, NULL, NULL); + //cmddetail:{"name":"MQTT_COMMAND_PUBLISH_BENCHMARK","args":"", + //cmddetail:"descr":"", + //cmddetail:"fn":"MQTT_StartMQTTTestThread","file":"mqtt/new_mqtt.c","requires":"", + //cmddetail:"examples":""} + CMD_RegisterCommand(MQTT_COMMAND_PUBLISH_BENCHMARK, NULL, MQTT_StartMQTTTestThread, NULL, NULL); } diff --git a/src/new_pins.c b/src/new_pins.c index 9bce8f5dc..d9161e19d 100644 --- a/src/new_pins.c +++ b/src/new_pins.c @@ -1429,10 +1429,30 @@ void PIN_StartButtonScanThread(void) void PIN_AddCommands(void) { - CMD_RegisterCommand("showgpi", NULL, showgpi, "log stat of all GPIs", NULL); - CMD_RegisterCommand("setChannelType", NULL, CMD_SetChannelType, "qqqqqqqq", NULL); - CMD_RegisterCommand("showChannelValues", NULL,CMD_ShowChannelValues, "log channel values", NULL); - CMD_RegisterCommand("setButtonTimes", NULL,CMD_SetButtonTimes, "", NULL); - CMD_RegisterCommand("setButtonHoldRepeat", NULL,CMD_setButtonHoldRepeat, "", NULL); + //cmddetail:{"name":"showgpi","args":"NULL", + //cmddetail:"descr":"log stat of all GPIs", + //cmddetail:"fn":"showgpi","file":"new_pins.c","requires":"", + //cmddetail:"examples":""} + CMD_RegisterCommand("showgpi", NULL, showgpi, NULL, NULL); + //cmddetail:{"name":"setChannelType","args":"NULL", + //cmddetail:"descr":"qqqqqqqq", + //cmddetail:"fn":"CMD_SetChannelType","file":"new_pins.c","requires":"", + //cmddetail:"examples":""} + CMD_RegisterCommand("setChannelType", NULL, CMD_SetChannelType, NULL, NULL); + //cmddetail:{"name":"showChannelValues","args":"NULL", + //cmddetail:"descr":"log channel values", + //cmddetail:"fn":"CMD_ShowChannelValues","file":"new_pins.c","requires":"", + //cmddetail:"examples":""} + CMD_RegisterCommand("showChannelValues", NULL,CMD_ShowChannelValues, NULL, NULL); + //cmddetail:{"name":"setButtonTimes","args":"NULL", + //cmddetail:"descr":"", + //cmddetail:"fn":"CMD_SetButtonTimes","file":"new_pins.c","requires":"", + //cmddetail:"examples":""} + CMD_RegisterCommand("setButtonTimes", NULL,CMD_SetButtonTimes, NULL, NULL); + //cmddetail:{"name":"setButtonHoldRepeat","args":"NULL", + //cmddetail:"descr":"", + //cmddetail:"fn":"CMD_setButtonHoldRepeat","file":"new_pins.c","requires":"", + //cmddetail:"examples":""} + CMD_RegisterCommand("setButtonHoldRepeat", NULL,CMD_setButtonHoldRepeat, NULL, NULL); }