From cbae58d060c50d7031964a08d96c723982e9e18e Mon Sep 17 00:00:00 2001 From: "const_zpc@163.com" Date: Sun, 18 Jun 2023 00:41:05 +0800 Subject: [PATCH] =?UTF-8?q?=F0=9F=93=83=20docs:=20=E6=9B=B4=E6=96=B0README?= =?UTF-8?q?.md=E6=96=87=E6=A1=A3?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 142 ++++++++++++++++++++++++++++++++++++++++++++---------- 1 file changed, 116 insertions(+), 26 deletions(-) diff --git a/README.md b/README.md index 725c179..88d20ee 100644 --- a/README.md +++ b/README.md @@ -1,23 +1,28 @@ # 轻量级参数管理框架(C语言) ## 介绍 -1. 采用表驱动方式统一管理所有参数，包括缺省值、最小值和最大值等 - > - 支持定义普通参数，无缺省值、最小值和最大值限制 - > - 支持定义普通参数，有缺省值，但无最小值和最大值限制 - > - 支持定义普通参数，有缺省值，最小值和最大值限制 -2. 采用宏定义快速注册和添加参数进行管理 +1. 采用表驱动方式统一管理所有参数，包括缺省值、最小值和最大值等 -3. 支持基本类型参数和字符串参数 + > - 支持定义普通参数，无缺省值、最小值和最大值限制 + > - 支持定义普通参数，有缺省值，但无最小值和最大值限制 + > - 支持定义普通参数，有缺省值，最小值和最大值限制 + > +2. 采用宏定义快速对参数进行定义、注册和管理 +3. 支持基本类型参数和字符串参数 +4. 支持序列化和反序列化操作，可在本地储存设备保存/读取二进制数据 -4. 支持序列化和反序列化操作，可在本地储存设备保存/读取二进制数据 - > - 支持键值对的方式储存，即使后期版本迭代对参数表删除/插入数据时也能向下兼容 - > - 支持非键值对的方式储存，适合小容量的储存设备，序列化后的数据内容少，但是后期版本迭代对参数表删除或插入数据时不能向下兼容，只有通过在参数表后添加参数才能向下兼容 - > - 通过多次读写储存设备分别加载参数和保存参数，更兼容小内存的平台使用 - > - 支持在数据加载或保存时当参数当前值不合法（超出范围）触发错误处理回调函数，有上层应用程序决定如何处理（可以恢复默认值） + > - 支持键值对的方式储存，即使后期版本迭代对参数表删除/插入数据时也能向下兼容 + > - 支持非键值对的方式储存，适合小容量的储存设备，序列化后的数据内容少，但是后期版本迭代对参数表删除或插入数据时不能向下兼容，只有通过在参数表后添加参数才能向下兼容 + > - 通过多次读写储存设备分别加载参数和保存参数，更兼容小内存的平台使用（多次调用回调函数处理） + > - 支持在数据加载或保存时当参数当前值不合法（超出范围）触发错误处理回调函数，有上层应用程序决定如何处理（可以恢复默认值） + > +5. 支持功能配置裁剪 -5. 支持功能配置裁剪 - > - 根据不同的平台，可以对部分功能裁剪，或者修改配置适用于不同容量的芯片开发 + > - 根据不同的平台，可以对部分功能裁剪，或者修改配置适用于不同容量的芯片开发 + > - 键值对的方式储存：向下兼容较好 + > - 可以选择只支持基本类型的参数储存功能，如字符串类型参数和64位长度的参数可裁剪 + > ## 软件架构 @@ -26,6 +31,7 @@ 定义参数表 ```c + PARAM_DEFINE_DAT (g_test, PARAM_INT16, 10); PARAM_DEFINE_DAT_DEF (g_test_2, PARAM_UINT16, 20); PARAM_DEFINE_DAT_RANGE (g_test_3, PARAM_DOUBLE, 3.15, -10, 10); @@ -36,18 +42,100 @@ PARAM_DEFINE_DAT_RANGE (g_test_6, PARAM_UINT8, 45, 5, 100); PARAM_DEFINE_DAT_RANGE (g_test_7, PARAM_INT64, 5, -542, 5450); ParamInfo_t sg_ParamTable[] = { - PARAM_ITEM_DAT(1, g_test, PARAM_ATTR_READ | PARAM_ATTR_WRITE), - PARAM_ITEM_DAT_DEF(2, g_test_2, PARAM_ATTR_READ), - PARAM_ITEM_DAT_RANGE(3, g_test_3, PARAM_ATTR_READ | PARAM_ATTR_WRITE), - PARAM_ITEM_STR_RANGE(4, g_test_str, PARAM_ATTR_READ | PARAM_ATTR_WRITE), - PARAM_ITEM_DAT_RANGE(5, g_test_4, PARAM_ATTR_READ), - PARAM_ITEM_DAT_RANGE(6, g_test_5, PARAM_ATTR_READ), - PARAM_ITEM_DAT_RANGE(7, g_test_6, PARAM_ATTR_READ), - PARAM_ITEM_DAT_RANGE(8, g_test_7, PARAM_ATTR_READ | PARAM_ATTR_WRITE), + PARAM_ITEM_DAT(1, g_test, PARAM_ATTR_WR), + PARAM_ITEM_DAT_DEF(2, g_test_2, PARAM_ATTR_WR), + PARAM_ITEM_DAT_RANGE(3, g_test_3, PARAM_ATTR_WR), + PARAM_ITEM_STR_RANGE(4, g_test_str, PARAM_ATTR_WR), + PARAM_ITEM_DAT_RANGE(5, g_test_4, PARAM_ATTR_WR), + PARAM_ITEM_DAT_RANGE(6, g_test_5, PARAM_ATTR_WR), + PARAM_ITEM_DAT_RANGE(7, g_test_6, PARAM_ATTR_WR), + PARAM_ITEM_DAT_RANGE(8, g_test_7, PARAM_ATTR_READ), // 只读 }; + ``` -Demo 的结果展示（具体编译demo后使用） +通过宏去操作参数示例片段代码 + +```c +// 首先需要在头文件声明 +PARAM_EXTERN_DAT(g_test, PARAM_INT16); +PARAM_EXTERN_DAT(g_test_2, PARAM_UINT16); +PARAM_EXTERN_DAT(g_test_3, PARAM_DOUBLE); +PARAM_EXTERN_STR(g_test_str, 10); +PARAM_EXTERN_DAT(g_test_4, PARAM_INT8); +PARAM_EXTERN_DAT(g_test_5, PARAM_UINT32); +PARAM_EXTERN_DAT(g_test_6, PARAM_UINT8); +PARAM_EXTERN_DAT(g_test_7, PARAM_INT64); + + +//函数中使用 +int main() +{ +//方法一： + // 对参数g_test_6设置新的值50，如果超出限定范围则不处理 + PARAM_DAT_SET_NEW_VALUE(g_test_6, 50, PARAM_NONE); + + // 对参数g_test_6设置新的值50，如果超出限定范围则重置为默认值 + PARAM_DAT_SET_NEW_VALUE(g_test_6, 50, PARAM_DEF); + + // 对参数g_test_6设置新的值150，如果超出限定范围则参数小于最小值则为最小值, 参数大于最大值则为最大值 + PARAM_DAT_SET_NEW_VALUE(g_test_6, 150, PARAM_MIN_MAX); + + +//方法二： + // 对参数g_test_6设置新的值50，如果超出限定范围则不处理 + g_test_6 = 50; + PARAM_DAT_CHECK_RANGE(g_test_6, PARAM_NONE); + + // 对参数g_test_6设置新的值50，如果超出限定范围则重置为默认值 + g_test_6 = 50; + PARAM_DAT_CHECK_RANGE(g_test_6, PARAM_DEF); + + // 对参数g_test_6设置新的值150，如果超出限定范围则参数小于最小值则为最小值, 参数大于最大值则为最大值 + g_test_6 = 150; + PARAM_DAT_CHECK_RANGE(g_test_6, PARAM_MIN_MAX); +} +``` + +通过函数去操作参数示例片段代码 + +```c +//函数中使用 +int main() +{ + PARAM_UINT16_T tmp; + +//方法一： + // 对参数g_test_6设置新的值50，如果超出限定范围则不处理 + tmp = 50; + Param_SetNewValue(Param_FindParamByParamPtr(&sg_tParamManager, &g_test_u16), &tmp, PARAM_NONE); + + // 对参数g_test_6设置新的值50，如果超出限定范围则重置为默认值 + tmp = 50; + Param_SetNewValue(Param_FindParamByParamPtr(&sg_tParamManager, &g_test_u16), &tmp, PARAM_DEF); + + // 对参数g_test_6设置新的值150，如果超出限定范围则参数小于最小值则为最小值, 参数大于最大值则为最大值 + tmp = 150; + Param_SetNewValue(Param_FindParamByParamPtr(&sg_tParamManager, &g_test_u16), &tmp, PARAM_MIN_MAX); + + +//方法二： + // 对参数g_test_6设置新的值50，如果超出限定范围则不处理 + g_test_6 = 50; + Param_CheckRange(Param_FindParamByParamPtr(&sg_tParamManager, &g_test_u16), PARAM_NONE); + + // 对参数g_test_6设置新的值50，如果超出限定范围则重置为默认值 + g_test_6 = 50; + Param_CheckRange(Param_FindParamByParamPtr(&sg_tParamManager, &g_test_u16), PARAM_DEF); + + // 对参数g_test_6设置新的值150，如果超出限定范围则参数小于最小值则为最小值, 参数大于最大值则为最大值 + g_test_6 = 150; + Param_CheckRange(Param_FindParamByParamPtr(&sg_tParamManager, &g_test_u16), PARAM_MIN_MAX); +} +``` + +序列化 Demo 的结果展示 + ```base # 配置最多支持 15 个参数时加载参数时分多次读取/保存操作打印日志 load param： @@ -78,13 +166,15 @@ save param： ``` ## demo样式 + 博客： [轻量级参数管理框架（C语言）](https://blog.csdn.net/qq_24130227/article/details/129233836?spm=1001.2014.3001.5501) ## 关于作者 -1. CSDN 博客 [大橙子疯](https://blog.csdn.net/qq_24130227?spm=1010.2135.3001.5343) -2. 联系邮箱 const_zpc@163.com -3. 了解更多可关注微信公众号 -![大橙子疯嵌入式](微信公众号.jpg) \ No newline at end of file +1. CSDN 博客 [大橙子疯](https://blog.csdn.net/qq_24130227?spm=1010.2135.3001.5343) +2. 联系邮箱 const_zpc@163.com +3. 了解更多可关注微信公众号 + +![大橙子疯嵌入式](微信公众号.jpg)