版权说明:本文档由用户提供并上传,收益归属内容提供方,若内容存在侵权,请进行举报或认领
文档简介
引言
当前农村人居环境长效管护平台接入的物联网监测平台较多,涉及设备品牌繁多,各厂家平台及设
备数据标准不一,从而导致对接成本、维护成本、运营成本的增加,制约了平台的快速建设推广。为有
效加强全省农村人居环境长效管护平台建设的统一规划、统一管理、协调运行和维护服务,建立健全全
省农村人居环境长效管护平台的数据交换规范标准,推动农村人居环境长效管护平台的建设运营有序发
展,提升各级政府及其部门的农村人居环境治理水平,现根据国家、地方相关文件要求和标准规范,结
合我省农村人居环境治理现状和发展要求,制定本规范。
农村人居环境长效管护平台数据交换规范
1范围
本标准规定了江西省农村人居环境长效管护平台数据交换的相关术语和定义、设计要求及接口要求。
本标准适用于江西省农村人居环境长效管护平台设计规范。
2规范性引用文件
下列文件对于本文件的应用是必不可少的。凡是注日期的引用文件,仅所注日期的版本适用于本文
件。凡是不注日期的引用文件,其最新版本(包括所有的修改单)适用于本文件。
GB/T29765-2021信息安全技术数据备份与恢复产品技术要求与测试评价方法
GB/T20271信息安全技术信息系统通用安全技术要求
GB/T20273-2019信息安全技术数据库管理系统安全技术要求
GB/T31496-2015信息技术安全技术信息安全管理体系实施指南
GB/T21063.6政务信息资源目录体系第6部分:技术管理要求
GB/T15629信息技术系统间远程通信和信息交换局域网和城域网
GB/T28181-2016安全防范视频监控联网系统信息传输、交换、控制技术要求
DB36/T981-2017电子政务共享数据统一交换平台技术规范
DB36/T984—2017政务服务网集成对接规范
DB36/T1179—2019政务数据共享技术规范
GB/T33745-2017物联网术语
GB/T36478.1-2018信息交换和共享
3术语和定义
GB/T33745-2017.GB/T36478.1-2018界定的以及下列术语和定义适用于本文件。
3.1农村人居环境长效管护平台(RuraIIivingenvironmentlong-termmanagementpIatform)
采用物联网、云计算、大数据、AI等新一代信息技术,通过数字化技术驱动农村人居环境有效治
理,实现农村人居环境长效管护数字化、环境监测智能化、公众监督便捷化。平台集“投诉、整改、反
馈、监督”等功能为一体,以实现农村人居环境持续改善及治理长效管护为目的,推动乡村由“一时美”
向“持久美”转变。
3.2物联网监测数据共享模块/系统(I0TmonitoringdatasharingmoduIe/system)
物联网监测数据共享模块/系统(以下简称“共享平台”),是面向农村人居环境进行智能化监测的
传感设备,这些设备的动态监测数据统一存储在农村人居环境长效管护平台,并建立数据共享模块来提
供数据服务。
4概述
依据国标GB/r33745-2018中的规定,交换和共享数据模块/系统既可以是物联网系统中的一个功
能模块,也可以是一个独立的系统,通过数据接口方式,数据提供方通过物联网系统将交换和共享的数
据导入到对应的模块/系统;数据需求方从物联网相应模块/系统获取物联网数据,数据接口如图1所示。
图1数据接口
5接口要求
5.1约定
本章给出了共享平台的基本接口方法、参数。接口应与物联网系统的软件平台无关,接口宜采用
WebService技术实现。以下接口描述,只规定了共享平台实现的基本接口方法、参数项目、参数类型、
参数格式及命名规范。
为便于提供方和需求方统一调用数据,接口方法和参数宜采用英文命名。
6接口设计规范
6.1基本规范
接口地址:http://xxx.xxx.xxx.xxx:xxxx/。
接口协议:WebServiceo
编码方式:UTF-8o
交换格式:JSONo
6.2返回错误码code
接口错误码返回标准规范见表1:
表1:返回错误码code及描述
参数名code值描述
0成功
999失败
1111正在处理
7设备数据上报频次规范
7.1数据上报频次
智能垃圾桶:6小时/条,或12小时/条。
水质监测设备:6小时/条,或12小时/条。
气味探测器:6小时/条,或12小时/条。
车载/卡牌:1分钟以上/条。
环境探测器:6小时/条。
8数据提供方
8.1身份认证
8.1.1获取令牌接口
接口方法:getToken。
接口路径:api/open/oauth/o
请求方式:POSTo
请求参数:见表2。
表2getToken
参数名必选类型说明
app_id是string由平台颁发
app_secret是string由平台颁发
返回示例:见附录A.1。
8.2设备管理
8.2.1产品列表
简要描述:获取农村人居环境长效管护平台标准物联网产品。
接口方法:getProductListo
接口路径:api/open/product/o
请求方式:POSTo
参数:见表3。
表3getProductList
报头参数名必选类型说明
token是String通信证key
参数名必选类型说明
productName否string产品名称
产品协议:Integer,产品协议:1.T-LINK协议2.MQTT协
议3.LWM2M协议4.TUP协议5.HTTP协议6.JT/T808
productProtocol否Integer
7.TCP协议8.私有TCP(网关子设备协议)9.私有UDP(网关
子设备协议)10.网关产品MQTT(网关产品协议)1L南向云
productld是Int产品id
返回示例:见附录A.2。
8.2.2设备列表
简要描述:获取农村人居环境长效管护平台设备列表。
接口方法:getDeviceListo
接口路径:api/open/device/o
请求方式:POSTo
请求参数:见表4。
表4gelDeviceList
报头参数名必选类型说明
Token是String通信证key
参数名必选类型说明
netStatus否Int设备状态
deviceNo否String设备编号
productld是String产品id
gridCode是String区域code
返回示例:见附录A.3。
8.2.3新建产品
简要描述:添加产品(产品为设备直连+非NB网关协议)。
接口方法:CreateProducto
接口路径:api/open/product/o
请求方式:POSTo
请求参数:见表5。
表5CreateProduct
报头参数名必选类型说明
Token是String通信证key
请求body(数据类型application/json;charset=utf-8)
naccessType":1,
MauthTypeH:0,
MdataEncryption":0,
MdeviceModeln:"string'1,
nencryptionTypen:0,
nendpointFormat":0,
"lwm2mEdrxTimen:null,
nmanufacturerld":"string",
"networkType":0,
"nodeType":1,
"payloadFormat":0,
MpowerModel":0,
"productDesc":"string",
"productName":"string”,
"productProtocol":0,
"productType1":"string'1,
"secondaryType":"string",
''thirdType":"string”,
"tupIsThrough":0,
"tupDeviceModel":"string"
)
描述:
productName:产品名称(必填):产品名称最多64个字符,产品名称必须包含数字或字
母或汉字,产品名称不能重复
productType:产品分类(必填)
secondaryType:二级分类(必填)
thirdType:三级分类(必填)
nodeType:节点类型(必填):1.设备,2.网关
accessType:接入类型(必填):1.设备直连,2.网关接入,3.南向云接入(只支持1)
networkType:网络类型(必填):1.WIFI,2.移动蜂窝数据3.NB・IoT,4.以太网,5.蓝牙,6.ZigBee
(只支持1/2/3/4)
productprotocol:产品协议(必填):只支持1.T-LINK协议2.MQTT协议3.LWM2M协议
5.HTTP协议6.JT/T8087.TCP协议10.网关MQTT协议
authType:认证方式1:特征串认证2sM9认证,3:证书认证,4:IMEI认证,5:SIMID认证,
6:SM2认证,7:IPV6标识认证
payloadFormat:消息格式l:json,2:紧凑二进制
dataEncryption:数据加密方式I:sml,2:sm2,3:sm4,4:dtls,5:明文(只支持MQTT/LWM2M)
encryptionType:安全类型(只支持MQTT,TCP协议)0:一机一密,1:一型一密
tupIsThrough:是否透传:0.透传,1不透传(JT/T808,tcp协议,只有透传,消息格式必
须只能传null)
deviceModel:JT/T808协议设备型号
manufacturerld:JT/T808协议制造商ID
endpointFormat:Endpoint格式(LWM2M协议必
+古\.1IR/fDTCITDM.INITDM.TIkifCTIK4CI.
返回示例:见附录A.4。
8.2.4删除产品
简要描述:删除产品数据,如果产品下有设备数据,则无法删除产品。
接口方法:deleteProduct。
接口路径:api/open/product/。
请求方式:Deleteo
请求参数:见表6。
表6deleteProduct
报头参数名必选类型说明
token是String通信证key
MasterKey是stringMasterKey在该设备所属产品的概况中可以查看
报体参数名必选类型说明
productld是Int产品id
gridCode是String区域code
返回示例:见附录A.5
8.2.5更新产品
简要描述:更新产品数据。
接口方法:updateProduct。
接口路径:api/open/product/o
请求方式:puto
请求参数:见表7。
表7updateProduct
报头参数名必选类型说明
token是String通信证key
报体参数名必选类型说明
gridCode是String区域code
请求body(数据类型application/json;charset=utf-8)
〃endpointFormat〃:null,
“powerModel〃:null,
〃productDesc〃:“string”,
“productId”:0,
“productName":"string”,
“lwm2mEdrxTime”:null
)
描述:
productld:产品ID,必填
productName:产品名称,产品名称租户内不能重复,必填
productDesc:产品描述,选填
endpointFormat:endpoint类型(Lwm2m协议必填)1.IMEI2.URN:IMEI:###############
3.URN:IMEI-IMSI:触#############-###############4.URN:IMEI+SM9
注:认证方式为SM9认证时,endpoint类型为4
认证方式为IMEI认证、sm2认证时,endpoint类型为1、2、3
powerModel:省电模式(Lwm2m协议必填)1.PSM2.DRX3.eDRX
lwm2mEdrxTime:eDRX模式时间窗(LWM2M协议,当省电模式为3时,必填):20〜10485.76间的值,精确
到小数点后两位
返回示例:见附录A.6。
8.2.6创建设备
简要描述:增加设备。
接口方法:CreateDevice。
接口路径:api/open/device/o
请求方式:POST。
请求参数:见表8。
表8CreateDevice
报头参数名必选类型说明
token是String通信证key
报体参数名必选类型说明
MasterKey是StringMasterKey在该设备所属产品的概况中可以查看
gridCode是String区域code
deviseName是String设备名称
deviceSn是String设备编号
Imei是StringImei号
productld是Int产品id
operator是String操作人
返回示例:见附录A.7。
8.2.7删除设备
简要描述:删除设备数据。
接口方法:deleteDevice。
接口路径:api/open/device/o
请求方式:Deleteo
请求参数:见表9。
表9deleteDevice
报头参数名必选类型说明
token是String通信证key
报体参数名必选类型说明
productId是Int产品id
可以删除多个设备(最多支持200个设备)。多个设备id,
devicelds是string
中间以逗号”/隔开。
MasterKey是StringMasterKey在该设备所属产品的概况中可以查看
gridCode是String区域code
返回示例:见附录A.8
8.2.8更新设备
简要描述:更新设备数据。
接口方法:updateDeviceo
接口路径:api/open/device/o
请求方式:PUTo
请求参数:见表10。
表10updateDevice
报头参数名必选类型说明
token是String通信证key
MasterKey是String
请求参数名必选类型说明
gridCode是String区域code
请求body(数据类型application/json;charset=utf-8)
"deviceName":"string',,
''operator1':"string”,
"other":{"autoObserver":0,
,,imsi,':,,1254515487845r,},
"productld":0
)
描述:
deviceName:设备名称,选填
operator:操作者,必填
other:LWM2M协议必填参数,其他协议不填:{
autoObserverO自动订阅1.取消自动订阅,订阅指的是平台订阅设备能够上报的
object数据选填;
imsi:总长度不超过15位,使用0~9的数字,String类型选填;
)
productld:产品ID,必填
返回示例:见附录A.9
8.2.9获取物模型
简要描述:查询属性列表信息,获取标准数据参数名称及数据类型
接口方法:QueryPropertyList
接口路径:api/open/model/properties/
请求方式:GET
请求参数:见表11。
表11QueryPropertyList
报头参数名必选类型说明
token是String通行证key
MasterKey是StringMasterKey在该设备所属产品的概况中可以查看
报体参数名必选类型说明
productld是Int产品Id
searchValue否String可填值:属性名称,属性
gridCode否String区域code
pageNow否Int当前页数
pageSize否Int每页记录数
返回示例:见附录A.10
8.2.10获取标准产品物模型
简要描述:标准农村人居环境长效管护平台标准物模型。
接口方法:QueryStandardModel»
接口路径:api/open/standardModel/o
请求方式:GET。
请求参数:见表12。
表12QueryStandardModel
报头参数名必选类型说明
token是String通信证key
MasterKey是StringMasterKey在该设备所属产品的概况中可以查看
报体参数名必选类型说明
standardversion否String标准物模型版本号
thirdType否Int三级分类id
返回示例:见附录A.11。
8.2.11获取服务列表信息
简要描述:获取农村人居环境长效管护平台服务列表信息。
接口方法:QueryPropertyListo
接口路径:api/open/model/properties/o
请求方式:GET。
请求参数:见表13。
表13QueryPropertyList
报头参数名必选类型说明
token是String通信证key
MasterKey是StringMasterKey在该设备所属产品的概况中可以查看
报体参数名必选类型说明
productld是Int产品Id
可填值:属性名称,属性标
searchValue否String
识符
gridCode是String区域code
pageNow否Int当前页数
pageSize否Int每页记录数
8.2.12智能垃圾桶数据上报
简要描述:智能垃圾桶设备上报数据。
接口方法:uploadRubbishData。
接口路径:api/open/uploadData/0
请求方式:Posto
请求参数:见表14。
表14uploadRubbishData
报头参数名必选类型说明
token是String通信证key
报体参数名必选类型说明
body是String智能垃圾桶标准物模型
请求Body(数据类型application/json;charset=utf-8)
"deviceld11:nbe04c3519c5740clb82fe0fceb9d2e82M,
nuploadTimeu:"2021-07-1916:29:41",
“latitude":“0.0”,
"longitude":“0.0”,
nerrorCodeu:“0000”,
nfireState":M0",
ntiltAngleu:“0",
“powerState":"0H,
''temperature":24,
"deviceState":null,
nbatteryValueM:0,
"locationFlag":null,
"fireThreshold":0,
nfullThresholdn:0,
”由[Threshold”:null,
"batteryVoltage":3.63,
npowerThresholdn:0,
nfullState":n0n,
“inclinestate“:“0“,
“high”:464,
"deviceNo":null,
"imei":null
返回示例:见附录A.13。
8.2.13人员卡牌设备数据上报
简要描述:卡牌设备上报数据。
接口方法:uploadCardData。
接口路径:api/open/uploadData/。
请求方式:Posto
请求参数:见表15。
表15uploadCardData
报头参数名必选类型说明
Token是String通信证key
报体参数名必选类型说明
body是String人员卡牌标准物模型
请求body
HdeviceIdM:ue978a25e8c6d4e9fbe9286cedc6aedcdH,
"uploadTime'1:null,
1•longitude":*'114.1700000",
"latitude":"26.4400000”,
“speed":2,
"direction'1:null,
"signal":null,
“battery“:“31”,
"gpsFlag":null,
''receiveTime":n2021-07-2118:13:06.133",
ncreateTimen:M2021-07-2209:55:54”,
"heading":null,
“valid“:“0",
"imei":null
)
返回示例:见附录A.14o
8.2.14智慧厕改设备数据上报
简要描述:厕改设备上报数据。
接口方法:uploadToiletData。
接H路径:api/open/uploadData/。
请求方式:Posto
请求参数:见表16。
表16uploadToiletData
报头参数名必选类型说明
token是String通信证key
报体参数名必选类型说明
body是String智慧厕改设备标准物模型
请求body
(
"deviceld":0150677330010,
"deviceName":null,
"uploadTimen:"2021-08-2715:49:00”,
"humWoman":null,
"tempWoman":null,
"h2sWoman”:null,
“nh3Woman":null,
"hurnMan'1:"81.108642578125",
“tempMan":“28.8987979888916”,
"h2sMan":"0.0010200000833719969”,
Hnh3Manu:"0.0041188998147845270,
"squatldleWoman":0,
"squatldleMan":0,
HpfWomann:null,
'•pfiMan":null,
"createTime":null,
nimein:null
)
返回示例:见附录A.15。
8.2.15污水监测设备上报数据
简要描述:污水监测设备上报数据。
接口方法:uploadWaterData。
接口路径:api/open/uploadData/。
请求方式:Posto
请求参数:见表17。
表17uploadWaterData
报头参数名必选类型说明
token是String通信证key
报体参数名必选类型说明
body是String污水监测设备标准物模型
请求body
"deviceld":"15036215BK7201SN001625”,
',uploadTime1':M2021-08-0417:01:03",
"temperature":29,
"conductivity":1,
"turbidity":1348.2,
"phu:7.31,
ndoxygenn:5.670000076293945,
“imei”:null
)
返回示例:见附录A.16。
8.2.16车载设备数据上报
简要描述:车载设备上报数据。
接口方法:uploadCarData。
接口路径:api/open/uploadData/。
请求方式:Posto
请求参数:见表18。
表18uploadCarData
报头参数名必选类型说明
token是String通信证key
报体参数名必选类型说明
body是String车载设备标准物模型
请求body:
(
ndeviceld":na6fdce27e9844ba5b0b9f97ae7d40136n,
^uploadTime'1:"2021-04-0215:42:17”,
"batteryVoltage":360,
"batteryStatus1,:0,
"reserved":0,
ntemperature":55,
"speed":0,
“latitude”:29.384321,
,'longituden:117.23177,
"height":15,
"actualLevel'1:null,
"dataSource":null,
"syncStatus11:0,
“syncTime":null,
"alarm'1:0,
"mileage,1:0,
"recorderSpeed":0,
"gpsswitch":1,
"imeiu:null
返回示例:见附录A.17。
8.2.17空气站设备数据上报
简要描述:空气站设备上报数据。
接口方法:uploadtAirData。
接口路径:api/open/uploadData/o
请求方式:Posto
请求参数:见表19。
"deviceld":0150712180010,
"temperature":"O'1,
,'humidity":“0",
"windSpeed":“0",
nwindDirectionn:"0u,
''pressure":n0",
"uploadTime":"2021-07-2211:38:10”,
“rainfall”:null,
"dailyRainfall":null,
"lightintensity":null,
nno2u:”4.253”,
"so2n:null,
"pml0u:"32.261",
“pm25":"6.425"
返回示例:见附录A.18。
9数据需求方
9.1设备数据管理
9.1.1获取设备监测数据
简要描述:根据设备Id设备类别获取设备上报监测数据。
接口方法:getDeviceDataByldo
接口路径:api/open/device/。
请求方式:POST。
请求参数:见表20。
表20gelDeviceDataByld
报头参数名必选类型说明
token是String通行证key
参数名必选类型说明
deviceld是string设备Id
facilityCategory是string设备类别
startTime否string开始时间
endTime否string结束时间
返回示例:见附录A.19。
9.1.2获取设备原始上传数据包
简要描述:获取设备原始上传数据格式
接口方法:getBasicDataList
接口路径:api/open/basicData/
请求方式:POST
请求参数:见表21。
表21getBasicDataList
参数名必选类型说明
deviceName否string设备名称
deviceld是String设备id
gridCode是String区域code
返回示例:见附录A.20。
9.1.3获取设备上报事件信息
简要描述:获取设备上报事件信息。
接口方法:getEventBasicDataListo
接口路径:api/open/events/。
请求方式:POSTo
请求参数:见表22。
表22getEvenlBasicDataLisl
参数名必选类型说明
deviceName否string设备名称
iotEventType否string事件类型
deviceld是String设备id
gridCode是String区域code
返回示例:见附录A.21。
9.1.4获取智能垃圾桶数据
简要描述:获取智能垃圾桶设备上报数据。
接口方法:getRubbishData»
接口路径:api/open/deviceData/«
请求方式:Posto
请求参数:见表23。
表23getRubbishData
报头参数名必选类型说明
token是String通信证key
参数名必选类型说明
gridCode是String区域code
deviceld是String设备Id
返回示例:见附录A.22。
9.1.5获取人员卡牌设备数据
简要描述:获取卡牌设备上报数据。
接口方法:getCardData。
接口路径:api/open/deviceData/o
请求方式:Posto
请求参数:见表24。
请参数名必选类型说明
deviceld是String设备Id
返回示例:见附录A.23。
9.1.6获取污水监测设备数据
简要描述:获取污水监测设备上报数据。
接口方法:getWaterData。
接口路径:api/open/deviceData/o
请求方式:Posto
请求参数:见表25。
表25getWaterData
报头参数名必选类型说明
token是String通信证key
报体参数名必选类型说明
gridCode是String区域code
deviceld是String设备Id
返回示例:见附录A.24。
9.1.7获取车载设备数据
简要描述:获取车载设备上报数据。
接口方法:getCarData。
接口路径:api/open/deviceData/o
请求方式:Posto
请求参数:见表26。
表26getCarData
报头参数名必选类型说明
token是String通信证key
报体参数名必选类型说明
gridCode是String区域code
deviceld是String设备Id
返回示例:见附录A.25。
9.1.8获取智慧厕改设备数据
简要描述:获取厕改设备上报数据。
接口方法:getToiletData。
接口路径:api/open/deviceData/o
请求方式:Posto
请求参数:表27。
表27getToiletData
报头参数名必选类型说明
token是String通信证key
报体参数名必选类型说明
gridCode是String区域code
deviceld是String设备Id
返回示例:见附录A.26。
9.1.9获取空气站设备数据
简要描述:获取空气站设备上报数据。
温馨提示
- 1. 本站所有资源如无特殊说明,都需要本地电脑安装OFFICE2007和PDF阅读器。图纸软件为CAD,CAXA,PROE,UG,SolidWorks等.压缩文件请下载最新的WinRAR软件解压。
- 2. 本站的文档不包含任何第三方提供的附件图纸等,如果需要附件,请联系上传者。文件的所有权益归上传用户所有。
- 3. 本站RAR压缩包中若带图纸,网页内容里面会有图纸预览,若没有图纸预览就没有图纸。
- 4. 未经权益所有人同意不得将文件中的内容挪作商业或盈利用途。
- 5. 人人文库网仅提供信息存储空间,仅对用户上传内容的表现方式做保护处理,对用户上传分享的文档内容本身不做任何修改或编辑,并不能对任何下载内容负责。
- 6. 下载文件中如有侵权或不适当内容,请与我们联系,我们立即纠正。
- 7. 本站不保证下载资源的准确性、安全性和完整性, 同时也不承担用户因使用这些下载资源对自己和他人造成任何形式的伤害或损失。
评论
0/150
提交评论