基于RK3576开发板的INI文件操作

1. INI文件简介

        INI文件时Initialization File的缩写，即初始化文件。INI文件是Windows系统常见的配置文件存储格式，当前也可作为Linux的配置文件。INI文件由节、键、值组成。“节”的表达方式为[Section1 Name]，以中括号“[]”包围起来，它用来表示一个段落的开始，因INI文件可能是整个项目共用的，所以需要使用“节”来区分不同用途的参数区。“键”与“值”的组合表达方式为KeyName=value，以等号“=”分隔。INI文件注释以分号“;”表示，在分号后面的文字直到该行结尾全部作为注解。例程如下所示，注意value值只有int型和string型。

 

; comment textINI文件的数据格式的例子（配置文件的内容）　
[Section1 Name]
KeyName1=value1
KeyName2=value2
...
[Section2 Name]
KeyName21=value21
KeyName22=value22

 

2. 快速上手

       如果您初次阅读此文档，请阅读：《入门指南/源码管理及编程介绍/源码工程管理》，按需管理自己工程源码（注：此文档必看，并建议采用【远程挂载管理】方式，否则有代码丢失风险！！！）。

2.1  源码工程下载

       先在PC虚拟机定位到nfs服务目录，再在目录中创建存放源码仓库的管理目录：

 

cd ~/nfsroot
mkdir GitHub
cd GitHub

 

       再通过git工具，在管理目录内克隆远程仓库（需要设备能对外网进行访问）

 

git clone https://github.com/EASY-EAI/EASY-EAI-Toolkit-3576.git

 

  注：

* 此处可能会因网络原因造成卡顿，请耐心等待。

* 如果实在要在gitHub网页上下载，也要把整个仓库下载下来，不能单独下载本实例对应的目录。

2.2  开发环境搭建

       通过adb shell进入板卡开发环境，如下图所示。

       通过以下命令，把nfs目录挂载上nfs服务器。

 

mount -t nfs -o nolock <  nfs server ip  >:<  nfs path in server  > /home/orin-nano/Desktop/nfs/

 

2.3  例程编译

       然后定位到nfs的挂载目录，再在目录中创建存放源码仓库的管理目录：

 

cd /home/orin-nano/Desktop/nfs/GitHub

 

        进入到对应的例程目录执行编译操作，具体命令如下所示：

 

cd EASY-EAI-Toolkit-3576/Demos/common-ini/
./build.sh

 

2.4  例程运行及效果

       进入Release目录执行下方命令，运行示例程序：

 

./Release/test-iniWrapper

 

       执行效果如下所示。

       API的详细说明，以及API的调用（本例程源码），详细信息见下方说明。

3. INI文件API说明

3.1  引用方式

       EASY EAI api库位于本仓库的easyeai-api目录中。为方便客户在本地工程中直接调用我们的EASY EAI api库，此处列出工程中需要链接的库以及头文件等，方便用户直接添加。

描述	CMake写法	Makefile写法
api.cmake	${common_root}/ini/api.cmake	无
头文件目录	${INI_INCLUDE_DIRS}	-I ../../easyeai-api/common/ini
源文件目录	${INI_SOURCE_DIRS}	../../easyeai-api/common/ini
库文件目录	无	无
库链接参数	${INI_LIBS}	无

       API源代码路径为EASY-EAI-Toolkit-3576/easyeai-api/common/ini/。用户可通过源代码了解接口实现，甚至可对源码进行修改。

3.2  INI读取整型数据

       函数原型如下所示。

 

int32_t ini_read_int(const char *file, const char *pcSection, const char *pcKey);

 

       具体介绍如下所示。

函数名：ini_read_int()
头文件	easyeai-api/common/ini/ini_wrapper.h
	file：配置文件位置
	pcSection：参数所在的节
	pcKey：参数标签
返回值	成功返回0
	失败返回-1
注意事项	无

3.3  INI写入整型数据

       函数原型如下所示。

 

int32_t ini_write_int(const char *file, const char *pcSection, const char *pcKey, int Val);

 

       具体介绍如下所示。

函数名：ini_write_int()
头文件	easyeai-api/common/ini/ini_wrapper.h
输入参数	file：配置文件位置
	pcSection：参数所在的节
	pcKey：参数标签
	Val：int型，写入的参数值
返回值	成功返回0
	失败返回-1
注意事项	若配置文件不存在，则会自动创建配置文件

3.4  INI读取字符串数据

       函数原型如下所示。

 

int32_t ini_read_string(const char *file, const char *pcSection, const char *pcKey, char *pcStr, int len);

 

       具体介绍如下所示。

函数名：ini_read_string()
头文件	easyeai-api/common/ini/ini_wrapper.h
输入参数	file：配置文件位置
	pcSection：参数所在的节
	pcKey：参数标签
	pcStr：字符串型指针，用于存放读取出来的参数值
	len：存放读取参数的字节串内存最大长度
返回值	成功返回0
	失败返回-1
注意事项	无

3.5  INI写入字符串数据

       函数原型如下所示。

 

int32_t ini_write_string(const char *file, const char *pcSection, const char *pcKey, const char *pcStr);

 

       具体介绍如下所示。

函数名：ini_write_string()
头文件	easyeai-api/common/ini/ini_wrapper.h
输入参数	file：配置文件位置
	pcSection：参数所在的节
	pcKey：参数标签
	pcStr：需要被写入的字符串数据指针
返回值	成功返回0
	失败返回-1
注意事项	若配置文件不存在，则会自动创建配置文件

3.6  INI文件操作函数使用案例

       使用代码为EASY-EAI-Toolkit-3576/Demos/common-ini/test-iniWrapper.c，程序逻辑如下所示。

审核编辑 黄宇