* # nr_micro_shell

  ## 介绍

  在进行调试和维护时，常常需要与单片机进行交互，获取、设置某些参数或执行某些操作，**nr_micro_shell**正是为满足这一需求，针对资源较少的MCU编写的基本命令行工具。虽然RT_Thread组件中已经提供了强大的**finsh**命令行交互工具，但对于ROM、RAM资源较少的单片机，**finsh**还是略显的庞大，在这些平台上，若仍想保留基本的命令行交互功能，**nr_micro_shell**是一个不错的选择。

  **nr_micro_shell**具有以下优点

  1.占用资源少，使用简单，灵活方便。使用过程只涉及两个shell_init()和shell()两个函数，无论是使用RTOS还是裸机都可以方便的应用该工具，不需要额外的编码工作。

  2.交互体验好。完全类似于linux shell命令行，当串口终端支持ANSI（如Hypertrm终端）时，其不仅支持基本的命令行交互，还提供Tab键命令补全，查询历史命令，方向键移动光标修改功能。

  3.扩展性好。**nr_micro_shell**为用户提供自定义命令的标准函数原型，只需要按照命令编写命令函数，并注册命令函数，即可使用命令。

  ## 移植:

  参考AIR101

  ## 配置:

  所有配置工作都可以在 **_nr_micro_shell_config.h_** 中完成。有关详细信息，请参见文件中的注释。

  ## 用法:

  - 确保所有文件都已添加到项目中。

  - 确保 **_nr_micro_shell_config.h_** 中的宏函数"shell_printf()，ansi_show_char()"可以在项目中正常使用。

  - 使用示例如下

  ```c
  #include "nr_micro_shell.h"
  
  int main(void)
  {
      /* 初始化 */
      shell_init();
  
      while(1)
      {
          if(USART GET A CHAR 'c')
          {
              /* nr_micro_shell接收字符 */
              shell(c);
          }
      }
  }
  ```

  建议直接使用硬件输入前，建议使用如下代码(确保可以正常打印信息)，验证nr_micro_shell是否可以正常运行

  ```c
  #include "nr_micro_shell.h"
  
  int main(void)
  {
      unsigned int i = 0;
      //匹配好结束符配置 NR_SHELL_END_OF_LINE 0
      char test_line[] = "test 1 2 3\n"
      /* 初始化 */
      shell_init();
      
      /* 初步测试代码 */
      for(i = 0; i < sizeof(test_line)-1; i++)
      {
          shell(test_line[i]);
      }
  
      /* 正式工作代码 */
      while(1)
      {
          if(USART GET A CHAR 'c')
          {
              /* nr_micro_shell接收字符 */
              shell(c);
          }
      }
  }
  ```

  ## 添加自己的命令

  **STEP1**:

  您需要在**nr_micro_shell_commands.c***中实现一个命令函数。命令函数的原型如下

  ```c
  void your_command_funtion(char argc, char *argv)
  {
      .....
  }
  ```

  **argc**是参数的数目。**argv**存储每个参数的起始地址和内容。如果输入字符串是

  ```c
  test -a 1
  ```

  则**argc**为3，**argv**的内容为

  ```c
  -------------------------------------------------------------
  0x03|0x08|0x0b|'t'|'e'|'s'|'t'|'\0'|'-'|'a'|'\0'|'1'|'\0'|
  -------------------------------------------------------------
  ```

  如果想知道第一个或第二个参数的内容，应该使用

  ```c
  /* "-a" */
  printf(argv[argv[1]])
  /* "1" */
  printf(argv[argv[2]])
  ```

  **STEP2**:
  在使用命令前需要注册命令，共有两种方法注册命令

  1.当配置文件中NR_SHELL_USING_EXPORT_CMD未被定义，在**static_cmd[]**表中写入

  ```c
  const static_cmd_st static_cmd[] =
  {
     .....
     {"your_command_name",your_command_funtion},
     .....
     {"\0",NULL}
  };
  ```

  **_注意：不要删除{"\0"，NULL}！_**

  2.当配置文件中NR_SHELL_USING_EXPORT_CMD被定义，且NR_SHELL_CMD_EXPORT()支持使用的编译器时，可以使用以下方式注册命令

  ```c
  NR_SHELL_CMD_EXPORT(your_command_name,your_command_funtion);
  ```

  ## 注意事项

  根据你的使用习惯使用NR_SHELL_USING_EXPORT_CMD选择命令注册方式。

  使用注册表注册命令时，确保您的工程中存在注册表

  ```c
  const static_cmd_st static_cmd[] ={   .....   {"\0",NULL}};
  ```

  使用NR_SHELL_CMD_EXPORT()时确保，NR_SHELL_CMD_EXPORT()支持使用的编译器，否则会报错。

  nr_micro_shell 不支持ESC键等控制键（控制符）。

  ## 原地址连接

  - 主页： <https://gitee.com/nrush/nr_micro_shell>