天天看点

STM32HAL 移植cmd-parser(新增哈希算法)解析器开源库(裸机开发)概述

概述

     cmd-parser是一个资源占用极小的命令解析器,并遵循  Apache License v2.0 开源协议。

GitHub:https://github.com/jiejieTop/cmd-parser

优点:

  • 用户无需关心命令的存储区域与大小,由编译器静态分配。
  • 加入哈希算法超快速匹配命令,时间复杂度从O(n*m)变为O(n)。
  • 命令支持忽略大小写。
  • 非常易用与非常简洁的代码(不足150行)。

硬件:STM32F103CBT6最小系统板

软件:Keil 5.29  + STM32CubeMX6.01

STM32HAL 移植cmd-parser(新增哈希算法)解析器开源库(裸机开发)概述

一、使用方法

  1. 注册命令

在工程中的任意位置均可调用(在函数外)

REGISTER_CMD(test1, test1_cmd);
           
  1. cmd初始化
cmd_init();
           
  1. 解析命令
cmd_parsing("test1");
           

特色

  • 用户无需关心命令的存储区域与大小,由编译器静态分配。
  • 加入哈希算法超快速匹配命令,时间复杂度从O(n*m)变为O(n)。
  • 命令支持忽略大小写。
  • 非常易用与非常简洁的代码(不足150行)。

注意事项

  • 本代码目前只支持

    MDK

    IAR

    的编译器,对于

    gcc

    尚未移植,欢迎参与贡献

test.c

#include "cmd.h"

void test1_cmd(void)
{
    printf("test1_cmd\n");
}

void test2_cmd(void)
{
    printf("test2_cmd\n");
}

void test3_cmd(void)
{
    printf("test3_cmd\n");
}

REGISTER_CMD(test1, test1_cmd);
REGISTER_CMD(test2, test2_cmd);
REGISTER_CMD(test3, test3_cmd);

int main(void)
{
    cmd_init();

    while (1)
    {
        cmd_parsing("test1");
        cmd_parsing("test2");
        cmd_parsing("test3");
    }
    
    return 0;
}
           

二、STM32CubeMx配置

STM32HAL 移植cmd-parser(新增哈希算法)解析器开源库(裸机开发)概述
STM32HAL 移植cmd-parser(新增哈希算法)解析器开源库(裸机开发)概述

三、Examples

1、进入GitHub拉取源码

STM32HAL 移植cmd-parser(新增哈希算法)解析器开源库(裸机开发)概述

2、打开STM32CubeMx生成的keil工程,新建bsp文件夹,按照如下步骤进行。

STM32HAL 移植cmd-parser(新增哈希算法)解析器开源库(裸机开发)概述

3、把所有.c文件添加到Keil中来。

STM32HAL 移植cmd-parser(新增哈希算法)解析器开源库(裸机开发)概述

4、添加头文件路径

STM32HAL 移植cmd-parser(新增哈希算法)解析器开源库(裸机开发)概述

5、编译工程

STM32HAL 移植cmd-parser(新增哈希算法)解析器开源库(裸机开发)概述

6、解决报错问题

STM32HAL 移植cmd-parser(新增哈希算法)解析器开源库(裸机开发)概述

7、main.c文件

/* USER CODE BEGIN Header */
/**
  ******************************************************************************
  * @file           : main.c
  * @brief          : Main program body
  ******************************************************************************
  * @attention
  *
  * <h2><center>&copy; Copyright (c) 2021 STMicroelectronics.
  * All rights reserved.</center></h2>
  *
  * This software component is licensed by ST under BSD 3-Clause license,
  * the "License"; You may not use this file except in compliance with the
  * License. You may obtain a copy of the License at:
  *                        opensource.org/licenses/BSD-3-Clause
  *
  ******************************************************************************
  */
/* USER CODE END Header */
/* Includes ------------------------------------------------------------------*/
#include "main.h"
#include "usart.h"
#include "gpio.h"

/* Private includes ----------------------------------------------------------*/
/* USER CODE BEGIN Includes */
#include "stdio.h"
#include "cmd.h"
/* USER CODE END Includes */

/* Private typedef -----------------------------------------------------------*/
/* USER CODE BEGIN PTD */

/* USER CODE END PTD */

/* Private define ------------------------------------------------------------*/
/* USER CODE BEGIN PD */
/* USER CODE END PD */

/* Private macro -------------------------------------------------------------*/
/* USER CODE BEGIN PM */
#define ENABLE		0
/* USER CODE END PM */

/* Private variables ---------------------------------------------------------*/

/* USER CODE BEGIN PV */
#if ENABLE
	
#else

#define BUFSIZE  6
char recv_buf[BUFSIZE] = {0};

#endif
/* USER CODE END PV */

/* Private function prototypes -----------------------------------------------*/
void SystemClock_Config(void);
/* USER CODE BEGIN PFP */

/* USER CODE END PFP */

/* Private user code ---------------------------------------------------------*/
/* USER CODE BEGIN 0 */

#if ENABLE
	
void test1_cmd(void)
{
    printf("test1_cmd\n");
}

void test2_cmd(void)
{
    printf("test2_cmd\n");
}

void test3_cmd(void)
{
    printf("test3_cmd\n");
}

REGISTER_CMD(test1, test1_cmd,test1 demo);
REGISTER_CMD(test2, test2_cmd,test2 demo);
REGISTER_CMD(test3, test3_cmd,test3 demo);


#else

void led_on_cmd(void)
{
		HAL_GPIO_WritePin(LED_GPIO_Port, LED_Pin, GPIO_PIN_RESET);
    printf("led on!\n");
}
void led_off_cmd(void)
{
	  HAL_GPIO_WritePin(LED_GPIO_Port, LED_Pin, GPIO_PIN_SET);
    printf("led off!\n");
}

REGISTER_CMD(ledonn, led_on_cmd, null);
REGISTER_CMD(ledoff, led_off_cmd, null);
#endif
/* USER CODE END 0 */

/**
  * @brief  The application entry point.
  * @retval int
  */
int main(void)
{
  /* USER CODE BEGIN 1 */

  /* USER CODE END 1 */

  /* MCU Configuration--------------------------------------------------------*/

  /* Reset of all peripherals, Initializes the Flash interface and the Systick. */
  HAL_Init();

  /* USER CODE BEGIN Init */

  /* USER CODE END Init */

  /* Configure the system clock */
  SystemClock_Config();

  /* USER CODE BEGIN SysInit */

  /* USER CODE END SysInit */

  /* Initialize all configured peripherals */
  MX_GPIO_Init();
  MX_USART1_UART_Init();
  /* USER CODE BEGIN 2 */
	printf("cmd parser testing...\r\n");
	
#if ENABLE
	cmd_init();
#else	
	cmd_init();
	HAL_UART_Receive_IT(&huart1, (uint8_t*)recv_buf, BUFSIZE);
#endif	
	
  /* USER CODE END 2 */

  /* Infinite loop */
  /* USER CODE BEGIN WHILE */
  while (1)
  {
#if ENABLE		
			cmd_parsing("_list");
			cmd_parsing("test1");
			cmd_parsing("test2");
			cmd_parsing("test3");
			HAL_Delay(1000);
#endif		
    /* USER CODE END WHILE */

    /* USER CODE BEGIN 3 */
  }
  /* USER CODE END 3 */
}

/**
  * @brief System Clock Configuration
  * @retval None
  */
void SystemClock_Config(void)
{
  RCC_OscInitTypeDef RCC_OscInitStruct = {0};
  RCC_ClkInitTypeDef RCC_ClkInitStruct = {0};

  /** Initializes the RCC Oscillators according to the specified parameters
  * in the RCC_OscInitTypeDef structure.
  */
  RCC_OscInitStruct.OscillatorType = RCC_OSCILLATORTYPE_HSE;
  RCC_OscInitStruct.HSEState = RCC_HSE_ON;
  RCC_OscInitStruct.HSEPredivValue = RCC_HSE_PREDIV_DIV1;
  RCC_OscInitStruct.HSIState = RCC_HSI_ON;
  RCC_OscInitStruct.PLL.PLLState = RCC_PLL_ON;
  RCC_OscInitStruct.PLL.PLLSource = RCC_PLLSOURCE_HSE;
  RCC_OscInitStruct.PLL.PLLMUL = RCC_PLL_MUL9;
  if (HAL_RCC_OscConfig(&RCC_OscInitStruct) != HAL_OK)
  {
    Error_Handler();
  }
  /** Initializes the CPU, AHB and APB buses clocks
  */
  RCC_ClkInitStruct.ClockType = RCC_CLOCKTYPE_HCLK|RCC_CLOCKTYPE_SYSCLK
                              |RCC_CLOCKTYPE_PCLK1|RCC_CLOCKTYPE_PCLK2;
  RCC_ClkInitStruct.SYSCLKSource = RCC_SYSCLKSOURCE_PLLCLK;
  RCC_ClkInitStruct.AHBCLKDivider = RCC_SYSCLK_DIV1;
  RCC_ClkInitStruct.APB1CLKDivider = RCC_HCLK_DIV2;
  RCC_ClkInitStruct.APB2CLKDivider = RCC_HCLK_DIV1;

  if (HAL_RCC_ClockConfig(&RCC_ClkInitStruct, FLASH_LATENCY_2) != HAL_OK)
  {
    Error_Handler();
  }
}

/* USER CODE BEGIN 4 */

#if ENABLE

#else	
/* 中断回调函数 */
void HAL_UART_RxCpltCallback(UART_HandleTypeDef *huart)
{
    /* 判断是哪个串口触发的中断 */
    if(huart ->Instance == USART1)
    {
				//解析数据
				cmd_parsing((char*)recv_buf);
		
        //重新使能串口接收中断
        HAL_UART_Receive_IT(huart, (uint8_t*)recv_buf, BUFSIZE);
    }
}
#endif	

#ifdef __GNUC__
  /* With GCC/RAISONANCE, small printf (option LD Linker->Libraries->Small printf
     set to 'Yes') calls __io_putchar() */
  #define PUTCHAR_PROTOTYPE int __io_putchar(int ch)
#else
  #define PUTCHAR_PROTOTYPE int fputc(int ch, FILE *f)
#endif /* __GNUC__ */
/**
  * @brief  Retargets the C library printf function to the USART.
  * @param  None
  * @retval None
  */
PUTCHAR_PROTOTYPE
{
  /* Place your implementation of fputc here */
  /* e.g. write a character to the EVAL_COM1 and Loop until the end of transmission */
  HAL_UART_Transmit(&huart1, (uint8_t *)&ch, 1, 0xFFFF);
 
  return ch;
}
 
int fgetc(FILE * f)
{
  uint8_t ch = 0;
  HAL_UART_Receive(&huart1, (uint8_t *)&ch, 1, 0xffff);
  return ch;
}
/* USER CODE END 4 */

/**
  * @brief  This function is executed in case of error occurrence.
  * @retval None
  */
void Error_Handler(void)
{
  /* USER CODE BEGIN Error_Handler_Debug */
  /* User can add his own implementation to report the HAL error return state */
  __disable_irq();
  while (1)
  {
  }
  /* USER CODE END Error_Handler_Debug */
}

#ifdef  USE_FULL_ASSERT
/**
  * @brief  Reports the name of the source file and the source line number
  *         where the assert_param error has occurred.
  * @param  file: pointer to the source file name
  * @param  line: assert_param error line source number
  * @retval None
  */
void assert_failed(uint8_t *file, uint32_t line)
{
  /* USER CODE BEGIN 6 */
  /* User can add his own implementation to report the file name and line number,
     ex: printf("Wrong parameters value: file %s on line %d\r\n", file, line) */
  /* USER CODE END 6 */
}
#endif /* USE_FULL_ASSERT */

/************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/
           

四、运行结果

STM32HAL 移植cmd-parser(新增哈希算法)解析器开源库(裸机开发)概述
STM32HAL 移植cmd-parser(新增哈希算法)解析器开源库(裸机开发)概述
STM32HAL 移植cmd-parser(新增哈希算法)解析器开源库(裸机开发)概述

传送门->代码

参考文章:https://blog.csdn.net/Mculover666/article/details/106102372

五、总结

    好了,就介绍到此,有了这个神器,特别适合Hash算法开发产品使用和一些自定义命令解析场景。

继续阅读