物波物联设备指令下发

物波物联平台数据交换参数及响应值统一UTF-8编码,否则出现乱码,设备不能正确交互

访问账号获取

账号由采购租户或者用户获取,此账号不能直接申请,请联系相关客户获取

查询设备信息

请求地址

GET https://iot.loumama.cn/api/v1/{deviceName} # deviceName 默认统一使用设备IMEI号码

响应参数

code 200
{
  # 设备ID 信息
  "id": {
    "id": "784f394c-42b6-435a-983c-b7beff2784f9",
    "entityType": "DEVICE"
  },
  "createdTime": 1609459200000,
  # 设备所属租户信息
  "tenantId": {
    "id": "784f394c-42b6-435a-983c-b7beff2784f9",
    "entityType": "TENANT"
  },
  # 设备所属用户信息
  "customerId": {
    "id": "784f394c-42b6-435a-983c-b7beff2784f9",
    "entityType": "CUSTOMER"
  },
  # 设备名称信息 默认是IMEI号,具体信息看设备型号
  "name": "A4B72CCDFF33",
  "type": "Temperature Sensor",
  "label": "Room 234 Sensor",
  # 设备配置信息
  "deviceProfileId": {
    "id": "784f394c-42b6-435a-983c-b7beff2784f9",
    "entityType": "DEVICE_PROFILE"
  }
}
code 400 
{
  "status": 400,
  "message": "Invalid UUID string: 123",
  "errorCode": 31,
  "timestamp": "2022-11-17T03:08:11.280+00:00"
}

全局token获取

平台调用一切安全接口都需要 token,物波物联统一token获取接口

请求地址

POST  https://iot.loumama.cn/api/auth/login

请求参数

{
	"username":"username",
    "password":"password"
}

响应参数

code 200
{
  "token": "eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJ0ZW5hbnRAdGhpbmdzYm9hcmQub3JnIi...",
  "refreshToken": "eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJ0ZW5hbnRAdGhpbmdzYm9hcmQub3JnIi..."
}

code 401 
{
  "status": 401,
  "message": "User account is not active",
  "errorCode": 10,
  "timestamp": "2022-11-17T03:08:13.280+00:00"
}
{
  "status": 401,
  "message": "User account is not active",
  "errorCode": 10,
  "timestamp": "2022-11-17T03:08:13.280+00:00"
}
  • 指令下发

请求地址

POST  https://iot.loumama.cn/api/rpc/oneway/{deviceId}

请求头

{
    "X-Authorization": "Bearer $JWT_TOKEN_VALUE" #$JWT_TOKEN_VALUE 通过登录接口查询获取
}

请求参数

{
  "method": "设备接收指令方法|指令名称 必填参数",
  "params": {
    	"设备接收指令参数|json格式数据|必填参数"
  },
  "persistent": false, # 选填参数,是否持久化数据到平台,默认false
  "timeout": 5000 # 指令下发超时时间,单位毫秒值
}

参考样例

# 场所码指令
{
    "method": "passCommand", 固定值同行指令
    "params": {
        "pass": true|false,  //是否同行 必填
        "color": "green", //健康码颜色,取值范围 green|yellow|red ,必填
        "name": "王小木", //打卡人姓名 选填可以为空
        "nuclein": 24, //核酸有效时长,选填
        "voice": "绿码请通形", //自定义语音播报,UTF-8格式,选填,无此字段,设备会自动依据上面参数内容生成合成语音。
    }
}

响应参数

响应码

200 发送成功
40x 权限错误
50x 服务端错误