OneNET文档中心

接入流程

一 概述

1.1 协议概述

OneNET的私有接入协议RGMP(remote gateway management protocol)和公开协议最大的不同是平台不提供协议的报文说明,平台将根据开发者定义的设备数据模型自动生成SDK源码,开发者将SDK嵌入到设备中,实现与平台的对接。私有协议具有业务数据格式灵活、数据传输紧凑高效以及实时性高等优点,其主要功能如下:

  • 设备上电后自动注册激活(无需提前分配设备标识)

  • 上传设备传感器数据

  • 上传设备事件

  • 远程配置设备程序

  • 远程控制设备(发送通知信息)

  • OTA

二 快速开始

OneNET的私有接入协议是OneNET3.0的新增功能,相比公开协议来说,私有协议的功能更完整和强大。在私有协议的相关开发中,开发者不再需要去了解协议的底层细节,平台以提供SDK的方式供开发者使用,下面将详细介绍,让您可以更加快速的创建OneNET私有协议产品。

Step1 创建产品

使用已注册的平台帐号登录OneNET3.0,平台首页页面如下图所示。

图1 OneNET3.0平台首页


点击平台首页右上角的“开发者中心”进入产品列表,根据协议类别产品分为公开协议产品和私有协议产品,如下图所示。

图2 产品列表


点击选择“私有协议产品”菜单切换到私有协议产品列表,然后点击选择右侧的“创建产品”按钮,进入私有产品创建页面,如下图所示。

图3 创建私有产品


填写并选择创建产品的相关信息,需要注意的是设备接入方式选择私有协议,其他选项用户可根据自己的产品特性选择,点击“确定”按钮,弹出创建成功对话框,如下图所示。

图4 创建私有产品成功


点击“进入产品详情”按钮,进入产品信息管理页面,如下图所示。

图5 产品详情页面


Step2 模板定义

打开“Step1 创建产品”中建立的MyTest的产品管理页面,点击展开左侧的“产品开发”菜单,共有“模板定义”、“SDK生成”及“在线调试”三个子菜单,如下图所示。

图6 模板定义入口


点击“模板定义”菜单,进入模板定义页面,如下图所示,共有设备档案、配置文件、通知、设备事件以及传感器数据五种类型的模板。设备就是通过这五种模板来完成和平台之间的数据交互的。

图7 模板定义管理页面


(1)设备档案模板定义

设备档案模板实际上就是一个产品的属性集,由于一个产品包括有很多个接入设备,那么平台怎么来区分这些设备呢?这就要求设备档案模板中某个属性的值在该产品下是全局唯一的,实际中常以设备的生产序列号或者设备的MAC地址来作为设备档案模板的属性字段来提供。

下面我们来新建一个设备档案模板,选择模板定义页面的“设备档案”,然后点击右侧的“创建模板”按钮,如下图所示。

图8 创建模板


进入设备档案模板定义页面,输入设备档案模板的版本名称,任意创建了3个名为a、b、c,类型分别为String、Int、Float的模板属性,如下图所示。

图9 模板定义


点击“保存”按钮,完成设备档案模板的定义。

(2)配置文件模板定义

配置文件模板主要是平台用来更改设备运行时的一些配置参数,实现设备参数的远程配置,更方便于设备的实际部署。

依照设备档案模板的类似操作方法,同样创建一个具有3个属性的配置文件模板,属性名分别为a、b、c,类型分别为String、Int、Float的模板属性,这里不再重复操作过程。

(3)通知模板定义

通知模板主要是平台用来向设备推送通知,平台可以以单个设备或者设备分组的形式向设备推送通知,同时也支持向离线设备推送通知,利用平台的通知推送功能,可以实现对设备的远程命令控制。

依照设备档案模板的类似操作方法,同样创建一个具有3个属性的通知模板,属性名分别为a、b、c,类型分别为String、Int、Float的模板属性,这里不再重复操作过程。

(4)设备事件模板定义

设备事件模板主要是设备用来向平台上传设备在运行过程的一些事件信息,比如设备运行过程中的断电重启,传感器数据超限报警等事件信息。

依照设备档案模板的类似操作方法,同样创建一个具有3个属性的设备事件模板,属性名分别为a、b、c,类型分别为String、Int、Float的模板属性,这里不再重复操作过程。

(5)传感器数据模板定义

传感器数据模板主要是设备用来向平台上传设备采集的传感器数据,需要注意的是,有时设备为了功耗考虑,一次上传多个时间点采集的数据,这时需要上传数据采集的时间戳信息,否则平台认为这些数据是同一个时间点的。

依照设备档案模板的类似操作方法,同样创建一个具有3个属性的传感器数据模板,属性名分别为a、b、c,类型分别为String、Int、Float的模板属性,这里不再重复操作过程。

Step3 生成SDK

用户在创建定义好自己的数据模板之后,就可以在平台生成对应的SDK了,点击产品信息管理页面的右侧菜单“产品开发”,选择“SDK生成”子菜单,如下图所示。 

图10 SDK模板选项


选择已定义好的数据模板的正确版本,点击“生成正式SDK”按钮,弹出一个“是否确认生成”的对话框,如下图所示。

图11 SDK生成


点击“确定”按钮,对平台生产的SDK进行保存,如下图所示。

图12 SDK保存

生成的SDK可供设备后续的移植开发及调试使用。

Step4 移植并开发应用

详情请看“SDK移植方法”、“SDK使用方法”和“SDK移植应用示例”