ash-panel: 一个小巧的命令终端下的交互式控制面板，可将键盘按键、命令输入与用户的处理函数进行绑定，适用于各种工程类（特别是机器人相关）项目调试、控制。

# ash panel
## 简介
		ash panel是一个非常小巧轻量级的终端窗口“控制面板”，可以读取用户的键盘输入字符串以及按键事件，并运行相关处理函数，非常适用于程序交互性调试。

在很多项目例如机器人项目开发中，我们往往需要发送命令控制机器人，然而在前期项目开发中可能没太多时间去专门开发和设计一个控制界面，或则完全没必要“小题大做“，很多时候我们只需要使用键盘做为控制设备，实现按几个按键或输入几条命令来完成机器人控制即可，ash panel就能够满足项目初期、简易场景下的命令输入与控制功能。

## 使用

### 项目代码

我将ash panel项目代码托管到码云了，下载代码

```shell
git clone https://gitee.com/xueyk-tutorials/ash-panel.git
```

代码包括了ash panel的具体实现以及一个示例。

- ash_panel文件夹：ash panel的具体实现；
- example文件夹：示例代码。

ash panel对外提供了如下函数接口：

- ash_init()：ash初始化函数；

- export_key_bind(char key, func_key fun)：绑定一个键盘按键与一个回调处理函数，那么程序执行过程中，键盘按键被按下后，执行指定的处理函数；

- export_cmd_bind(std::string cmd, func_cmd fun)：绑定一个字符串命令与一个回调处理函数，通过键盘输入该字符串命令后，执行指定的处理函数；

- ash_spin_once()：运行一次，检测用户输入，触发响应的回调处理函数。

**需要注意，只有按回车后才能输入字符串命令，如果没有按回车，则键盘输入被做为按键操作。**

### 示例

1. 首先第一步下载项目代码。

2. 构建

```shell
   $ cd ash-panel
   $ cmake -Bbuild .
   $ cmake --build build
   ```

3. 运行

```shell
   $ ./build/examples/example
   ```

通过按WSAD键实现移动，通过输入`start`实现启动。可以根据实际需求添加键盘控制和命令输入控制。

无烬/ash-panel

简介

发行版

贡献者

近期动态

无烬/ash-panel .gitee-modal { width: 500px !important; }

简介

发行版

贡献者

近期动态

搜索帮助

无烬/ash-panel