OTAP 接口指引

 

5.1 测温光纤报警管理

 

5.1.1 操作

5.1.1.1 处理测温光纤报警

 

请求数据

{

"data":{

/*req, object, 输入参数, additionalProperties:false*/

"processedMethod": "erasureAlarm"

/*req, string, 处理方式, enum:[erasureAlarm#消警, erasureAudio#消音],

desc:消警包含消音;消音后设备仍然可以上报事件,但不进行报警音提醒*/

}

}

 

响应数据

{

"status": 200,

"code": "0x00000000",

"errorMsg": "Succeeded.",

"data": {}

}

 

5.1.1.2 查询测温光纤温度信息

 

请求数据

{

/*req, object, 查询测温光纤温度信息条件*/

"searchID": "test",

/*req, string, 查询标识, range:[1,32], desc:1、由平台生成,保证唯一性,只能由字母和

数字组成。2、在查询条件不变的情况下,searchID的内容不变。3、设备如果发现有新请求的searchID与

已经在执行的任务的searchID相同,则返回错误。*/

"searchResultPosition": 1,

/*req, integer, 查询结果在结果列表中的起始位置, range:[1,200000], desc:从1开始*/

"maxResults": 100,

/*req, integer, 本次交互的最大结果数, range:[1,2000]*/

"unitChannel": 1,

/*opt, integer, 光纤通道, range:[0,12], desc:无此节点时表示查询所有通道*/

"zoneIDList":[

/*opt, array, 防区号列表, range:[0,1000], uniqueItems:true, desc:无此节点时表示

查询所有防区*/

2

/*opt, integer, 防区号, range:[1,130000]*/

],

"isMaxTemperatureOnly": false,

/*opt, boolean, 是否仅返回防区内的最高温度, desc:每个防区具备大量的温度信息,若最高温度

与所有温度一同返回对带宽的消耗较大。允许上层软件控制设备仅返回防区内最高温度。此字段为true时,应

答中除了最高温maxTemperature会返回,minTemperature和averageTemperature也会一同返回*/

"dateTime": "2021-01-28T02:00:00.000+08:00",

/*opt, string, 查询时间, format:date-time, desc:指定时间点进行查询,查询此时间点的

防区温度信息,无此节点时表示查询当前温度信息*/

"serialNo": 1

/*opt, integer, 事件流水号, range:[1,2147483647], desc:设备上传事件时携带事件流水

号用于标识事件,根据本字段查询某一条报警事件的温度回溯数据*/

}

 

响应数据

{

/*req, object, 查询测温光纤温度信息结果*/

"responseStatus": "OK",

/*req, string, 查询状态字符串描述, enum:[OK#查询结束, MORE#还有数据等待查询, NO

MATCH#没有匹配数据, abnormal#查询异常]*/

"numOfMatches": 1,

/*req, integer, 本次返回的记录条数, range:[0,2000]*/

"totalMatches": 1,

/*req, integer, 符合条件的记录总条数, range:[0,200000]*/

"matchResults":[

/*opt, array, 查询结果列表, range:[0,100], uniqueItems:false*/

{

/*opt, object, 查询结果*/

"unitChannel": 1,

/*req, integer, 光纤通道, range:[0,12]*/

"zoneID": 1,

/*opt, integer, 防区号, range:[1,130000]*/

"zoneName": "test",

/*opt, string, 防区名称, range:[1,64]*/

"historyReferenceList":[

/*opt, array, 历史时间段的基准温度列表, range:[0,1000], desc:基准温度指的

是整个防区的平均温度,当serialNo对应的报警类型为温差报警时需要返回该节点*/

{

/*opt, object, 历史时间段温度*/

"time": "2023-02-27T15:11:23.000+08:00",

/*req, string, 时间, format:date-time*/

"temperature": 10.1

/*req, number, 温度值, range:[-200,1000], multipleOf:0.1,

unit:°C*/

}

],

"tempThreshold": 1,

/*opt, number, 报警时刻定温报警的上限温度阈值, range:[0,65535],

multipleOf:0.001, unit:°C(摄氏度), desc:当serialNo对应的报警类型为定温报警时需要返回该字

段*/

"tempDownLimitThreshold": 1,

/*opt, number, 报警时刻定温报警的下限温度阈值, range:[0,65535],

multipleOf:0.001, unit:°C(摄氏度), desc:当serialNo对应的报警类型为定温报警时需要返回该字

段*/

"temperatureList":[

/*opt, array, 防区内温度列表, range:[0,500]*/

{

/*opt, object, 防区内温度*/

"position": 1,

/*opt, number, 位置, range:[1,10000], multipleOf:0.1,

unit:m(米), desc:在测温光纤中通过具体的米数来设计检测距离,与振动光纤不同*/

"temperature": 10.1,

/*req, number, 温度值, range:[-200,1000], multipleOf:0.1,

unit:°C, desc:范围以设备侧实际传输为准*/

"historyTempList":[

/*opt, array, 历史时间段的温度列表, range:[0,1000], desc:报警的位

置一段时间的温度数据*/

{

/*opt, object, 历史时间段温度*/

"time": "2023-02-27T15:11:23.000+08:00",

/*req, string, 时间, format:date-time*/

"temperature": 10.1

/*req, number, 温度值, range:[-200,1000],

multipleOf:0.1, unit:°C*/

}

]

}

]

}

]

}

 

5.1.1.3 查询测温光纤通道温度信息

 

请求数据

{

"data":{

/*req, object, 查询测温光纤温度信息条件, additionalProperties:false*/

"searchID": "test",

/*req, string, 查询标识, range:[1,32], desc:1、由平台生成,保证唯一性,只

能由字母和数字组成。2、在查询条件不变的情况下,searchID的内容不变。3、设备如果发现有新请求的

searchID与已经在执行的任务的searchID相同,则返回错误。*/

"searchResultPosition": 1,

/*req, integer, 查询结果在结果列表中的起始位置, range:[1,200000], desc:从

1开始*/

"maxResults": 100,

/*req, integer, 本次交互的最大结果数, range:[1,2000]*/

"unitChannel": 1

/*opt, integer, 光纤通道, range:[0,12], desc:无此节点时表示查询所有通道*/

}

}

 

响应数据

{

"status": 200,

"code": "0x00000000",

"errorMsg": "Succeeded.",

"data":{

/*req, object, 查询测温光纤温度信息结果, additionalProperties:false*/

"responseStatus": "OK",

/*req, string, 查询状态字符串描述, enum:[OK#查询结束, MORE#还有数据等待查

询, NO MATCH#没有匹配数据, abnormal#查询异常]*/

"numOfMatches": 1,

/*req, integer, 本次返回的记录条数, range:[0,2000]*/

"totalMatches": 1,

/*req, integer, 符合条件的记录总条数, range:[0,200000]*/

"matchResults":[

/*opt, array, 查询结果列表, range:[0,100], uniqueItems:false*/

{

/*opt, object, 查询结果, additionalProperties:false*/

"unitChannel": 1,

/*req, integer, 光纤通道, range:[0,12]*/

"temperatureList":[

/*opt, array, 光纤通道内温度列表, range:[0,50]*/

{

/*opt, object, 光纤通道内温度,

additionalProperties:false*/

"position": 1,

/*opt, number, 位置, range:[1,10000],

multipleOf:0.001, unit:m(米), desc:在测温光纤中通过具体的米数来设计检测距离,与振动光纤不

同*/

"temperature": 1

/*req, number, 温度值, range:[0,1000],

multipleOf:0.001, unit:°C, desc:范围以设备侧实际传输为准*/

}

]

}

]

}

]

}

 

5.1.1.4 查询测温光纤报警数量

 

请求数据

{

"data":{

/*req, object, 查询条件, additionalProperties:false*/

"unitChannelList":[

/*opt, array, 光纤通道列表, range:[0,16], uniqueItems:true, desc:无此节

点时表示查询所有通道*/

2

/*opt, integer, 光纤通道, range:[1,16]*/

]

}

}

 

响应数据

{

"status": 200,

"code": "0x00000000",

"errorMsg": "Succeeded.",

"data":{

/*req, object, 查询结果, additionalProperties:false*/

"opticalFiberThermalAlarmNumList":[

/*opt, array, 测温光纤报警数量列表, range:[0,16]*/

{

/*opt, object, 测温光纤报警数量, additionalProperties:false*/

"unitChannel": 1,

/*req, integer, 光纤通道, range:[1,12]*/

"constantTemperatureAlarmNumber": 1,

/*opt, integer, 定位报警数量, range:[0,10000], desc:从消警到下发

查询接口位置的报警数量*/

"temperatureRiseAlarmNumber": 1,

/*opt, integer, 温升报警数量, range:[0,10000], desc:从消警到下发

查询接口位置的报警数量*/

"temperatureDifferenceAlarmNumber": 1,

/*opt, integer, 温差报警数量, range:[0,10000], desc:从消警到下发

查询接口位置的报警数量*/

"clearAlarmDateTime": "2021-01-28T02:00:00.000+08:00",

/*opt, string, 消警时间, format:date-time, desc:表示统计的数据是

从这个消警时间开始统计*/

"temperatureDropAlarmNumber": 1

/*opt, integer, 温降报警数量, range:[0,10000], desc:从消警到下发

查询接口位置的报警数量*/

}

]

}

}

申请完整协议文件
如需要完整协议开发文档,请填写以下申请信息,我们会在收到信息的一周内与您联系并提供完整内容
联系我们
售后服务
close
qrCode
微信小程序
扫码登录微信小程序,可轻松查阅海量资料与视频