文档中心 > AliGenie开发者平台

协议简介

更新时间:2019/08/20 访问次数:49331

一.协议概述

协议分为两部分: header 以及 payload

示例:

{
  "header":{
      "namespace":"AliGenie.Iot.Device.Control",
      "name":"TurnOn",
      "messageId":"1bd5d003-31b9-476f-ad03-71d471922820",
      "payLoadVersion":1
   },
   "payload":{
       "accessToken":"access token",
       "deviceId":"34234",
       "deviceType":"XXX",
       "attribute":"powerstate",
       "value":"on",
       "extensions":{
          "extension1":"",
          "extension2":""
      }
    }
 }

1.1 header参数协议

参数名 参数类型 参数说明 是否必传
namespace String 消息命名空间,详见本页1.2
name String 详见本页1.3
payLoadVersion int payload 的版本,目前版本为 1
messageId String 用于跟踪请求

1.2 header协议中的namespace列表

namespace 解释说明
AliGenie.Iot.Device.Discovery 设备发现
AliGenie.Iot.Device.Control 设备控制
AliGenie.Iot.Device.Query 设备属性查询

1.3 header协议中name列表

1.3.1 设备发现类(与AliGenie.Iot.Device.Discovery对应)

name 解释说明
DiscoveryDevices 设备发现(获取设备列表)

1.3.2 操作类(与AliGenie.Iot.Device.Control对应)

name 解释说明
TurnOn 打开
TurnOff 关闭
SelectChannel 频道切换
AdjustUpChannel 频道增加
AdjustDownChannel 频道减少
AdjustUpVolume 声音按照步长调大
AdjustDownVolume 声音按照步长调小
SetVolume 声音调到某个值
SetMute 设置静音
CancelMute 取消静音
Play 播放
Pause 暂停
Continue 继续
Next 下一首或下一台
Previous 上一首或上一台
SetBrightness 设置亮度
AdjustUpBrightness 调大亮度
AdjustDownBrightness 调小亮度
SetTemperature 设置温度
AdjustUpTemperature 调高温度
AdjustDownTemperature 调低温度
SetWindSpeed 设置风速
AdjustUpWindSpeed 调大风速
AdjustDownWindSpeed 调小风速
SetMode 模式的切换
SetColor 设置颜色
OpenFunction 打开功能
CloseFunction 关闭功能
Cancel 取消
CancelMode 取消模式(退出模式)

1.3.3 查询类(与AliGenie.Iot.Device.Query对应)

支持的查询属性方法 操作方法说明 返回值说明
Query 查询所有标准属性 详情见各个属性
QueryColor 查询颜色 Red、Yellow、Blue、White、Black等值(AliGenie以这些值为准,厂家适配)
QueryPowerState 查询电源开关 on(打开)、off(关闭)
QueryTemperature 查询温度 返回数值(AliGenie默认的单位为摄氏度,厂家适配该单位)
QueryHumidity 查询湿度 返回数值
QueryWindSpeed 查询风速 返回值参考 设备控制 中章节 1.8.1 风速值对应表
QueryBrightness 查询亮度 返回数值
QueryFog 查询雾量 返回数值
QueryMode 查询模式 返回值枚举参考例子模式切换中的例子
QueryPM25 查询pm2.5 含量 返回数值
QueryDirection 查询方向 返回 left,right,forward,back,up,down
QueryAngle 查询角度 返回数值,单位度
QueryBloodGlucose 查询血糖 返回数值
QueryBloodPressure 查询血压 返回数值,需返回舒张压和收缩压,参考设备控制与设备状态查询中2.3
QueryHeartRate 查询脉搏 返回数值

1.4 payload参数协议

payload根据namespace不同分为Discovery、Control、Query三类,详见设备发现、设备控制和设备状态查询。

FAQ

关于此文档暂时还没有FAQ
返回
顶部