Device - blockdate/ios-rn-sdk GitHub Wiki

miot/Device

设备相关 API IDevice 当前设备实例对象，用于获取当前设备属性等 IDeviceWifi 当前设备网络操作实例对象，用于发送设备网络操作请求等 DeviceEvent 当前设备的可订阅事件，用于订阅设备名称状态变化等

Export:
Example

import {Device} from 'miot'
...
//IDevice
//属性获取
let did = Device.deviceID
let deviceModel = Device.model
//设备方法，e.g 场景创建
let scene = Device.createTimerScene(params)

//IDeviceWifi
//wifi方法 e.g RPC请求
Device.getDeviceWifi().callMethod('method_name', params)
 .then(res => {//here is the success result})
 .catch(err => {//error happened})
...
其余具体使用请参考具体API文档

miot/Device
- module.exports ⏏
  - static
    - .IDeviceWifi
      - .deviceID : string
      - .loadProperties(...propNames) ⇒ Promise.<Map>
      - .loadPropertiesFromCloud(...propNames) ⇒ Promise.<Map>
      - .callMethod(method, args, extraPayload) ⇒ Promise.<json>
      - .callMethodFromCloud(method, args) ⇒ Promise.<json>
      - .localPing() ⇒ Promise.<boolean>
      - .subscribeMessages(...propertyOrEventNames) ⇒ Promise.<EventSubscription>
      - .getVersion() ⇒ Promise.<any>
      - .startUpgradingFirmware() ⇒ Promise.<DeviceVersion>
      - .setFirmwareUpdateErrDic(message) ⇒
      - .setFirmwareNotCheckUpdate(notCheck) ⇒ Promise
  - inner
    - ~IDevice
      - .deviceID : string
      - .model : string
      - .isReady : boolean
      - .parentDevice : IDevice
      - .isRootDevice : boolean
      - .isVirtualDevice : boolean
      - .owner : IAccount
      - .extra : string
      - .name : string
      - .session : string
      - .iconURL : string
      - .permitLevel : int
      - .isSetPinCode : boolean
      - .parentModel : string
      - .showMode : int
      - .timeZone : string
      - .mac : string
      - .lastVersion : string
      - .propInfo : json
      - .IP : string
      - .RSSI : string
      - .SSID : string
      - .BSSID : string
      - .type : int
      - .lastModified : long
      - .location : int
      - .latitude : double
      - .longitude : double
      - .isVoiceDevice ⇒ boolean
      - .isOnline : boolean
      - .resetFlag : int
      - .isOwner : boolean
      - .isFamily : boolean
      - .isShared : boolean
      - .isBinded2 : boolean
      - .isReadonlyShared : boolean
      - .getDeviceWifi() ⇒ IDeviceWifi
      - .getSubDevices() ⇒ Promise.<Array.<IDevice>>
      - .getVirtualDevices() ⇒ Promise.<Array.<IDevice>>
      - .getBluetoothLE(peripheralUUID) ⇒ IBluetoothLE
      - .reportLog(log)
      - .loadScenes(sceneType, opt) ⇒ Promise.<Array.<IScene>>
      - .loadTimerScenes(opt) ⇒ Promise.<Array.<IScene>>
      - .createScene(sceneType, opt) ⇒ IScene
      - .createTimerScene(opt) ⇒ IScene
    - ~DeviceEvent : object

module.exports ⏏

Kind: Exported member
Export:

module.exports.IDeviceWifi

Kind: static interface of module.exports

.IDeviceWifi
- .deviceID : string
- .loadProperties(...propNames) ⇒ Promise.<Map>
- .loadPropertiesFromCloud(...propNames) ⇒ Promise.<Map>
- .callMethod(method, args, extraPayload) ⇒ Promise.<json>
- .callMethodFromCloud(method, args) ⇒ Promise.<json>
- .localPing() ⇒ Promise.<boolean>
- .subscribeMessages(...propertyOrEventNames) ⇒ Promise.<EventSubscription>
- .getVersion() ⇒ Promise.<any>
- .startUpgradingFirmware() ⇒ Promise.<DeviceVersion>
- .setFirmwareUpdateErrDic(message) ⇒
- .setFirmwareNotCheckUpdate(notCheck) ⇒ Promise

iDeviceWifi.deviceID : `string`

获取设备ID，same as Device.deviceID

Kind: instance property of IDeviceWifi
Example

import {Device} from 'miot'
...
let did = Device.getDeviceWifi().deviceID

iDeviceWifi.loadProperties(...propNames) ⇒ `Promise.<Map>`

加载属性数据内部调用get_prop 方法,会依据当前环境选择从本地局域网或者云端获取, 并将返回数据写成{key:value}格式

Kind: instance method of IDeviceWifi
Returns: Promise.<Map> - Map<name, value>

Param	Type
...propNames	`*`

Example

Device.getDeviceWifi().loadProperties("a", "b").then(map=>{
 const a = map.get("a")
 const b = map.get("b")
})

iDeviceWifi.loadPropertiesFromCloud(...propNames) ⇒ `Promise.<Map>`

从云端加载属性数据内部调用get_prop 方法, 并将返回数据写成{key:value}格式

Kind: instance method of IDeviceWifi
Returns: Promise.<Map> - Map<name, value>

Param	Type
...propNames	`*`

iDeviceWifi.callMethod(method, args, extraPayload) ⇒ `Promise.<json>`

调用设备方法若与设备通信处于同一个 wifi 下会使用局域网传输数据，如果不在同一个 wifi 下由米家服务器转发请求

Kind: instance method of IDeviceWifi
Returns: Promise.<json> - {code:0,result:{},id:""}

Param	Type	Description
method	`string`	方法名
args	`json`	参数
extraPayload	`json`	额外参数，根据设备需求设定。在payload数据中设置额外参数

Example

Device.getDeviceWifi().callMethod('getProps', [prop1,prop2])
 .then(res => console.log('success:', res))
 .catch(err => console.error('failed:', err))
//对应payload参考：
//{'method': 'getProps', 'params':[prop1,prop2]}

Device.getDeviceWifi().callMethod('getProps', [prop1,prop2], {sid:Device.deviceID, 'key1':'xxxx'})
 .then(res => console.log('success:', res))
 .catch(err => console.error('failed:', err))
//对应payload参考：
//{'method': 'getProps', 'params':[prop1,prop2], 'sid':'xxxxx', 'key1': 'xxxx'}

iDeviceWifi.callMethodFromCloud(method, args) ⇒ `Promise.<json>`

云端调用设备方法同 callMethod 函数不在同一个 wifi 下的情况

Kind: instance method of IDeviceWifi
Returns: Promise.<json> - 请求成功返回 {code:0,result:{} }

Param	Type	Description
method	`string`	方法名
args	`json`	参数

iDeviceWifi.localPing() ⇒ `Promise.<boolean>`

ping 操作检查设备本地局域网通信是否可用

Kind: instance method of IDeviceWifi
Example

Device.getDeviceWifi().localPing()
 .then(res => console.log('success:', res))
 .catch(err => console.log('failed:', err))

iDeviceWifi.subscribeMessages(...propertyOrEventNames) ⇒ `Promise.<EventSubscription>`

订阅设备消息

Kind: instance method of IDeviceWifi

Param	Type	Description
...propertyOrEventNames	`string`	在开发平台上声明的 prop 与 event 名

Example

import {Device, DeviceEvent} from 'miot'
...
let msgSubscription = null;
Device.getDeviceWifi().subscribeMessages('prop1','prop2')
 .then(subcription => {
     //call this when you need to unsubscribe the message
     msgSubscription = subcription;
 })
 .catch(() => console.log('subscribe failed'))
...
//等效于使用DeviceEvent
const subscription = DeviceEvent.deviceReceivedMessages.addListener(
(device, messages)=>{
  if(messages.has('prop1')){
     const prop1 = messages.get('prop1');
     ...
  }
  ...
})
...
//unsubscribe the props
msgSubscription&&msgSubscription.remove();

iDeviceWifi.getVersion() ⇒ `Promise.<any>`

获取版本号

Kind: instance method of IDeviceWifi

iDeviceWifi.startUpgradingFirmware() ⇒ `Promise.<DeviceVersion>`

获取固件的状态，可以确认是否需要升级，也可以获得当前的升级状态。 /home/devupgrade

Kind: instance method of IDeviceWifi
Example

Device.getDeviceWifi().startUpgradingFirmware()
 .then(res => console.log('success:', res))
 .catch(err => console.log('failed:', err))

iDeviceWifi.setFirmwareUpdateErrDic(message) ⇒

为设备固件升级失败添加自定义的errorCode与错误提示信息的索引注意分享过来的设备是无法进行固件升级的，所以此时此方法无效。 Android暂未适配

Kind: instance method of IDeviceWifi
Returns: boolean 设置是否成功

Param	Type	Description
message	`json`	以errorCode为key，以错误提示信息为value的字典。key和value的数据类型都须是string。

Example

let ret = Device.getDeviceWifi().setFirmwareUpdateErrDic('message')

iDeviceWifi.setFirmwareNotCheckUpdate(notCheck) ⇒ `Promise`

设置设备控制页不检查固件升级 Android暂未适配

Kind: instance method of IDeviceWifi

Param	Type	Description
notCheck	`boolean`	是否不检查更新 true-不自动检查 false-自动检查

Example

Device.getDeviceWifi().setFirmwareNotCheckUpdate(true|false)
 .then(res => console.log('success:', res))
 .catch(err => console.log('failed:', err))

module.exports~IDevice

设备信息的实例仅适用于当前插件适配的设备

Kind: inner interface of module.exports
Example

import 'Device' from 'miot'
...
let did = Device.deviceID
let model = Device.model
...

~IDevice
- .deviceID : string
- .model : string
- .isReady : boolean
- .parentDevice : IDevice
- .isRootDevice : boolean
- .isVirtualDevice : boolean
- .owner : IAccount
- .extra : string
- .name : string
- .session : string
- .iconURL : string
- .permitLevel : int
- .isSetPinCode : boolean
- .parentModel : string
- .showMode : int
- .timeZone : string
- .mac : string
- .lastVersion : string
- .propInfo : json
- .IP : string
- .RSSI : string
- .SSID : string
- .BSSID : string
- .type : int
- .lastModified : long
- .location : int
- .latitude : double
- .longitude : double
- .isVoiceDevice ⇒ boolean
- .isOnline : boolean
- .resetFlag : int
- .isOwner : boolean
- .isFamily : boolean
- .isShared : boolean
- .isBinded2 : boolean
- .isReadonlyShared : boolean
- .getDeviceWifi() ⇒ IDeviceWifi
- .getSubDevices() ⇒ Promise.<Array.<IDevice>>
- .getVirtualDevices() ⇒ Promise.<Array.<IDevice>>
- .getBluetoothLE(peripheralUUID) ⇒ IBluetoothLE
- .reportLog(log)
- .loadScenes(sceneType, opt) ⇒ Promise.<Array.<IScene>>
- .loadTimerScenes(opt) ⇒ Promise.<Array.<IScene>>
- .createScene(sceneType, opt) ⇒ IScene
- .createTimerScene(opt) ⇒ IScene