ESP32 命令行解析框架

最新推荐文章于 2024-06-29 13:57:44 发布
最新推荐文章于 2024-06-29 13:57:44 发布
阅读量1k 收藏 5
点赞数 1
分类专栏： 技术内容整理 文章标签： 命令行解析框架
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/Seeker_ZeroOne/article/details/83376823
版权

 

命令行解析框架，使用链表将所有注册的信息串联起来，然后每个节点node包含了，keyword，help，数据类型描述，命令执行的回调函数，和参数存储的回调函数。主要的应用点是，已知函数变量地址，类型，和地址宽度，然后强制转换后对变量读写操作

经过网友的提醒，在关键字匹配的时候采用for循环匹配对整个框架来讲不是最优的，所以嵌入了博主http://www.cnblogs.com/skywang12345/p/3624177.html的红黑树的C代码，于是有了新的版本。

源码地址：https://download.csdn.net/download/seeker_zeroone/10743399

使用红黑树索引关键字的源代码：https://download.csdn.net/download/seeker_zeroone/10776229

命令节点结构体如下；

typedef		struct  fun_node
{
	struct  fun_node *pNext;
	const		char	*pHelp;
	const		char	*pName;
	uint8_t	 	paraNum;
	FUN_CMD_BK  RunFun;
	uint8_t	 	EnableState;
}ST_FUN_NODE;

typedef		enum
{
	emCmdDataType_Dec		=1,
	emCmdDataType_Hex		=2,
	emCmdDataType_Str		=3,
	emCmdDataType_IP		=4,
	emCmdDataType_MAC		=5,
	
}EM_CMD_DATA_TYPE;


typedef		struct   cmd_para
{
	struct   cmd_para  *pNext;	
	const	char  *pName;
	void	 	*pDataAddr;	
	uint16_t	dataLen;
	EM_CMD_DATA_TYPE  dataType;
	uint8_t	 EnableState;
}ST_CMD_PARA;


typedef		struct	cmd_node
{
	const	char 	*pKeyword;
	const	char   *pHelp;
	ST_CMD_PARA  *pData;
	ST_FUN_NODE	 *pFuntion;
	FUN_STOR_BK   StorageFun;
}ST_CMD_NODE;

 

参数注册配置实例：

void	 cla_parametersConfig(void)
{
		cla_init();
		cla_regsister("uuid","uuid <only read>");
		cla_addParameter("uuid","uuid ",(void *)&uuid,emCmdDataType_Str,		sizeof(uuid));

		cla_regsister("wifi","wifi or wifi ssid=xxx password=xxx");
		cla_addParameter("wifi","ssid",(void *)ssid,emCmdDataType_Str,			sizeof(ssid));
		cla_addParameter("wifi","password",(void *)password,emCmdDataType_Str,	sizeof(password));

		cla_regsister("hex","hex or hex hex8=xx hex16=xx hex32=xx");
		cla_addParameter("hex","hex8",(void *)&hex8,emCmdDataType_Hex,			sizeof(data8));
		cla_addParameter("hex","hex16",(void *)&hex16,emCmdDataType_Hex,		sizeof(data16));
		cla_addParameter("hex","hex32",(void *)&hex32,emCmdDataType_Hex,		sizeof(data32));
		
		cla_regsister("data","data or data data8=xx data16=xx data32=xx");
		cla_addParameter("data","data8",(void *)&data8,emCmdDataType_Dec,		sizeof(data8));
		cla_addParameter("data","data16",(void *)&data16,emCmdDataType_Dec,		sizeof(data16));
		cla_addParameter("data","data32",(void *)&data32,emCmdDataType_Dec,		sizeof(data32));

		cla_regsister("ipconfig","ipconfig or ipconfig ipaddr=192.168.1.1");
		cla_addParameter("ipconfig","ipaddr",(void *)IPaddr,emCmdDataType_IP,	sizeof(IPaddr));
		cla_addParameter("ipconfig","mask",(void *)maskIP,emCmdDataType_IP,		sizeof(maskIP));
		cla_addParameter("ipconfig","dns",(void *)dnsIP,emCmdDataType_IP,		sizeof(dnsIP));
		cla_addParameter("ipconfig","mac",(void *)Mac,emCmdDataType_MAC,		sizeof(Mac));

		cla_regsister("run","<funtions>");
		cla_addRunFun("run",ptest_3fun_help,"test",test_3fun,3);
		cla_addRunFun("run",ptest_2fun_help,"test2",test_2fun,2);
}

参数注册，需要先申请一个Node

BOOLEAN cla_regsister(const char *pKeyword,const char *pHelp)
{
		ST_CMD_NODE  *pNode=NULL;		
		pNode =cla_getFreeNode();
		if(pNode !=NULL)
		{
			pNode->pKeyword	=pKeyword;
			pNode->pHelp		=pHelp;
			pNode->pData		=NULL;
			pNode->pFuntion	=NULL;
			pNode->StorageFun	=NULL;
			return TRUE;
		}
		Debug("%s regsiter failed\n",pKeyword);
		return FALSE;
}

为Node添加参数描述信息，Node的关键字,参数名称，参数地址，参数类型，参数宽度

BOOLEAN		cla_addParameter(const char *pKey,const char *pName,void *pDataAddr,EM_CMD_DATA_TYPE dataType,uint16_t dataLen)
{
		ST_CMD_NODE  *pNode=NULL;
		ST_CMD_PARA  *pData=NULL;
		pNode =cla_getNodeOfKey(pKey);
		if(pNode!=NULL)
		{
				pData =cla_getFreePara();
				if(pData !=NULL)
				{
						pData->pName 		=pName;
						pData->pDataAddr	=pDataAddr;
						pData->dataType		=dataType;
						pData->dataLen		=dataLen;
						pData->pNext		=NULL;
						
						cla_setParamete(pNode,pData);
						return TRUE;
				}
		}
		Debug("%s no support\n",pKey);
		return FALSE;
}

为node节点添加命令函数描述信息，node的关键字，帮助信息，函数名称，函数回调地址，函数入口参数个数

BOOLEAN		cla_addRunFun(const char *pKey,const char *pHelp,const char *pFunName,FUN_CMD_BK funcb,uint8_t paraNum)
{
		ST_CMD_NODE  *pNode=NULL;
		ST_FUN_NODE  *pFun=NULL;
		pNode =cla_getNodeOfKey(pKey);
		if(pNode!=NULL)
		{
				pFun =cla_getFreeFunNode();
				if(pFun !=NULL)
				{
						pFun->pName		=pFunName;
						pFun->paraNum =paraNum;
						pFun->RunFun	=funcb;
						pFun->pHelp		=pHelp;
						pFun->pNext		=NULL;
						
						cla_setFuntion(pNode,pFun);
						return TRUE;
				}
		}
		Debug("%s no support\n",pKey);
		return FALSE;
}

根据命令参数，打印相关的变量


static	uint16_t  cla_sprintfPara(ST_CMD_PARA *pData,char *pbuff,uint16_t buffLen)
{
		uint32_t  value=0,tmpLen,totalLen=0,i;
		uint32_t	ipaddr[4],macAddr[6];
		while((pData !=NULL)&&(buffLen > 0))
		{
				switch(pData->dataType)
				{
						case emCmdDataType_Dec:
						{
									value =cla_getValueOfAddrType(pData->pDataAddr,pData->dataLen);
									snprintf(pbuff,buffLen,"%s=%d ",pData->pName,value);
						}break;
						
						case emCmdDataType_Hex:
						{
								value =cla_getValueOfAddrType(pData->pDataAddr,pData->dataLen);
								snprintf(pbuff,buffLen,"%s=0x%x  ",pData->pName,value);
						}break;
						
						case emCmdDataType_Str:
						{
								snprintf(pbuff,buffLen,"%s=%s  ",pData->pName,(const char *)pData->pDataAddr);	
						}break;
						
						case emCmdDataType_IP:
						{
								if(pData->dataLen >= 4)
								{
									for(i=0;i<4;i++)
									{
										ipaddr[i] =cla_getValueOfAddrType((void *)((uint8_t *)(pData->pDataAddr) + i), sizeof(uint8_t));
									}
									
									snprintf(pbuff,buffLen,"%s=%d.%d.%d.%d ",pData->pName,
																				ipaddr[0],ipaddr[1],ipaddr[2],ipaddr[3]);
								}

						}break;
								
						case emCmdDataType_MAC:
						{
								if(pData->dataLen >= 6)
								{
									for(i=0;i<6;i++)
									{
											macAddr[i] =cla_getValueOfAddrType((void *)((uint8_t *)(pData->pDataAddr) + i), sizeof(uint8_t));
									}									
									snprintf(pbuff,buffLen,"%s=%02X-%02X-%02X-%02X-%02X-%02X ",pData->pName,
																					macAddr[0],macAddr[1],macAddr[2],macAddr[3],macAddr[4],macAddr[5]);
								}								
						}break;
								
						default:
						break;
				}
				pData		=pData->pNext;
				tmpLen	=strlen((const char *)pbuff);
				pbuff		+=tmpLen;	
				totalLen +=tmpLen;
				buffLen	-=tmpLen;
		}
		strcpy(pbuff,"\r\n");
		return  (totalLen + 3);
}

查找命令，为变量赋值


static	BOOLEAN  cla_scanfPara(ST_CMD_PARA *pData,ST_CMD_STR *pParaIn)
{
		BOOLEAN	 res;
		uint16_t  i,k;
		uint32_t	value;
		static	uint8_t	nmeBuff[32],dataBuff[32],Offset=0,pos=0;
		ST_CMD_PARA *pStorData;
		for(i=pParaIn->argPos;i<pParaIn->argCount;i++)
		{
				memset(nmeBuff,0,sizeof(nmeBuff));
				memset(dataBuff,0,sizeof(dataBuff));
				res =cla_takeNameData(pParaIn->pArgValue[i],nmeBuff,dataBuff);
				if(res)
				{
						Debug("name->%s data->%s\n",nmeBuff,dataBuff);
						pStorData =cla_getParaOfName(pData,(const char *)nmeBuff);
						if(pStorData)
						{
									switch(pStorData->dataType)
									{
										case emCmdDataType_Dec:
										{
													value =cla_atoi(dataBuff,&Offset);
													cla_setValueOfAddrType(pStorData->pDataAddr,pStorData->dataLen,value);
													
										}break;
										
										case emCmdDataType_Hex:
										{
													value =cla_atohex(dataBuff,&Offset);
													//Debug("hex-->0x%02x",value);
													cla_setValueOfAddrType(pStorData->pDataAddr,pStorData->dataLen,value);
										}break;
										
										case emCmdDataType_Str:
										{
												strncpy((char *)pStorData->pDataAddr,(const char *)dataBuff,pStorData->dataLen);
										}break;
										
										case emCmdDataType_IP:
										{
												if(pStorData->dataLen >=4)
												{
														for(pos=0,Offset=0,k=0;k<4;k++)
														{
															pos +=Offset;
															value =cla_atoi(dataBuff + pos,&Offset);
															cla_setValueOfAddrType(((uint8_t *)(pStorData->pDataAddr) + k),1,value);
														}
												}

										}break;
												
										case emCmdDataType_MAC:
										{												
												if(pStorData->dataLen >=6)
												{
														for(pos=0,Offset=0,k=0;k<6;k++)
														{
															pos +=Offset;
															value =cla_atohex(dataBuff + pos,&Offset);
															//Debug("mac%d-->%02x",k,value);
															cla_setValueOfAddrType(((uint8_t *)(pStorData->pDataAddr) + k),1,value);
														}
												}
										}break;
										default:
										break;
								}
						}
						else
						{
								Debug("no support %s\n",nmeBuff);
						}
				}
				else
				{
						Debug("parameter err\n");
				}
		}
		return TRUE;
}


void	cla_precess(uint8_t *pCmd,uint16_t cmdLen,FUN_PRINT_OUT printFun)
{
	uint16_t	 i,outlen;
	FUN_STOR_BK		storageFun=NULL;
	BOOLEAN	 res;
	static	ST_CMD_STR		cmdStr;
	static	char	outBuff[OUT_BUFF_MAX_LEN];
	if((pCmd !=NULL)&&(cmdLen > 2))
	{
			cla_cmdMake(&cmdStr,pCmd,cmdLen);	
			if((cla_CheckIn(&cmdStr,printFun))&&(cmdStr.argCount >= 1))
			{
				for(i=0;i<CMD_NODE_TOTAL;i++)
				{
					 if(CmdNodeGroup[i].pKeyword != NULL)
					 {						
					 	  if(strcmp((const char *)CmdNodeGroup[i].pKeyword,cmdStr.pArgValue[0]) == 0)
							{
									if(cmdStr.argCount  == 1)//查询参数
									{
											outlen =cla_sprintfPara(CmdNodeGroup[i].pData,outBuff,OUT_BUFF_MAX_LEN);
											if(printFun !=NULL)
											{
												 printFun(outBuff,outlen);
											}
											Debug("out done\n");
									}
									else if(strcmp("run",cmdStr.pArgValue[0]) == 0)
									{
											cmdStr.argPos		=1;
											res	=cla_runFuntion(CmdNodeGroup[i].pFuntion,&cmdStr);
											Debug("run done\n");											
									}
									else 
									{
											cmdStr.argPos		=1;
											res	 =cla_scanfPara(CmdNodeGroup[i].pData,&cmdStr);
											if(res)
											{
													Debug("cfg done\n");
													storageFun =CmdNodeGroup[i].StorageFun;
													if(storageFun !=NULL)
													{
															storageFun();
													} 
											}											
									}
									return ;
							}
							else if(strcmp("help",cmdStr.pArgValue[0]) == 0)
							{
									cla_help(printFun,outBuff,OUT_BUFF_MAX_LEN);
									return ;
							}
					 }
				}
			}
	}	
}

命令行解析进程

1，cmdMake对输入的命令行，进行格式化匹配，并得到输入命令行参数个数

2，命令行账户校验

3，匹配关键字

4，命令行参数个数为1，表示查询

5，令行参数为多个，表示参数配置

6，run xxFun param1 param2 ..  表示运行xx函数，然后传递参数为param1..

 

muxi01lingyi
关注
  • 1
    点赞
  • 踩
  • 5
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
M5Stack(ESP32)学习笔记（2）——命令行
MICROAU的博客
06-01 3196
书接上回…… 把玩了一会儿M5Stack Fire，我觉得M5Stack挺不错的，可是为什么网上的相关文档和资料这么的少，是不是这玩意很小众？ 它也支持Arduino编程，但是好像和UIFlow不能共存。UIFlow可以在系统内装入若干程序，然后选择一个启动，还是挺好的。而且，UIFlow的后面是MicroPython，更易用。以前买过pyboard，所以也了解过MicroPython，只是没...
ESP32常用命令
Jaylen.sun的嵌入式之旅
01-16 1046
ESP32常用命令
ESP32-网络初探01——DNSServer（DNS服务）——CaptivePortal（自锁门户）
最新发布
2302_77357183的博客
06-29 115
1.WiFiServer对象，它在你的ESP32上创建了一个HTTP服务器。这个服务器监听80端口上的连接请求，当有客户端连接时，它会返回一个HTML页面。什么是DNS，FTP，HTTP，DHCP及用途_dns和ftp的名字以及作用-CSDN博客。并对域名为"*"（所有的DNS请求）返回接入点的IP地址。三个参数，分别是本地IP地址、网关IP地址和子网掩码。一、DNSServer(DNS服务器相关操作）启动了DNS服务器（域名解析协议）。二、WIFI(WIFI服务器相关).三、HTTP响应页面。
esp32 环境搭建常用指令
谢文浩博客
10-15 429
指令一： /usr/bin/python -m pip install --user -r /home/cuco/cuco_miio_platform/cuco_p6am_comm_plug/miio_esp32/esp-idf/requirements.txt 指令二： ./install.sh
ESP32-ESP-IDF-CMD编译烧写（自用）
weixin_38016446的博客
11-24 584
ESP32-CMD编译烧写
ESP32 Arduino编译 配合 外部文本编辑工具Source Insight 开发
sudaroot的博客
04-02 1792
由于Arduino不支持索引且查看不了包括的相关头文件内容，打码十分不方便。 所以使用Arduino作为编译器，启用外部文本编辑器打码，例如Source Insight。 首先打开Arduino ->> 文件 ->> 首选项 打开Source Insight，新建一个项目，把Arduino编译所用到的库到添加到Source Insight项...
命令行解析框架
10-25
ESP32 命令行解析框架是一种高效且灵活的工具，用于在基于 ESP32 的微控制器系统中处理用户输入的命令。该框架允许开发者创建自定义的命令，为 IoT（物联网）设备提供交互式控制接口。在本文中，我们将深入探讨 ESP...
Arduino 安装 ESP32 资源包
10-20
**Arduino安装ESP32资源包指南** 在进行物联网开发时，ESP32因其强大的功能和易用性，成为了许多开发者的选择。与Arduino IDE结合使用，可以让编程变得更加简单。本指南将详细阐述如何在Arduino 1.8.19环境下安装...
esp32-1.0.3.zip
12-25
ESP32开发通常依赖Espressif的ESP-IDF (Espressif IoT Development Framework)，它是一个完整的SDK，包含编译工具链、RTOS、驱动库、网络协议栈和应用程序框架。这个1.0.3版本可能包含对旧版本的改进，比如性能优化...
esp32-1.0.5.zip
12-25
ESP32是一款高性能、低功耗的微控制器，由Espressif Systems公司设计，主要应用于物联网（IoT）和可穿戴电子设备。该芯片集成了Wi-Fi和蓝牙（包括BLE，即蓝牙低功耗）功能，使其成为无线通信的理想选择。`esp32-...
esp32cam的图传
07-20
总结，ESP32-CAM的图传功能结合了强大的硬件和灵活的软件框架，使其在物联网、智能家居、监控等多个领域有着广泛的应用前景。开发者可以通过学习和实践，掌握ESP32-CAM的使用技巧，实现各种创新的项目。
乐鑫ESP32 AT指令集查询手册
01-23
乐鑫ESP32 AT指令集查询手册， 通过本手册可以实现通过主机端来对ESP32模块进行数据收发操作
关于ESP8266 DNS域名解析异常问题及其解决办法
07-13
最近公司的ESP8266网关在项目现场出现一个很奇怪的问题，偶尔会出现设备连接不上网络，没有数据上报到云端。由于项目是使用在一些高档豪宅上面，现场还在施工，网络也是临时搭建的，特别不稳定，经常出现一段时间没有网络，之前跑过几次现场，排查的问题都是没有网络，或者网速很差导致连接不上服务器，所以没有放在心上，但是由于有好几个设备间都是出现了手机连接路由器的网络上网不错，但是网关就是连接不上网，后台看不到数据（同事描述），负责测试的同事一直督促着说老板的玻璃心快碎了，快点解决，没办法，又戴上安全帽，去了一趟现场，查看了下log信息，傻眼了，做网关那么多年，第一次看到DNS解析的服务器IP都错误了，log如下:connected with 303303, channel 6（有所修改，删除了些没用的log）dhcp client start...ip:192.168.1.103,mask:255.255.255.0,gw:192.168.1.1portlen=4dns m2m ip=10.0.0.1new local port is 34182mqtt connect to ip10.0.0.
ESP_WiFiManager：这是具有后备Web配置门户的ESP32 ESP8266 WiFi连接管理器。 使用此库可配置ESP32，ESP8266模块的WiFi等。运行时的凭据。 您还可以指定静态DNS服务器，个性化主机名，固定或随机AP WiFi通道。 带有支持ArduinoJson 6.0.0+和5.13.5-的示例
02-02
ESP_WiFiManager：这是具有后备Web配置门户的ESP32 ESP8266 WiFi连接管理器。 使用此库可配置ESP32，ESP8266模块的WiFi等。运行时的凭据。 您还可以指定静态DNS服务器，个性化主机名，固定或随机AP WiFi通道。 带有支持ArduinoJson 6.0.0+和5.13.5-的示例
ESP32学习笔记（三）sprintf()异常反复重启问题的解决
无线智能模块 可视DIY智能专家
06-06 3082
在开发ESP8266的时候，没发现此问题，在调试ESP32的时候发现反复重启。问题出现在sprintf中 举例划重点： char *s1 = “JIUAI.LTD”; char s2[] = “JIUAI.LTD”; char *s1 的s1，而指针是指向一块内存区域，它指向的内存区域的大小可以随时改变，而且当指针指向常量字符串时，它的内容是不可以被修改的，否则在运行时会报错。 char s2[]的s2 是数组对应着一块内存区域，其地址和容量在生命期里不会改变，只有数组的内容可以改变 修改之前： cha
ESP32——ESP-IDF命令
tsliuch的专栏
10-12 660
可以在Vscode所安装插件中查看ESP-IDF相关命令 常用命令如下： Show Examples Projects 显示官方示例项目 New Project 新建项目 Add Arduino ESP32 as ESP-IDF Component Create project from extension template Create new ESP-IDF Component ...
乐鑫Esp32学习之旅13 esp32 内置 dns 服务器，无需外网访问域名返回指定网页。（附带Demo）
徐宏的博客 | 修身齐家治国平天下
10-30 8982
内置dns服务器，无需外网即可访问指定域名返回网页！
ESP32超详细学习记录：wifi配网，AP配网，浏览器配网，无线配网
热门推荐
知寒
05-10 3万+
ESP32配网，wifi配网模式，可清除以前配网信息。移植方便！可改改函数用于无线调参。
ESP32json解析
10-15
在ESP32中，可以使用ArduinoJson库来解析JSON数据。以下是一个简单的ESP32解析JSON数据的示例代码： ```c++ #include void setup() { Serial.begin(115200); while (!Serial); // JSON数据 const char* json...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值