跳到主要内容

API

该教程面向基于Gateway做后台业务功能的软件集成商。通过该接口可获得Gateway、uBeacon、Tag的UID、坐标、电量、工作状态等信息，数据格式为JSON，接口包括MQTT、UDP、webhook等，支持部署在Ubuntu、Windows、MacOs等平台。

1.数据格式：JSON​

定位数据示例：

{
    "data": {
        "pos": [
            -3.2616942,
            4.3123593,
            1.1999172
        ], //position：x,y,z
        "posNoise": [
            0.71,
            0.62,
            0.03
        ],//position noise：x,y,z
        "time": 575889100, //pos timestamp：x,y,z
        "vel": [
            -0.08,
            0.1,
            0
        ], //velocity：x,y,z
        "velNoise": [
            0.13,
            0.13,
            0.01
        ] //velocity noise：x,y,z
    },
    "deviceName": "T4", //device name, The only overall situation within the software
    "name": "Pos", // message type
    "uid": "02084a71676424f9e16d"  //device UID
}

2. API配置入口​

打开uBeacon Tool软件，按下图操作进入配置页面

API 配置入口示例

3. MQTT​

api.mqtt.address: {ip或域名}:{端口}

api.mqtt.clientId: 客户端标识，可为空

api.mqtt.topic: 主题名

MQTT 配置示例

4. UDP​

api.udp.address: {ip或域名}:{端口}

UDP 配置示例

5. webhook​

api.hook.url格式：http://{ip或域名}:{端口}/{自定义uri}

http method: POST

web hook 配置示例