设备接入 IOTDA-离线开发产品模型:设备能力定义样例
设备能力定义样例
devicetype-capability.json记录了该设备的基础信息:
{ "devices": [ { "manufacturerId": "TestUtf8ManuId", "manufacturerName": "HZYB", "protocolType": "CoAP", "deviceType": "WaterMeter", "omCapability":{ "upgradeCapability" : { "supportUpgrade":true, "upgradeProtocolType":"PCP" }, "fwUpgradeCapability" : { "supportUpgrade":true, "upgradeProtocolType":"LWM2M" }, "configCapability" : { "supportConfig":true, "configMethod":"file", "defaultConfigFile": { "waterMeterInfo" : { "waterMeterPirTime" : "300" } } } }, "serviceTypeCapabilities": [ { "serviceId": "WaterMeterBasic", "serviceType": "WaterMeterBasic", "option": "Mandatory" }, { "serviceId": "WaterMeterAlarm", "serviceType": "WaterMeterAlarm", "option": "Mandatory" }, { "serviceId": "Battery", "serviceType": "Battery", "option": "Optional" }, { "serviceId": "DeliverySchedule", "serviceType": "DeliverySchedule", "option": "Mandatory" }, { "serviceId": "Connectivity", "serviceType": "Connectivity", "option": "Mandatory" } ] } ] }
各字段的解释:
字段 |
子字段 |
可选/必选 |
描述 |
|
---|---|---|---|---|
devices |
- |
- |
必选 |
包含了一个设备的完整能力信息(根节点不能修改)。 |
- |
manufacturerId |
- |
可选 |
指示设备的制造商ID。 |
- |
manufacturerName |
- |
必选 |
指示设备的制造商名称 (只允许英文)。 |
- |
protocolType |
- |
必选 |
指示设备接入 物联网平台 的协议类型。如NB-IoT的设备取值为CoAP。 |
- |
deviceType |
- |
必选 |
指示设备的类型。 |
- |
omCapability |
- |
可选 |
定义设备的软件升级、固件升级和配置更新的能力,字段含义详情见下文中的:omCapability结构描述。 如果设备不涉及软件/固件升级,本字段可以删除。 |
- |
serviceTypeCapabilities |
- |
必选 |
包含了设备具备的服务能力描述。 |
- |
- |
serviceId |
必选 |
服务的Id,如果设备中同类型的服务类型只有一个则serviceId与serviceType相同, 如果有多个则增加编号,如三键开关 Switch01、Switch02、Switch03。 |
- |
- |
serviceType |
必选 |
服务类型,与servicetype-capability.json中serviceType字段保持一致。 |
- |
- |
option |
必选 |
标识服务字段的类型,取值范围:Master(主服务), Mandatory(必选服务), Optional(可选服务)。 目前本字段为非功能性字段,仅起到描述作用。 |
omCapability结构描述
字段 |
子字段 |
可选/必选 |
描述 |
---|---|---|---|
upgradeCapability |
- |
可选 |
设备软件升级能力。 |
- |
supportUpgrade |
可选 |
true:设备支持软件升级。 false:设备不支持软件升级。 |
- |
upgradeProtocolType |
可选 |
升级使用的协议类型,此处不同于设备的protocolType,例如CoAP设备软件升级协议使用PCP。 |
fwUpgradeCapability |
- |
可选 |
设备固件升级能力。 |
- |
supportUpgrade |
可选 |
true:设备支持固件升级。 false:设备不支持固件升级。 |
- |
upgradeProtocolType |
可选 |
升级使用的协议类型,此处不同于设备的protocolType,当前物联网平台仅支持LWM2M固件升级。 |
configCapability |
- |
可选 |
设备配置更新能力。 |
- |
supportConfig |
可选 |
true:设备支持配置更新。 false:设备不支持配置更新。 |
- |
configMethod |
可选 |
file:使用文件的方式下发配置更新。 |
- |
defaultConfigFile |
可选 |
设备默认配置信息(Json格式),具体配置信息由设备商自定义。物联网平台只储存该信息供下发时使用,不解析处理配置字段的具体含义。 |