{"en_US": {"title": "Device Access - develope with SDK", "content": "# Device Access - develope with SDK\n\nThe OneNET platform provides C-based device access SDK, which is suitable for MCU+standard communication modules and single-board SOC solutions. The SDK consists of a fixed code package and a configuration file generated by the platform, which can be compiled directly on the Linux system and run independently, or integrated with the SDK according to the hardware platform you are using to achieve fast access to the OneNET platform.\n\n## 1. Code directory description\n\nThe basic directory structure of the SDK is as follows:\n\n```tree\n ├── CMakeLists.txt\n ├── common\n ├── config.h\n ├── examples\n ├── onenet\n │ ├── platforms\n │ ├── protocols\n │ └── security\n └── tools\n```\n\n| Directory name | illustrate |\n| :-------: | --------------------------- |\n| common | It mainly includes some commonly used tools or algorithm interface encapsulation, which is independent of the system platform|\n| examples | It mainly includes sample code, which corresponds to different access protocols |\n| onenet | It mainly contains the code related to the platform access protocol, among which the IoT directory contains the general platform access, the TM directory contains the Thing model access, and the utils directory contains a part of the general interface encapsulation |\n| onenet/platforms | It mainly contains the content of the system adaptation layer, and the adaptation interface is defined by the header file in the include directory, and the other directories (such as Linux) contain the adaptation implementation code of the corresponding platform|\n|onenet/protocols | It mainly contains the content of the application protocol layer, integrating two open-source protocol stacks and a simple HTTP function interface library |\n| onenet/security | It mainly contains security-related interface encapsulation, which is currently only implemented by TLS interfaces|\n| tools | It mainly contains some open-source tools or tool interface encapsulation |\n\n## 2.Description of the adaptation interface\n\nIn the user integration and adaptation SDK scenario, the underlying layer of the SDK is encapsulated with relevant interfaces and a unified header file interface is defined, which only needs to be adapted according to the unified interface to quickly interact with the platform.\n\n### 2.1 System Resource Interface\n\nThe SDK has provided standard interfaces, and users need to test and adapt according to the system environment.\n\nFor more information, see the file in the SDK ([Get SDK](/doc/v5/fuse/detail/215)) and the file path: 'onenet/platforms/include/plat_osl.h'\n\n|

interface

description

interface

description

|\n| :--------------------------------: | :--------------------------------: |\n| time_count_ms/time_count | Return Time Count (ms/sec) |\n| time_delay_ms/time_delay | sleep/delay in milliseconds/sec |\n| countdown_start | Start a timer |\n| countdown_set | Reset the expiration time of the timer |\n| countdown_left | Returns the time remaining until the timer expires|\n| countdown_is_expired | Determine if the timer has expired |\n| countdown_stop | Destroys the specified timer|\n|\n\n### 2.3 TCP communication interface\n\nOnly MQTT-related access and OTA functions are used. If you only use NB or CoAP, you do not need to migrate the device.\n\nFor more information, see the file in the SDK ([Get SDK](/doc/v5/fuse/detail/215)), file path: 'onenet/platforms/include/plat_tcp.h'\n\n|

interface

description

|\n| :--------------------------------: | :--------------------------------: |\n| plat_tcp_connect | Specify the network address for the connection |\n| plat_tcp_send | Send data over an established TCP connection |\n| plat_tcp_recv | Receive data over an established TCP connection |\n| plat_tcp_disconnect | Disconnect an established TCP connection |\n\n### 2.4 UDP communication interface\n\nUDP interfaces are mainly used for CoAP mode for Thing model access, and other access methods do not need to be migrated.\n\nFor more information, see the file in the SDK ([Get SDK](/doc/v5/fuse/detail/215)) file path: 'onenet/platforms/include/plat_udp.h'.\n\n|

interface

description

interface

description

|\n| :--------------------------------: | :--------------------------------: |\n| uart_open | Open the serial port with the specified parameters and return the serial port operation handle |\n| uart_send | Send data through an open serial port |\n| uart_recv | Receive data through an open serial port |\n| uart_close | Close the open serial port |\n## 3.Thing model SDK development\n\nThe provided code is constructed under the Linux system by default, please adapt the relevant interfaces according to your own system, see \"**2.Adaptation Interface Description**\" above for details.\n\nAfter obtaining the SDK, run the command in the local Linux environment to complete the decompression, and you can see the files after decompression. The file details are as follows:\n\n```tree\n ├── CMakeLists.txt\n ├── common\n ├── config.h\n ├── examples\n ├── onenet\n │ ├── platforms\n │ ├── protocols\n │ └── security\n └── tools\n```\n\nBefore you use the sample code to communicate with IoT Platform, you need to modify the device parameters in Main Gram under Example to the device information that you have created, and save and exit it after the completion of the test.\n\nFill in the product ID, device name, and device base as shown below.\n\n```c\n/** OneNET Product ID*/\n#define PRODUCT_ID \"\"\n/**Device unique identification code, unique within the product*/\n#define DEVICE_NAME \"\"\n/**Certification Information--device key*/\n#define ACCESS_KEY \"\"\n```\n\nYou can customize the validity period (that is, the expiration time) of the token as needed, which is 2030-12-31 by default.\n\n```c\n/** Token expiration date, default set to December 2030*/\n#define EXPIRE_TIME 1924833600\n```\n\nThe device SDK obtained by the user on the platform side includes the tm_user.c and tm_user.h files automatically generated by the platform based on the Thing model of the product to which the device belongs (after modifying the Thing model, the tm_user file will be regenerated and a new SDK needs to be obtained), and the user needs to process the platform data delivery (read property points, write property points, service call) commands or data reporting in the tm_user.c file according to his actual business.\n\nAfter the modification is complete, run the cmake command in the sample code directory to generate a makefile file. Run the make command to compile the sample program.\n\n```shell\nmkdir build # Create a build folder\ncd build # Go to the build folder\ncmake .. # to.. /directory CMakeLists.txt\nmake # compile\n./mqtts_onejson_soc #run, using the MQTT protocol as an example\n```\n\nThe OneNET platform provides debugging tools that make it easy to interact with the device and learn how to perform [device debugging](/doc/v5/fuse/detail/253).\n\n![](Device Access - develope with SDK.png.d/Device Access - develope with SDK-1.png)\n\n## 4.Data stream SDK development\n\nThe provided code is constructed under the Linux system by default, please adapt the relevant interfaces according to your own system, see \"**2.Adaptation Interface Description**\" above for details.\n\nAfter obtaining the SDK, run the command in the local Linux environment to complete the decompression, and you can see the files after decompression. The file details are as follows:\n\n```tree\n ├── CMakeLists.txt\n ├── common\n ├── config.h\n ├── examples\n ├── onenet\n │ ├── platforms\n │ ├── protocols\n │ └── security\n └── tools\n```\n\nBefore you use the sample code to communicate with IoT Platform, modify the device parameters in main.c in example, and save the device parameters.\n\nEnter the product ID, device name, and device key as shown below.\n\n```c\n/** OneNET Platform Product ID*/\n#define PRODUCT_ID \"\"\n/** Unique device identification code, unique within the product*/\n#define DEVICE_NAME \"\"\n/** Authentication Information--Device Key*/\n#define ACCESS_KEY \"\"\n```\n\nYou can customize the validity period (that is, the expiration time) of the token as needed, which is 2030-12-31 by default.\n\n```c\n/** Token expiration date, default set to December 2030*/\n#define EXPIRE_TIME 1924833600\n```\n\nAfter the modification is complete, run the cmake command in the sample code directory to generate a makefile file. Run the make command to compile the sample program.\n\n```shell\nmkdir build # Create a build folder\ncd build # Go to the build folder\ncmake .. # to.. /directory CMakeLists.txt\nmake # compile\n./mqtts_stream_soc #run, using MQTT as an example\n```\n\nIn the menu bar of \"Device Management\", select the device that is connected to the device using data stream, and click \"Device Details\" to view the default data content of the sample upload.\n\n![](Device Access - develope with SDK.png.d/Device Access - develope with SDK-2.png)\n\n![](Device Access - develope with SDK.png.d/Device Access - develope with SDK-3.png)"}, "zh_CN": {"title": "设备接入SDK开发", "content": "# 设备接入SDK开发\n\nOneNET平台提供基于c语言的设备接入SDK，适用于MCU+标准通信模组以及单板SOC的方案。SDK由固定代码包和平台生成的配置文件构成，您可以在Linux系统中直接编译后独立运行，或者根据您使用的硬件平台集成SDK使用，实现OneNET 平台的快速接入。\n\n## 1.代码目录说明\n\nSDK基本目录结构如下:\n\n```tree\n ├── CMakeLists.txt\n ├── common\n ├── config.h\n ├── examples\n ├── onenet\n │ ├── platforms\n │ ├── protocols\n │ └── security\n └── tools\n```\n\n| 目录名 | 说明 |\n| :-------: | ---------------------------------------------------------------- |\n| common | 主要包括一些常用的工具或算法接口封装，与系统平台无关 |\n| examples | 主要包括示例代码，分别对应到不同的接入协议 |\n| onenet | 主要包含平台接入协议相关代码，其中iot目录包含通用平台接入，tm目录包含物模型接入，utils目录包含一部分通用接口封装 |\n| onenet/platforms | 主要包含系统适配层的内容，由include目录内的头文件定义适配接口，其它目录（例如图示linux）则包含对应平台的适配实现代码 |\n|onenet/protocols | 主要包含应用协议层的内容，集成了两个开源协议栈和一个简单的HTTP功能接口库 |\n| onenet/security | 主要包含安全相关的接口封装，目前仅TLS接口实现。 |\n| tools | 主要包含一些开源工具或工具类接口封装 |\n\n## 2.适配接口说明\n\n在用户集成适配SDK场景中，SDK底层进行了相关接口封装，定义了一套统一的头文件接口，只需要按照统一接口进行适配，便可以实现终端快速与平台进行交互。\n\n### 2.1系统资源接口\n\nSDK已提供标准接口，用户需根据系统环境自行测试适配，对于部分无法编译通过的函数，用户需自行实现。\n\n系统资源接口如下，详情请参见SDK中的文件（[获取SDK](/doc/v5/fuse/detail/215)），文件路径：`onenet/platforms/include/plat_osl.h`\n\n|

接口

说明

接口

说明

接口

说明

|\n| :--------------------------------: | :--------------------------------: |\n| plat_tcp_connect | 连接指定网络地址 |\n| plat_tcp_send | 通过已建立的TCP连接发送数据 |\n| plat_tcp_recv | 通过已建立的TCP连接接收数据 |\n| plat_tcp_disconnect | 断开已建立的TCP连接 |\n\n### 2.4UDP通信接口\n\nUDP接口主要用于物模型接入的CoAP方式，其它接入方式无需移植。\n\nUDP通信接口如下，详情请参见SDK中的文件（[获取SDK](/doc/v5/fuse/detail/215)），文件路径：`onenet/platforms/include/plat_udp.h`。\n\n|

接口

说明

接口

说明

|\n| :--------------------------------: | :--------------------------------: |\n| uart_open | 以指定参数打开串口，返回串口操作句柄 |\n| uart_send | 通过已打开的串口发送数据 |\n| uart_recv | 通过已打开的串口接收数据 |\n| uart_close | 关闭已打开的串口 |\n## 3.物模型SDK开发\n\n提供代码默认在Linux系统下构造，请根据自身系统适配相关接口，详情参见上文“**2.适配接口说明**”\n\n获取SDK后，在本地Linux环境中使用命令完成解压，解压后可以看到Linux本地。文件详细信息如下：\n\n```tree\n ├── CMakeLists.txt\n ├── common\n ├── config.h\n ├── examples\n ├── onenet\n │ ├── platforms\n │ ├── protocols\n │ └── security\n └── tools\n```\n\n在通过示例代码与物联网平台通信之前，需要将example下的main.c中的设备参数修改为您已创建成功的设备信息，完成后保存退出。\n\n如下所示，在此处填入产品ID、设备名称、设备key。\n\n```c\n/** OneNET平台产品ID*/\n#define PRODUCT_ID \"\"\n/** 设备唯一识别码，产品内唯一*/\n#define DEVICE_NAME \"\"\n/** 认证信息--设备key*/\n#define ACCESS_KEY \"\"\n```\n\n用户可根据需要自定义token的访问有效期（即过期时间），本示例默认为2030-12-31日。\n\n```c\n/** token有效时间，默认设置为2030年12月*/\n#define EXPIRE_TIME 1924833600\n```\n\n用户在平台端获取的设备SDK中，已包括平台根据设备所属产品的物模型自动生成的tm_user.c和tm_user.h文件（修改物模型后，会重新生成tm_user文件，需要重新获取新的SDK），需要用户根据根据自己的实际业务在tm_user.c文件中处理平台数据下发（读属性点、写属性点、服务调用）命令或者数据上报。\n\n修改完成后在示例代码目录，执行cmake命令，生成makefile文件；执行make指令编译示例程序。\n\n```shell\nmkdir build # 创建build文件夹\ncd build # 进入build文件夹\ncmake .. # 以../目录下的CMakeLists.txt生成makefile\nmake # 编译\n./mqtts_onejson_soc #执行,以MQTT协议为例\n```\n\nOneNET平台提供了调试工具，可以方便的与设备进行交互，了解如何进行[设备调试](/doc/v5/fuse/detail/253)。\n\n![](https://upfiles.heclouds.com/portal5-admin/portal5-admin/2022/12/01/2edc7fa285a1959de07b1a1589dd8c25.png)\n\n## 4.数据流SDK开发\n\n提供代码默认在Linux系统下构造，请根据自身系统适配相关接口，详情参见上文“**2.适配接口说明**”\n\n获取SDK后，在本地Linux环境中使用命令完成解压，解压后可以看到Linux本地。文件详细信息如下：\n\n```tree\n ├── CMakeLists.txt\n ├── common\n ├── config.h\n ├── examples\n ├── onenet\n │ ├── platforms\n │ ├── protocols\n │ └── security\n └── tools\n```\n\n在通过示例代码与物联网平台通信之前，需要将example下的main.c中的设备参数修改为您已创建成功的设备信息，完成后保存退出。\n\n如下所示，在此处填入产品ID、设备名称、设备key。\n\n```c\n/** OneNET平台产品ID*/\n#define PRODUCT_ID \"\"\n/** 设备唯一识别码，产品内唯一*/\n#define DEVICE_NAME \"\"\n/** 认证信息--设备key*/\n#define ACCESS_KEY \"\"\n```\n\n用户可根据需要自定义token的访问有效期（即过期时间），本示例默认为2030-12-31日。\n\n```c\n/** token有效时间，默认设置为2030年12月*/\n#define EXPIRE_TIME 1924833600\n```\n\n修改完成后在示例代码目录，执行cmake命令，生成makefile文件；执行make指令编译示例程序。\n\n```shell\nmkdir build #创建build文件夹\ncd build #进入build文件夹\ncmake .. #以../目录下的CMakeLists.txt生成makefile\nmake #编译\n./mqtts_stream_soc #执行,以MQTT协议为例\n```\n\n您可以在「设备管理」菜单栏，选择使用数据流接入的设备，点击「设备详情」进行查看，获取示例上传的默认数据内容。\n\n![](https://upfiles.heclouds.com/portal5-admin/portal5-admin/2022/12/01/91dd73a1e6e867cf084603fe627ae63a.png)\n\n![](https://upfiles.heclouds.com/portal5-admin/portal5-admin/2022/12/01/472480be7a3bd65dbd9cbf5f39782536.png)"}, "zh_HK": {"title": "設備接入SDK開發", "content": "OneNET平台提供基於c語言的設備接入SDK，適用於MCU+標準通信模組以及單板SOC的方案。SDK由固定代碼包和平台生成的配置文件構成，您可以在Linux系統中直接編譯后獨立運行，或者根據您使用的硬件平台集成SDK使用，實現OneNET 平台的快速接入。\n\n## 1.代碼目錄說明\n\nSDK基本目錄結構如下:\n\n```tree\n ├── CMakeLists.txt\n ├── common\n ├── config.h\n ├── examples\n ├── onenet\n │ ├── platforms\n │ ├── protocols\n │ └── security\n └── tools\n```\n\n| 目錄名 | 說明 |\n| :-------: | ---------------------------------------------------------------- |\n| common | 主要包括一些常用的工具或算法接口封裝，與系統平台無關 |\n| examples | 主要包括示例代碼，分別對應到不同的接入協議 |\n| onenet | 主要包含平台接入協議相關代碼，其中iot目錄包含通用平台接入，tm目錄包含物模型接入，utils目錄包含一部分通用接口封裝 |\n| onenet/platforms | 主要包含系統適配層的內容，由include目錄內的頭文件定義適配接口，其它目錄（例如圖示linux）則包含對應平台的適配實現代碼 |\n|onenet/protocols | 主要包含應用協議層的內容，集成了兩個開源協議棧和一個簡單的HTTP功能接口庫 |\n| onenet/security | 主要包含安全相關的接口封裝，目前僅TLS接口實現。 |\n| tools | 主要包含一些開源工具或工具類接口封裝 |\n\n## 2.適配接口說明\n\n在用戶集成適配SDK場景中，SDK底層進行了相關接口封裝，定義了一套統一的頭文件接口，只需要按照統一接口進行適配，便可以實現終端快速與平台進行交互。\n\n### 2.1系統資源接口\n\nSDK已提供標準接口，用戶需根據系統環境自行測試適配，對於部分無法編譯通過的函數，用戶需自行實現。\n\n系統資源接口如下，詳情請參見SDK中的文件（[獲取SDK](/doc/v5/fuse/detail/215)），文件路徑：`onenet/platforms/include/plat_osl.h`\n\n|

接口

說明

接口

說明

接口

說明

|\n| :--------------------------------: | :--------------------------------: |\n| plat_tcp_connect | 連接指定網絡地址 |\n| plat_tcp_send | 通過已建立的TCP連接發送數據 |\n| plat_tcp_recv | 通過已建立的TCP連接接收數據 |\n| plat_tcp_disconnect | 斷開已建立的TCP連接 |\n\n### 2.4UDP通信接口\n\nUDP接口主要用於物模型接入的CoAP方式，其它接入方式無需移植。\n\nUDP通信接口如下，詳情請參見SDK中的文件（[獲取SDK](/doc/v5/fuse/detail/215)），文件路徑：`onenet/platforms/include/plat_udp.h`。\n\n|

接口

說明

接口

說明

|\n| :--------------------------------: | :--------------------------------: |\n| uart_open | 以指定參數打開串口，返回串口操作句柄 |\n| uart_send | 通過已打開的串口發送數據 |\n| uart_recv | 通過已打開的串口接收數據 |\n| uart_close | 關閉已打開的串口 |\n## 3.物模型SDK開發\n\n提供代碼默認在Linux系統下構造，請根據自身系統適配相關接口，詳情參見上文“**2.適配接口說明**”\n\n獲取SDK后，在本地Linux環境中使用命令完成解壓，解壓后可以看到Linux本地。文件詳細信息如下：\n\n```tree\n ├── CMakeLists.txt\n ├── common\n ├── config.h\n ├── examples\n ├── onenet\n │ ├── platforms\n │ ├── protocols\n │ └── security\n └── tools\n```\n\n在通過示例代碼與物聯網平台通信之前，需要將example下的main.c中的設備參數修改為您已創建成功的設備信息，完成后保存退出。\n\n如下所示，在此處填入產品ID、設備名稱、設備key。\n\n```c\n/** OneNET平台產品ID*/\n#define PRODUCT_ID \"\"\n/** 設備唯一識別碼，產品內唯一*/\n#define DEVICE_NAME \"\"\n/** 認證信息--設備key*/\n#define ACCESS_KEY \"\"\n```\n\n用戶可根據需要自定義token的訪問有效期（即過期時間），本示例默認為2030-12-31日。\n\n```c\n/** token有效時間，默認設置為2030年12月*/\n#define EXPIRE_TIME 1924833600\n```\n\n用戶在平台端獲取的設備SDK中，已包括平台根據設備所屬產品的物模型自動生成的tm_user.c和tm_user.h文件（修改物模型後，會重新生成tm_user文件，需要重新獲取新的SDK），需要用戶根據根據自己的實際業務在tm_user.c文件中處理平台數據下發（讀屬性點、寫屬性點、服務調用）命令或者數據上報。\n\n修改完成后在示例代碼目錄，執行cmake命令，生成makefile文件；執行make指令編譯示例程序。\n\n```shell\nmkdir build # 創建build文件夾\ncd build # 進入build文件夾\ncmake .. # 以../目錄下的CMakeLists.txt生成makefile\nmake # 編譯\n./mqtts_onejson_soc #執行,以MQTT協議為例\n```\n\nOneNET平台提供了調試工具，可以方便的與設備進行交互，了解如何進行[設備調試](/doc/v5/fuse/detail/253)。\n\n![](/fuse/middlelayer/file/download?file=XAGYPfbSS6nDDUHyM8tN.png)\n\n## 4.數據流SDK開發\n\n提供代碼默認在Linux系統下構造，請根據自身系統適配相關接口，詳情參見上文“**2.適配接口說明**”\n\n獲取SDK后，在本地Linux環境中使用命令完成解壓，解壓后可以看到Linux本地。文件詳細信息如下：\n\n```tree\n ├── CMakeLists.txt\n ├── common\n ├── config.h\n ├── examples\n ├── onenet\n │ ├── platforms\n │ ├── protocols\n │ └── security\n └── tools\n```\n\n在通過示例代碼與物聯網平台通信之前，需要將example下的main.c中的設備參數修改為您已創建成功的設備信息，完成后保存退出。\n\n如下所示，在此處填入產品ID、設備名稱、設備key。\n\n```c\n/** OneNET平台產品ID*/\n#define PRODUCT_ID \"\"\n/** 設備唯一識別碼，產品內唯一*/\n#define DEVICE_NAME \"\"\n/** 認證信息--設備key*/\n#define ACCESS_KEY \"\"\n```\n\n用戶可根據需要自定義token的訪問有效期（即過期時間），本示例默認為2030-12-31日。\n\n```c\n/** token有效時間，默認設置為2030年12月*/\n#define EXPIRE_TIME 1924833600\n```\n\n修改完成后在示例代碼目錄，執行cmake命令，生成makefile文件；執行make指令編譯示例程序。\n\n```shell\nmkdir build #創建build文件夾\ncd build #進入build文件夾\ncmake .. #以../目錄下的CMakeLists.txt生成makefile\nmake #編譯\n./mqtts_stream_soc #執行,以MQTT協議為例\n```\n\n您可以在「設備管理」菜單欄，選擇使用數據流接入的設備，點擊「設備詳情」進行查看，獲取示例上傳的默認數據內容。\n\n![](/fuse/middlelayer/file/download?file=CVYW9S1PMjL7vCcGwK4e.png)\n\n![](/fuse/middlelayer/file/download?file=qDh4Qh3jmlS2AsCnFACe.png)"}}