From 7c8fb79f9ef2acac643ed71fd7ba7e5cef537114 Mon Sep 17 00:00:00 2001 From: "const_zpc@163.com" Date: Tue, 28 Feb 2023 21:58:18 +0800 Subject: [PATCH] =?UTF-8?q?=F0=9F=93=83=20docs:=20=E5=AE=8C=E5=96=84?= =?UTF-8?q?=E4=BB=8B=E7=BB=8D=E4=BF=A1=E6=81=AF?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- Demo/cmd_shell/demo.c | 10 ++++++++- Param/inc/param.h | 33 +++++++++++++++++------------ Param/src/param.c | 34 +++++++++++++++--------------- README.en.md | 36 -------------------------------- README.md | 47 +++++++++++++++++++----------------------- 微信公众号.jpg | Bin 0 -> 8544 bytes 6 files changed, 67 insertions(+), 93 deletions(-) delete mode 100644 README.en.md create mode 100644 微信公众号.jpg diff --git a/Demo/cmd_shell/demo.c b/Demo/cmd_shell/demo.c index a185b65..46d7f4e 100644 --- a/Demo/cmd_shell/demo.c +++ b/Demo/cmd_shell/demo.c @@ -27,11 +27,19 @@ int main () ShowAllParam(); printf("\nModify: \n"); + + // 通过接口修改(参数范围限制) memcpy(databuf, &data, sizeof(data)); ModifyByName("test_2", databuf); memcpy(databuf, &fdata, sizeof(fdata)); - ModifyByName("test_3", databuf); + ModifyByName("test_3", databuf); + + ShowAllParam(); + + // 在模块文件中定义的参数可以选择直接修改(没有参数范围限制) + test = 5; + test_3 = 8.26; ShowAllParam(); diff --git a/Param/inc/param.h b/Param/inc/param.h index e361c63..2fd0f83 100644 --- a/Param/inc/param.h +++ b/Param/inc/param.h @@ -1,25 +1,28 @@ /** - * @file param.h - * @author pczhou (pczhou@streamax.com) - * @brief - * @version 0.1 - * @date 2023-02-07 - * - * @copyright Copyright (c) 2023 锐明技术股份有限公司 - * - * @par 修改日志: - * - *
Date Version Author Description - *
2023-02-07 1.0 pczhou 内容 - *
+ ********************************************************************************************************************** + * @file param.h + * @brief 该文件提供参数管理框架所有函数原型 + * @author const_zpc any question please send mail to const_zpc@163.com + * @version V0.1 + * @date 2023-02-07 + ********************************************************************************************************************** + * + ********************************************************************************************************************** */ +/* Define to prevent recursive inclusion -----------------------------------------------------------------------------*/ + #ifndef _PARAM_H_ #define _PARAM_H_ +/* Includes ----------------------------------------------------------------------------------------------------------*/ #include #include +#ifdef __cplusplus + extern "C" { +#endif + typedef int8_t PARAM_INT8_T; typedef int16_t PARAM_INT16_T; typedef int32_t PARAM_INT32_T; @@ -137,4 +140,8 @@ extern int Param_ModifyByName(ParamTable_t *pParamTable, const char *pszName, co extern size_t Param_Serialize(ParamTable_t *pParamTable, uint8_t *pBuf); extern void Param_Parse(ParamTable_t *pParamTable, const uint8_t *pBuf); +#ifdef __cplusplus + } +#endif + #endif // !_PARAM_H_ diff --git a/Param/src/param.c b/Param/src/param.c index 80d7314..8bcb547 100644 --- a/Param/src/param.c +++ b/Param/src/param.c @@ -1,27 +1,27 @@ /** - * @file param.c - * @author pczhou (pczhou@streamax.com) - * @brief - * @version 0.1 - * @date 2023-02-07 - * - * @copyright Copyright (c) 2023 锐明技术股份有限公司 - * - * @par 修改日志: - * - *
Date Version Author Description - *
2023-02-07 1.0 pczhou 内容 - *
+ ********************************************************************************************************************** + * @file param.c + * @brief 该文件提供参数管理框架功能 + * @author const_zpc any question please send mail to const_zpc@163.com + * @version V0.1 + * @date 2023-02-07 + * + * @details 功能详细说明： + * + 参数修改和重置管理 + * + 参数序列化和反序列化 + * + ********************************************************************************************************************** + * 源码路径：https://gitee.com/const-zpc/param.git 具体问题及建议可在该网址填写 Issue + * + * + ********************************************************************************************************************** */ - +/* Includes ----------------------------------------------------------------------------------------------------------*/ #include "param.h" #include - -// const uint32_t sg_tParamTableNum = sizeof(sg_tParamTable) / sizeof(sg_tParamTable[0]); - #define CASE_CHANGE(type) \ case type:\ {\ diff --git a/README.en.md b/README.en.md deleted file mode 100644 index 6475f8c..0000000 --- a/README.en.md +++ /dev/null @@ -1,36 +0,0 @@ -# param - -#### Description -参数管理框架 - -#### Software Architecture -Software architecture description - -#### Installation - -1. xxxx -2. xxxx -3. xxxx - -#### Instructions - -1. xxxx -2. xxxx -3. xxxx - -#### Contribution - -1. Fork the repository -2. Create Feat_xxx branch -3. Commit your code -4. Create Pull Request - - -#### Gitee Feature - -1. You can use Readme\_XXX.md to support different languages, such as Readme\_en.md, Readme\_zh.md -2. Gitee blog [blog.gitee.com](https://blog.gitee.com) -3. Explore open source project [https://gitee.com/explore](https://gitee.com/explore) -4. The most valuable open source project [GVP](https://gitee.com/gvp) -5. The manual of Gitee [https://gitee.com/help](https://gitee.com/help) -6. The most popular members [https://gitee.com/gitee-stars/](https://gitee.com/gitee-stars/) diff --git a/README.md b/README.md index 68c1595..e6f2ae4 100644 --- a/README.md +++ b/README.md @@ -1,37 +1,32 @@ -# param +# 轻量级参数管理框架(C语言) #### 介绍 -参数管理框架 +1. 采用表驱动方式统一管理所有参数，包括缺省值、最小值和最大值等 + +2. 采用宏定义快速注册和添加参数进行管理 + +3. 支持基本类型参数和字符串参数 + +4. 支持序列化和反序列化，便于保存和读取校验 + +5. 可通过串口协议或其他协议调用接口修改参数 #### 软件架构 软件架构说明 - -#### 安装教程 - -1. xxxx -2. xxxx -3. xxxx - #### 使用说明 +1. 通过函数 Param_ModifyById、Param_ModifyByName 限制修改参数 +2. 调用函数 Param_Serialize 对参数序列化, 保存至储存芯片中 +3. 从储存芯片读取数据后，调用 Param_Parse 反序列化得到参数，同时进行参数范围校验 -1. xxxx -2. xxxx -3. xxxx +#### demo样式 +博客： -#### 参与贡献 +[轻量级参数管理框架（C语言）](https://blog.csdn.net/qq_24130227/article/details/129233836?spm=1001.2014.3001.5501) -1. Fork 本仓库 -2. 新建 Feat_xxx 分支 -3. 提交代码 -4. 新建 Pull Request +#### 关于作者 +1. CSDN 博客 [大橙子疯](https://blog.csdn.net/qq_24130227?spm=1010.2135.3001.5343) +2. 联系邮箱 const_zpc@163.com +3. 了解更多可关注微信公众号 - -#### 特技 - -1. 使用 Readme\_XXX.md 来支持不同的语言，例如 Readme\_en.md, Readme\_zh.md -2. Gitee 官方博客 [blog.gitee.com](https://blog.gitee.com) -3. 你可以 [https://gitee.com/explore](https://gitee.com/explore) 这个地址来了解 Gitee 上的优秀开源项目 -4. [GVP](https://gitee.com/gvp) 全称是 Gitee 最有价值开源项目，是综合评定出的优秀开源项目 -5. Gitee 官方提供的使用手册 [https://gitee.com/help](https://gitee.com/help) -6. Gitee 封面人物是一档用来展示 Gitee 会员风采的栏目 [https://gitee.com/gitee-stars/](https://gitee.com/gitee-stars/) +![大橙子疯嵌入式](微信公众号.jpg) \ No newline at end of file diff --git a/微信公众号.jpg b/微信公众号.jpg new file mode 100644 index 0000000000000000000000000000000000000000..ba61c3cf75de177152ebd185db0a7d72c015a952 GIT binary patch literal 8544 zcmdUUc|4T++y6ZVV_!#yvV|-;b;2kk45tWXO-N1(g_JBUn#v4L%bBJSTAaaDhKRI` zv^m2mTOE6d5?OMPlWl~?%yZpC=iB){-{0%?`~6<8=Z|N&jeG9<{>v`{V0Gr{+PMScPk`y%{<3c0;8Lxmgo`QuNX%~6H4}fCs@M&mt=nn_Aj|Q5g9B7jE7Z3NXY!w z>oh~;f9Sxl?u6OtVQCU|6l2l;MjY48o??u5|K{BeuHfa^nE96hQ4VGSFDi%x zIB$#zcu|QhLMUF9cbz4*)jjC#6L(x);JiOsvQm402H)GRqIj4g<1VtKf+dXF0V**;&s4~SC#l#pE4+PQ>e*QUyD4Kh;@vN^n zry$bA7Gr^r|HY!xNUeBaR|Z`EbMdx+doM7&PD8#Pu3TQB57+G-Cmmg|w!D_9-sk{Q z68l)N)hVBeyV?89MqyLdl$HGSc`u)d;vqP*iGp28!2Z)NT%BU=Ow6vQlG2k+!{_qq zL$#9~!bE!EoDtmUAWQMeQHYt7;(ON&<_*|Nh`Xp(u+%lPGbvt~e_}cicR72)h2!(a zvpcNG?jnbahqDRmTuXRG7iHn=GsD7|Ju%J_1PreblWM2RRA0)^r)m$P=S=~v)_6oY zKGh-G(BJ|*5sXQSVH@`s@W_|m_-GEjSdErX&KtKs)n+osNG*g6T z2v1(;q*I*v1;(>J!gbUtDaLxK0j(CJ0D?t5+Qa)F$Eu8M`&blXq@C+3Zitb0P3PTK zFxdh-v@ygy;({iV>MvvS_VK+XYhl^U$C_p?;+%A5BxttE5c6{e-$#BYo7~QIfxV|Q zh*qD~_JjE0T1dqrx0s2Pl5yO5iOIKI#b8aGypFa+U^_Hl_Yq9~j9sw^nEaA@Q z;LLSB*!Sx$0mkl@fboBPNZE$>ut&Zg1|YuiT%LgnuTTNR*@lP5XFO&W9YX7r)+vzj zd5_P;eR?1@lI)q9{X1ybqZ7cz&%Yn=qE^%$)5a+{!DS|F^5c7-!@ikhigJsGe=S;b z;duMRLpN(sd#(XipWg4@WjyQGu-{z-m9;Gc5E(q#OjVG{SaZ^NE;k|*?CCxE<^j18 z8wFAt* zsxn?NF`(6`A)uL)evddbi^>!5qM8M=^m5XLD3VJn;T3AJgaV>Yu^{ypSHO!d{^K}( ztD6A}RmeBWTCT=Kj6#{Bl{lK;hGyzAhI-I=p4=wquilJ|S#FIo8l9_~uJg1r&jItHA4x)Km!=)PU7GoC1>;)(>C-p^=W|=!$UCGjM*$(Kz;%&w%na^)kr18B0O(PH?yvrtMwz>g^ zYQUn(XvlbTt&h+cKI?~rh;ky3y41}=hk?^Dp50zY@hT6bikLakx8}<`Be+J7q}>Z( zqj*(QU5&6IB@|=Zo_4Mq-5s$>pdSYbg zu!BvoXTTV22+ZICc2}EbRin6Iy|oU->11r8pjJAD2BC$JwDkigoe>B|-A^Sl)oEda zS>!{-1N*t?9VQmV10gE&TQ#%Nn%YS$WWBZ&rY1L~fdWVfDRzdh`=z}01`)4`!tu$G zUg|P>hA^tlO$NN^P@m%6#2~d0lZbV)jgz#{J_tNTyC4t|-dAnnfZo1i4wC#pkD(f% zQ3H)3v#d1a(PB(%pLjr?Vv3G{YllW;hR^QMQwNEh+Abv@y0H+@9OMCFb&Zoru$yCj z8fBrFhfF#|xJXx7it$D?-+0*L-7$-Y$WaLAoPszmXac`%K(}901rMrPEUaTGs-WAi{nIFoqr)t)zG*rnF3gk@S`d10G|F zo16G5j*a?6EdhC0@3LIgI)-;5+Z5Xgx(S2IF36UBt?N))i>c zk?h$Fk%3pZV7r!5P>~!ipq{EB#20hC6O9Sr%RECKAT2M)8g|JuA|F|dPK4W0kmrMw zoDutB;}Ll(XUydXx&YC#B83-s47J%TX^d$3qvW@7nFd^^LczVq4rl8<5`)*i)$)&~ zoIE?4QM2)+pVLpQi|f5&mg>2%f0L8ci)puV7k_-HKk%~o<@qzAIQ>2WA~GOAdT(7F zKS;A$)pKjvmm*KTuVwB3bU&q{T zwkcJqvhd)swLN!8Ls~!JbQ4oDklF7k70P_0VqSxd0#CMGfT$IBtmwfo+Fwp z`jUNrrr5TPN1O~ARrY^5fT{J?yMxsZQ6puAzdd1mEB0X3W50cttC^qMig+IHHmA>> z@6bAr9KrwGkrdeBVBCcDG>W~8#}2jS~B^to9GkgQ3{ zpY28Rvj>x=-6mBkVoR$Y@TJBMwLGP*9>_RUN;RFmxGtkR(nQVbf}u!uRrXo8_imCq z1xSd0h1@kg*Sig7DR^0Sa_~w!kBWY>X6B|^iX^*Ri?^rjVd}GK#T_$yC)Qn<+}4(J zG4NvAYnOWuj`T#wWWKrMD&{joxv?)>HO_3`JC)7x1+i9%?Cj<_zK21M6K&XwCIv63Ne>Y_pwa%B$ao z3Xq_Kotn?K#dh3ghnM>q1YQq~f42H$W!#^!X1#J($9>*kIMZ9U;`8g_a|a?5AE&O| ziR0@wHf=m| z^t-iw^f|ws?;4nIH;(F61gw0qAt=H>qNiW(wK=z)_h6)oIB(oT>NKdh?>{3z{9dhQ zzt&FMba>V6>&+i8zntvxeuf-Tp2SQrc+U@MQ_0;Q^Fo*>h%?7_7ln7G-#(Wgn-I1l zrDXl7^MlFJaUl_o>V1rm{NkXoqg4%3GZQ=Xnj-%CVd-!flU`I9k2$ygmjh3J&on<@MO4;eI;^`(6Z+9+B`p$R6 zV`%y|XJ5vz}fIN19Ih zWBrGOq|J5FOD{h+b}{SKPw)A1YjfJe*226e?5CYFN~*Nkln~-OtZ|U4Hn-^gak-K_ z=ed)^cMh+-|0X^8TD7{SSxe&1AcHdo<1TXn`;L+eKa*Fq&HUV;u5`fo!B6=LqO!M% z4SIp`W<72*D@&ifjyUXM_I&Oz{qAhxbj$4BD;=3mqEvE%S;L0PZ~;H4mQ@=roqFe`=j@2pR^JuEXmpwr;q7zc4|2_U z_firAUcE|ON|T8iNcym^rzePj4D+|mLs^7&C%pjN-QTty2=txW?c6P0mi%qJqHMPf zfZf$!d)O;h@93ayP-2jl|Lz|2t>YpBfsPn{rUlR?q?V!aj&)G-j| zDaI$C_&|}QL9*m~-?PhsvWZj>)6$k9Z#|Qzm;r^qt(1jY!+>KfI54XUnvYr{Qw*C` z0@a9H-1?TYH8&7BL+q@d=5MDt1@=SV6h=*MGdfWX)f|oEu?xQQS%6d*W5aeDwgi^8 z4qWVfH|OKE=8xrOmaYQiNg(m?%E1IxveXQgFL70XteC70nEpO{eq{p3*PJB%X6Dyt zzj@JYnq;3(ys2^65`F9g9XsJMRuk&?Typ+KPHlg!C}Y&~scA5lJ((E4 zb4Wk+pw$+Z^K-K^T_|t) zxwqTHX0M#dD)pBRO3e) z)Z4kv4i2)aP@^bwq0#xBII;<euLNbGf zm>S}AbvWsT)1RS^HnchnK;I<;of-oeDa)3!o0z;Je2%gc4O#4UM3p4!^w)lXiaoWB zCUFCgnfK6|fv8K(9^5|n9WSv)faFdJkU!gQ-LLDnTpyX25WYk*``K21JA$&yZoMLc zS@~&~Qx~>xcW|8jMZ1Tt`I;$}wQB6gSVr~o$62@^RVBJHzR`skT(|BGY{R}k*d@O@ za!MX&^jFoJMC&BIjIZgGKCpr||Bm>n?Q!?$h^eK&)|bPV1;{T2_q)SNl?$8gjGeO& z*D+XU`W{eMcFmN2F>T&_?upUUoS;7f*7{g9Sa5k_)+Y|;ic5T2^#ng@VzoN)pnpF- zuIyIU`0C56uLW5Sm8Ncp=H*{}*K0n?xKiFXF!dMNhnPRJ&hydJro1!mj|9kuOZr!L z?kI7>i!2*ZoFMN~PE0Ll%5_4GzUtJix7XjiBR=ppElqxrAJ4dCp<&Wp=5|z_Z!q?% z$x+wT-^lRB@)$<0lZKpF;G5Wp)`;9o!*hRqAV!|JbU!oQ@eAwdU(!^{&r-t&%%zuY z>`WNMU36hT&#peO>`#Ba_bXOBCfQj1@I{BWVa$zoNY?cy@!tmy)poH?+8haskj_{C z%cEQ`s4=7{?$mI<0NHD(i>sr8Nq+LoI{d_D&FW3_k6#Lq=dboR+yVHU}SmOJ7tV{oi^;2`j63V>0m>r5#92<>S+ZuxR?;3(hEV$t(gYd+Ajv{wva zked~2KhXOC<(PO|trs=wP;b+mz)I12^zwS(i+?G1I@RAr~TXCH{H}yjm=R%nNZE2 zg>{}lY+5crzJGO6Oe^Fp!@Vx&_T@m>!m+2 zFZ5h=D*oWiDezc&JCYfP$GB~|yCkvzQ?+v11TtYFZ~#bc-hodUp%y^6sn#LO_Xp8{ zmDT*aD@kT%v4d2hiJ`;iF$}cHkF}otgc2brM~7Sp#fng6j!T(*giiT7nAY0@+LDw8 zKRaOHoc}{nX?}({Jp_-Bpp;u+q-kiqz34c~%DtZYWGe}=$eLmdJkzciV6N2&Av&kw z=Cw`R?BUg2Qp<-FatvWvag1#5@)ih4FPeRzJbSR>-v!`wI|D;DAn1yynA-fU0=WVTF>w zSwc!UzZMD!K=AODBf>fwwgZL2KQM2eWYvgLF+$#+k%5?PewbRfLO43eOR8d&;Z$#+ ze6nx=;YudA*p1SnfZ`7!AZ2sSLGL&PyMZz!rBhLcN89T2oUo3NLLwZ2{0gNnHA}P; z4kS|0#b)1onzt8uQtp9tp;L_L{4u&7FJhMeqbCj!zV_79ix8vJJx zGtpBAa>qdy=}m|Z#ZZ>|59WgpzBl;$548?uiX=Eenu?x+&lh-}U?szas;ExC z6KFG3FBj#vfEjGLIY8x1{XOGAM>?4QP8a@*dqqbvi;T1IL(eHII@oG+N;?pdXus}K zN?pGOrbMu2jQVlSkPBjgS zv@0G?e|(sC3-FkfM+V+0Cf=5)rotscx!pHbd44Nfnlu@hOV5Pj=Y%he%l?xi8#BTgBX5ZGGH4q3%{QPHtYJPdiVRhh_M z5C{leu=CEck-1!SK84g7_AW%0fGYZNC@37s?%0?H5aw*f4GV%0Q|k|bQ#Yx8a)A*C z33TUuH-*vShz`Dl#9=6?$g25(@XLXW)rR#ht_j8A7x5?uMUV=XGl)KIW7!CcyZ*+0 zUjs|lgEwOF2>TnteQ`Pg0SomobT|Xw!T^ZcBP;NMC^$U+G5v7++pUcmo>W^b0V(0# z;zB8p`h7|zvI4A#o$(xei`o|*TL=Tj14q!RXM`pjo8s~&mB9xX^h4K-L8m>$9IFJV z?5smEPT;=%TYZBEr+_ocTD)!(<9JMTZ>lQfvxCAA*Oil10;4WaCBSV68U%RLp~}!O zH8n7vvM!s0>Q7z+E$6WMFyV`_6HPF46mPMWULbrYxiIMaDwn?x*9}&;_em)Sz z6L*N#VXqgm4!}r$AjE=@2BRpE_|&#E;I$SC-})GI1CkY5fSoaDj{Y840O1`SE`;}O zP=lX(aN@h