室内外融合定位器开放能力说明

更新时间：2023-06-15 05:31:02

本文介绍 室内外融合定位器 开放能力接入的相关说明。

API 说明

室内外融合定位器设备管理：

API 名称	接口地址
设置上报频率	POST:/v1.0/fusion-locator/{device_id}/actions/set/frequency

事件格式

云开发项目开启消息订阅后，可以收到设备端上报的事件消息。消息队列接入流程的详细介绍，请参考消息队列。

签到

功能描述

室内外融合定位器上报签到事件给接入方。事件 Code：check_in。

value 参数说明

参数名	类型	说明	必填
t	Long	签到时间，13 位时间戳	是

数据示例

{
    "dataId": "AAXRV4BrtW9BRB9A2JYW****",
    "devId": "6ca****",
    "productKey": "e6rz6vba81wm****",
    "status": [
        {
            "5": "{\"t\":1637548630452}",
            "code": "check_in",
            "t": 1637548630455,
            "value": "{\"t\":1637548630452}"
        }
    ]
}

签退

功能描述

室内外融合定位器上报签退事件给接入方。事件 Code：sign_out。

value 参数说明

参数名	类型	说明	必填
t	Long	签退时间，13 位时间戳	是

数据示例

{
    "dataId": "AAXRV4BrtW9BRB9A2JYW****",
    "devId": "6ca****",
    "productKey": "e6rz6vba81wm****",
    "status": [
        {
            "6": "{\"t\":1637548630452}",
            "code": "sign_out",
            "t": 1637548630455,
            "value": "{\"t\":1637548630452}"
        }
    ]
}

告警

功能描述

室内外融合定位器上报告警事件给接入方。事件 Code：alarm_info_report。

value 参数说明

参数名	类型	说明	必填
t	Long	触发时间，13 位时间戳	是
type	Integer	告警类型，`1` 表示 SOS 告警	是
info	String	告警内容	是

数据示例

{
    "dataId": "AAXRV4BrtW9BRB9A2JYW****",
    "devId": "6ca****",
    "productKey": "e6rz6vba81wm****",
    "status": [
        {
            "2": "{\"t\":1637548630452,\"type\":1,\"info\":\"SOS\"}",
            "code": "alarm_info_report",
            "t": 1637548630455,
            "value": "{\"t\":1637548630452,\"info\":\"SOS\"}"
        }
    ]
}

电池电量

功能描述

室内外融合定位器上报电池电量事件给接入方。事件 Code：battery_info。

value 参数说明

参数名	类型	说明	必填
t	Long	触发时间，13 位时间戳	是
battery	Double	电池电量百分比（精度 2）	是

数据示例

{
    "dataId": "AAXRV4BrtW9BRB9A2JYW****",
    "devId": "6ca****",
    "productKey": "e6rz6vba81wm****",
    "status": [
        {
            "3": "{\"t\":1637548630452,\"battery\":20.00}",
            "code": "battery_info",
            "t": 1637548630455,
            "value": "{\"t\":1637548630452,\"battery\":20.00}"
        }
    ]
}

计步数据

功能描述

室内外融合定位器上报计步数据事件给接入方。事件 Code：count_steps。

value 参数说明

参数名	类型	说明	必填
t	Long	触发时间，13 位时间戳	是
steps	Integer	步数	是

数据示例

{
    "dataId": "AAXRV4BrtW9BRB9A2JYW****",
    "devId": "6ca****",
    "productKey": "e6rz6vba81wm****",
    "status": [
        {
            "3": "{\"t\":1637548630452,\"steps\":100}",
            "code": "count_steps",
            "t": 1637548630455,
            "value": "{\"t\":1637548630452,\"steps\":100}"
        }
    ]
}

定位数据

室内外融合定位器上报定位事件给接入方。事件 Code：position_event。

目前有如下定位类型：

1：GPS 定位
2：Wi-Fi 定位
3：基站 LBS 定位
4：蓝牙信标定位

您可根据 type 字段区分定位数据类型。

GPS 定位

value 参数说明：

参数名	类型	说明	必填
t	Long	触发时间，13 位时间戳	是
type	Integer	GPS 定位，`type` 取值为 `1`	是
lat	Double	经度，精度为 6	否
lng	Double	纬度，精度为 6	否

数据示例：

{
    "dataId": "AAXRV4BrtW9BRB9A2JYW****",
    "devId": "6ca****",
    "productKey": "e6rz6vba81wm****",
    "status": [
        {
            "1": "{\"t\":1637548630452,\"lat\":31.210463,\"lng\":121.606855}",
            "code": "position_event",
            "t": 1637548630455,
            "value": "{\"t\":1637548630452,\"lat\":31.210463,\"lng\":121.606855}"
        }
    ]
}

Wi-Fi 定位

value 参数说明：

参数名	类型	说明	必填
t	Long	触发时间，13 位时间戳	是
type	Integer	Wi-Fi 定位，`type` 取值为 `2`	是
lat	Double	经度，精度为 6	否
lng	Double	纬度，精度为 6	否

数据示例：

{
    "dataId": "AAXRV4BrtW9BRB9A2JYW****",
    "devId": "6ca****",
    "productKey": "e6rz6vba81wm****",
    "status": [
        {
            "1": "{\"t\":1637548630452,\"lat\":31.210463,\"lng\":121.606855}",
            "code": "position_event",
            "t": 1637548630455,
            "value": "{\"t\":1637548630452,\"lat\":31.210463,\"lng\":121.606855}"
        }
    ]
}

基站 LBS 定位

value 参数说明：

参数名	类型	说明	必填
t	Long	触发时间，13 位时间戳	是
type	Integer	基站 LBS 定位，`type` 取值为 `3`	是
bsId	String	基站 CID	否
db	Integer	信号强度（支持正负值）	否
lac	String	基站位置区码	否

数据示例：

{
    "dataId": "AAXRV4BrtW9BRB9A2JYW****",
    "devId": "6ca****",
    "productKey": "e6rz6vba81wm****",
    "status": [
        {
            "1": "{\"t\":1637548630452,\"bsId\":\"1\",\"lac\":\"2\",\"db\":12}",
            "code": "position_event",
            "t": 1637548630455,
            "value": "{\"t\":1637548630452,\"bsId\":\"1\",\"lac\":\"2\",\"db\":12}"
        }
    ]
}

蓝牙信标定位

value 参数说明：

参数名	类型	说明	必填
t	Long	触发时间，13 位时间戳	是
type	Integer	蓝牙信标定位，`type` 取值为 `4`	是
bleId	String	蓝牙设备 CID	否
bleDeviceId	String	蓝牙设备 ID	否
db	Integer	信号强度（支持正负值）	否

数据示例：

{
    "dataId": "AAXRV4BrtW9BRB9A2JYW****",
    "devId": "6ca****",
    "productKey": "e6rz6vba81wm****",
    "status": [
        {
            "1": "{\"t\":1637548630452,\"bleId\":\"1\",\"bleDeviceId\":\"2\",\"db\":12}",
            "code": "position_event",
            "t": 1637548630455,
            "value": "{\"t\":1637548630452,\"bleId\":\"1\",\"bleDeviceId\":\"2\",\"db\":12}"
        }
    ]
}

事件 1.0 格式

室内外融合定位器设备事件消息兼容 1.0 版本格式，如需开通 1.0 版本格式，请提交工单联系涂鸦。接入流程请参考公区设备事件 1.0 格式接入。

签到

功能描述

触发室内外融合定位器签到，室内外融合定位器会上报签到事件给接入方。

参数说明

参数名	类型	说明	必填
bizCode	String	事件业务 code，取值固定为 `edge_device`	是
eventType	String	事件类型，取值固定为 `edge_report_data`	是
mode	String	事件 mode，取值固定为 `sign_in`	是
deviceId	String	涂鸦设备 ID	是
t	Long	签到时间，13 位时间戳	是

数据示例

{
    "data": "{\"mode\":\"sign_in\",\"data\":\"{\\\"deviceId\\\":\\\"6ca****\\\",\\\"t\\\":1612514362591}}",
    "bizCode": "edge_device",
    "eventType": "edge_report_data"
}

签退

功能描述

触发室内外融合定位器签退，室内外融合定位器会上报签退事件给接入方。

参数说明

参数名	类型	说明	必填
bizCode	String	事件业务 code，取值固定为 `edge_device`	是
eventType	String	事件类型，取值固定为 `edge_report_data`	是
mode	String	事件 mode，取值固定为 `sign_out`	是
deviceId	String	涂鸦设备 ID	是
t	Long	签退时间，13 位时间戳	是

数据示例

{
    "data": "{\"mode\":\"sign_out\",\"data\":\"{\\\"deviceId\\\":\\\"6ca****\\\",\\\"t\\\":1612514362591}}",
    "bizCode": "edge_device",
    "eventType": "edge_report_data"
}

告警

功能描述

室内外融合定位器上报告警事件给接入方。

参数说明

参数名	类型	说明	必填
bizCode	String	事件业务 code，取值固定为 `edge_device`	是
eventType	String	事件类型，取值固定为 `edge_report_data`	是
mode	String	事件 mode，取值固定为 `alarm_info_report`	是
deviceId	String	涂鸦设备 ID	是
t	Long	触发时间，13 位时间戳	是
type	Integer	告警类型，`1` 表示 SOS 告警	是
info	String	告警内容	是

数据示例

{
    "data": "{\"mode\":\"alarm_info_report\",\"data\":\"{\\\"deviceId\\\":\\\"6ca****\\\",\\\"t\\\":1612514362591,\\\"type\\\":1,\\\"info\\\":\\\"SOS\\\" }}",
    "bizCode": "edge_device",
    "eventType": "edge_report_data"
}

电池电量

功能描述

室内外融合定位器上报电池电量事件给接入方。

参数说明

参数名	类型	说明	必填
bizCode	String	事件业务 code，取值固定为 `edge_device`	是
eventType	String	事件类型，取值固定为 `edge_report_data`	是
mode	String	事件 mode，取值固定为 `battery_info`	是
deviceId	String	涂鸦设备 ID	是
t	Long	触发时间，13 位时间戳	是
battery	Double	电池电量百分比（精度 2）	是

数据示例

{
    "data": "{\"mode\":\"battery_info\",\"data\":\"{\\\"deviceId\\\":\\\"6ca****\\\",\\\"t\\\":1612514362591,\\\"battery\\\":20.00}}",
    "bizCode": "edge_device",
    "eventType": "edge_report_data"
}

计步数据

功能描述

室内外融合定位器上报计步数据事件给接入方。

参数说明

参数名	类型	说明	必填
bizCode	String	事件业务 code，取值固定为 `edge_device`	是
eventType	String	事件类型，取值固定为 `edge_report_data`	是
mode	String	事件 mode，取值固定为 `step`	是
deviceId	String	涂鸦设备 ID	是
t	Long	触发时间，13 位时间戳	是
steps	Integer	步数	是

数据示例

{
    "data": "{\"mode\":\"step\",\"data\":\"{\\\"deviceId\\\":\\\"6ca****\\\",\\\"t\\\":1612514362591,\\\"steps\\\":100}}",
    "bizCode": "edge_device",
    "eventType": "edge_report_data"
}

定位数据

室内外融合定位器上报定位数据事件给接入方。目前有如下定位类型：

1：GPS 定位
2：Wi-Fi 定位
3：基站 LBS 定位
4：蓝牙信标定位

您可根据 type 字段区分定位数据类型。

GPS 定位

参数说明：

参数名	类型	说明	必填
bizCode	String	事件业务 code，取值固定为 `edge_device`	是
eventType	String	事件类型，取值固定为 `edge_report_data`	是
mode	String	事件 mode，取值固定为 `position_event`	是
deviceId	String	涂鸦设备 ID	是
t	Long	触发时间，13 位时间戳	是
type	Integer	GPS 定位，`type` 取值为 `1`	是
lat	Double	经度，精度为 6	否
lng	Double	纬度，精度为 6	否

数据示例：

{
    "data": "{\"mode\":\"position_event\",\"data\":\"{\\\"deviceId\\\":\\\"6ca****\\\",\\\"t\\\":1612514362591,\\\"type\\\":1,\\\"lat\\\":31.210463,\\\"lng\\\":121.606855}}",
    "bizCode": "edge_device",
    "eventType": "edge_report_data"
}

Wi-Fi 定位

参数说明：

参数名	类型	说明	必填
bizCode	String	事件业务 code，取值固定为 `edge_device`	是
eventType	String	事件类型，取值固定为 `edge_report_data`	是
mode	String	事件 mode，取值固定为 `position_event`	是
deviceId	String	涂鸦设备 ID	是
t	Long	触发时间，13 位时间戳	是
type	Integer	Wi-Fi 定位，`type` 取值为 `2`	是
lat	Double	经度，精度为 6	否
lng	Double	纬度，精度为 6	否

数据示例：

{
    "data": "{\"mode\":\"position_event\",\"data\":\"{\\\"deviceId\\\":\\\"6ca****\\\",\\\"t\\\":1612514362591,\\\"type\\\":2,\\\"lat\\\":31.210463,\\\"lng\\\":121.606855}}",
    "bizCode": "edge_device",
    "eventType": "edge_report_data"
}

基站 LBS 定位

参数说明：

参数名	类型	说明	必填
bizCode	String	事件业务 code，取值固定为 `edge_device`	是
eventType	String	事件类型，取值固定为 `edge_report_data`	是
mode	String	事件 mode，取值固定为 `position_event`	是
deviceId	String	涂鸦设备 ID	是
t	Long	触发时间，13 位时间戳	是
type	Integer	基站 LBS 定位，`type` 取值为 `3`	是
bsId	String	基站 CID	否
db	Integer	信号强度（支持正负值）	否
lac	String	基站位置区码	否

数据示例：

{
    "data": "{\"mode\":\"position_event\",\"data\":\"{\\\"deviceId\\\":\\\"6ca****\\\",\\\"t\\\":1612514362591,\\\"type\\\":3,\\\"bsId\\\":\\\"1\\\",\\\"lac\\\":\\\"2\\\",\\\"db\\\":12}}",
    "bizCode": "edge_device",
    "eventType": "edge_report_data"
}

蓝牙信标定位

参数说明：

参数名	类型	说明	必填
bizCode	String	事件业务 code，取值固定为 `edge_device`	是
eventType	String	事件类型，取值固定为 `edge_report_data`	是
mode	String	事件 mode，取值固定为 `position_event`	是
deviceId	String	涂鸦设备 ID	是
t	Long	触发时间，13 位时间戳	是
type	Integer	蓝牙信标定位，`type` 取值为 `4`	是
bleId	String	蓝牙设备 CID	否
bleDeviceId	String	涂鸦蓝牙设备 ID	否
db	Integer	信号强度（支持正负值）	否

数据示例：

{
    "data": "{\"mode\":\"position_event\",\"data\":\"{\\\"deviceId\\\":\\\"6ca****\\\",\\\"t\\\":1612514362591,\\\"type\\\":4,\\\"bleId\\\":\\\"1\\\",\\\"bleDeviceId\\\":\\\"6ca****\\\",\\\"db\\\":12}}",
    "bizCode": "edge_device",
    "eventType": "edge_report_data"
}

上一篇室内外融合定位器开放能力