iotstack-application-sdk-c/README.md

118 lines
2.2 KiB
Markdown
Raw Normal View History

2021-01-22 16:21:57 +08:00
## 编译
编译依赖cmake 2.8依赖的nats库仅支持cmake编译
```
sudo apt-get install cmake
```
编译方式GNU Make
```
make
```
## 打包方式
将samples改名为main和依赖的动态链接库如果有一起打成zip的压缩包,将压缩包上传到子设备驱动
```
cd samples
cp samples main
zip -r abc.zip main
```
## API参考文档
/**
* @brief 应用初始化
*
* @param void:
*
* @retval : 成功则返回APP_OK
*/
app_status app_common_init(void)
/**
* @brief 获取应用名称
*
* @param void:
*
* @retval : 成功则返回应用名称的字符串失败返回NULL
*/
char *app_get_name(void)
/**
* @brief 获取产品SN号的字符串
*
* @param void:
*
* @retval : 成功则返回产品SN号的字符串失败返回NULL
*/
char *app_get_productSN(void)
/**
* @brief 获取设备SN号的字符串
*
* @param void:
*
* @retval : 成功则返回设备SN号的字符串失败返回NULL
*/
char *app_get_deviceSN(void)
/**
* @brief 获取应用配置信息的字符串
*
* @param void:
*
* @retval : 成功则返回应用配置信息的字符串失败返回NULL
*/
char *app_get_info(void)
/**
* @brief 注册下行消息回调函数
*
* @param handle: 下行消息回调函数指针
*
2021-03-16 16:55:49 +08:00
* @param handle: rrpc消息回调函数指针
*
2021-01-22 16:21:57 +08:00
* @retval : 成功则返回APP_OK
*/
2021-03-16 16:55:49 +08:00
app_status app_register_cb(msg_handler normal_handler, msg_handler rrpc_handler)
/**
* @brief 发送消息,可发送二进制流
*
* @param topic: topic名字
*
* @param data: 发送数据内容
*
* @param dataLen: 发送数据长度
*
* @retval : 成功则返回APP_OK
*/
app_status app_publish(const char *topic, const char *data, int dataLen)
/**
* @brief 发送字符串消息
*
* @param topic: topic名字
*
* @param data: 发送字符串内容
*
* @retval : 成功则返回APP_OK
*/
app_status app_publishString(const char *topic, const char *data)
2021-01-22 16:21:57 +08:00
/**
* @brief 记录日志
*
* @param level: 日志等级分为DEBUG、INFO、WARNING、ERROR
* @param format: 日志记录格式
*
* @retval : void
*/
void log_write(log_level level, const char *format,...)