API列表

更新时间：2018-10-23 21:27:49

aliyunIot.device(options)

和云端建立连接，返回一个 Device 连接实例，入参：

• options

  • productKey (String)
  • deviceName (String)
  • deviceSecret (String)
  • regionId (String) 阿里云 regionId
  • tls (Bool) 是否开启 TLS 加密，Node.js 中如果开启将使用 TLS 协议进行连接，浏览器如果开启将上使用 WSS 协议

    事件列表

    Event 'connect'

    function(connack) {} 当连接到云端成功时触发。

    Event 'message'

    function(topic, message) {} 当接受到云端消息时触发，回调函数参数：

• topic 消息主题

• message 消息 payload

  Event 'error'

  function(error) {}
  当设备不能连接到云端的时候触发。

aliyunIot.device#publish(topic, message, [options], [callback])

等同于 mqtt.Client#publish() 方法。

aliyunIot.device#unsubscribe(topic, [callback])

等同于 mqtt.Client#unsubscribe() 方法。

aliyunIot.device#postProps(params, [callback])

上报物模型属性：

• params 属性参数，Object 类型

• callback

  • err 错误，比如超时或者 res.code !== 200
  • res 服务端 reply 消息内容

aliyunIot.device#postEvent(eventIdentifier, params, [callback])

上报物模型事件：

• eventIdentifier 事件 id String 类型

• params 事件参数，Object 类型

• callback

  • err 错误，比如超时
  • res 服务端 reply 消息内容

aliyunIot.device#serve(seviceIdentifier, [callback])

监听物模型服务：

• seviceIdentifier 服务 id String 类型

• callback

  • params 服务参数

值得注意的是，serve 方法返回的是一个 deServe 函数，可以通过调用 deServe 函数取消服务监听：

var deServe = device.serve('turnOn', function(params) {
  // 收到 turnOn 服务消息后取消对该服务的监听
  deServe();
});

aliyunIot.gateway(options)

和云端建立连接，返回一个网关 Gateway 类连接实例，继承自 Device 类。
options 设备激活凭证

• productKey

• deviceName

• deviceSecret

aliyunIot.gateway#addTopo(deviceSign, [callback])

添加子设备到拓扑

• deviceSign 子设备身份加签信息，通过调用 aliyunIot.signUtil() 方法进行加签

• callback

  • err 错误，比如超时或者 res.code !== 200
  • res 服务端 reply 消息内容

aliyunIot.gateway#getTopo()

获取子设备到拓扑关系

• callback
  • err 错误，比如超时或者 res.code !== 200
  • res 服务端 reply 消息内容

aliyunIot.gateway#removeTopo(thingId, [callback])

从拓扑关系里移除子设备

• thingId 子设备身份

  • productKey
  • deviceName

• callback

  • err 错误，比如超时或者 res.code !== 200
  • res 服务端 reply 消息内容

aliyunIot.gateway#login(thingId, [callback])

子设备上线

• deviceSign 子设备身份加签信息，通过调用 aliyunIot.signUtil() 方法进行加签

• callback

  • err 错误，比如超时或者 res.code !== 200
  • res 服务端 reply 消息内容

aliyunIot.gateway#logout(thingId, [callback])

子设备下线

• thingId 子设备身份

  • productKey
  • deviceName

• callback

  • err 错误，比如超时或者 res.code !== 200
  • res 服务端 reply 消息内容

aliyunIot.gateway#postSubDeviceProps(thingId, params, [callback])

• thingId 子设备身份

  • productKey
  • deviceName

• params 属性参数，类型 Object

• callback

  • err 错误，比如超时或者 res.code !== 200
  • res 服务端 reply 消息内容

aliyunIot.gateway#postSubDeviceEvent(thingId, eventIdentifier, params, [callback])

• thingId 子设备身份

  • productKey
  • deviceName

• eventIdentifier 事件 id，String 类型

• params 事件参数，Object类型

• callback

  • err 错误，比如超时或者 res.code !== 200
  • res 服务端 reply 消息内容

aliyunIot.gateway#serveSubDeviceService(thingId, serviceIdentifier, [callback])

• thingId 子设备身份

  • productKey
  • deviceName

• serviceIdentifier 服务 id，String 类型

• callback

  • params 服务参数

aliyunIot.signUtil(deviceId)

设备身份连接加签工具函数

• deviceId 设备激活凭证
  • productKey
  • deviceName
  • deviceSecret