创建自己的微控制器的命令提示符

动机

最近我为CYD-Klipper固件做了一个贡献，以支持crowpanel 2.8英寸显示器。

在浏览存储库并了解固件是如何实现的过程中，我遇到了一个名为serial_console.cpp的模块。在这个模块中，作者直接通过串口实现了一个类似终端的功能。这样做的目的是在运行时更改设备配置，而不需要重新构建代码和重新刷新MCU。

此外，用户可以向serial_console添加更多命令，这些命令可以接受参数以进一步增强控制台的功能。这个实现感觉非常有趣和酷，所以我决定创建我自己的串行提示符。

目标

我希望基于以下目标和约束去开发这个项目：

它应该在一个头文件中用C语言完全开发。

我应该能够在我的Linux机器上测试提示符，而不需要不断地将代码flash和构建到MCU。

它应该可移植到各种mcu，如ESP32， STM和Raspberry Pi Pico(我主要使用)。

最后，串行控制台提示符应该是这样的：

设计

For -它应该在一个头文件中使用C语言完全开发。

为此，我将使serial_prompt.h和main.c下的所有逻辑都包括此头以使用串行提示符。

For -我应该能够在我的Linux机器上测试提示，而不需要连续地将构建flash到MCU。

为了在我的终端中模拟mcu串行控制台，我需要对我的linux终端执行一些手动配置。

这部分代码将终端输入模式从默认的行缓冲模式(只在按Enter键后处理输入)切换到原始模式，在这种模式下，每次按下键都可以立即对程序可用。它还禁用输入字符的回显。

恢复终端的先前状态。

如果按CTRL+C退出代码，还需要恢复终端的先前状态。

以及主要功能。

“它应该可以在各种mcu上移植，比如ESP32， STM和Raspberry Pi Pico(主要是我使用的)”

为了使其在各种目标之间可移植，我让用户基于该板所支持的API定义PRINT和READ宏。如

注意：我没有尝试使用EspIDF，因为我一直在esp32上使用Arduino框架。

用法

在项目中包含serial_prompt.h头文件以使用它。

步骤1：替换串行打印/写入功能，这里我以Arduino框架为例。

对于raspberry pi pico，使用rasspberry_pico_main.c

步骤2：包含标题

步骤3：注意：命令处理程序应该有**int (int argc, char argv)定义。

步骤4：将命令名称及其处理程序添加到命令数组中

步骤5：定期打电话

步骤6：将固件Flash到设备上，如下所示

如果您输入“?”，您应该看到可用的cmd列表

步骤7：对于带有参数的命令，例如：

输出

初始化:

•当系统启动时，执行setup()函数。

•调用serial_greet()函数，向用户显示问候消息：“Hello from Serial Prompt\nType '? ”“寻求帮助\n>”。

命令输入:

•程序进入loop()函数，其中反复调用serial_run()。

•在serial_run()中，程序通过串行连接等待用户输入，捕捉字符，直到接收到换行符(\n)。

分词输入:

•使用tokenize()将输入标记为单个单词(例如命令及其参数)。

•假定第一个令牌是命令(例如，help)。

命令查找:

•find()函数被调用来检查命令是否存在于commands[]数组中。

•如果找到该命令，则调用相应的处理函数(如help())。

•如果命令未知，则打印“unknown command”错误信息。

命令执行:

•在这种情况下，如果用户输入help，则执行help()处理程序，打印可用命令的描述：

提示下一个输入：

•命令执行后，终端再次显示提示符(>)，等待用户的下一个输入。

重复一遍:

•循环继续，处理用户输入的进一步命令，调用适当的处理程序，并显示结果，直到系统关闭或重置。

本文编译自hackster.io