为了更好的学习物联网设备端相关知识和实践,基于之前的 iot hub c sdk 整理并重写了 iot-hub-device-c-sdk
以下针对该仓库,描述如何搭建相应的开发环境。
概述
工具 | 说明 |
---|---|
wsl | windows上linux子系统,能够在windows进行简单的linux开发 |
vscode | 代码编辑器,配合插件进行代码编写 |
WSL需要安装以下软件:
- cmake:工程的编译框架构建基于cmake
- gcc:linux上编译器
- g :提供googletest单元测试支持
- googletest:提供工程的单元测试框架
- gcovr:提供单元测试覆盖率统计
- git:代码版本控制
- doxygen:提供代码注释格式化和注释可视化支持
- graphviz:配合doxygen使用,提供头文件依赖视图
vscode需要安装以下插件:
- C/C :提供C/C 语言开发支持
- Doxygen Documentation Generator:提供doxygen风格注释生成
- markdownlint:markdown格式化校验,提高文档质量
- Code Spell Checker:单词拼写检测,提高代码质量
- GitLens:git信息以及diff支持
WSL安装
- 控制面板->程序和功能->启用或关闭Windows功能->勾选 适用于Linux的Windows子系统
- 在Microsoft Store中下载Ubuntu
- 软件安装
apt-get update
# 安装所需软件
apt-get install git cmake gcc g doxygen graphviz
# 安装googletest
apt-get install googletest gcovr
cd /usr/src/googletest
mkdir -p build
cd build
cmake .. && make && make install
VSCode安装
- vscode安装,详见 https://code.visualstudio.com/
- 找到Extensions,依次搜索并安装相应插件
开发须知
物联网设备端主要使用C语言进行开发,为了提高工程质量,需要按照统一的规范进行开发,需要仔细阅读:
- SDK代码规范说明
- SDK代码格式说明
同时,需要按照Doxygen规范进行注释,并且基于googletest编写相应的单元测试,保证单元测试覆盖率。