02 基础插件设备模块 - MiEcosystem/miot-plugin-sdk GitHub Wiki

miot/device

设备相关 API,主要包括当前实例设备对象，部分对象方法，以及设备事件 设备对象的属性，请直接查看下面各个API/属性说明 部分对象方法主要包含：获取小米WiFi设备控制类，获取蓝牙设备控制类，修改时区，修改设备名称，获取定向推荐，获取当前设备属性等。 设备事件主要有：设备名称更改，设备时区更改，设备状态更改，获取到设备消息,获取蓝牙设备固件版本信息

Export: public
Doc_name: 基础插件设备模块
Doc_index: 2
Doc_directory: device
Example

componentDidMount(){
     this._deviceNameChangedListener = DeviceEvent.deviceNameChanged.addListener(device => {
     this.state.name = device.name;
     this.setState({});
  });
}

一定要记得，用完后要移除，否则可能报错

 componentWillUnmount(){
     this._deviceNameChangedListener && this._deviceNameChangedListener.remove();
 }

BasicDevice 当前设备实例对象，用于获取当前设备属性,调用设备基础方法等

Example

import {Device} from 'miot/device'

//属性获取
let did = Device.deviceID
let deviceModel = Device.model
//wifi方法 e.g RPC请求
Device.getDeviceWifi().callMethod('method_name', params)
 .then(res => {//here is the success result})
 .catch(err => {//error happened})

其余具体使用请参考具体API文档

module.exports ⏏

Kind: Exported member
Export: 导出rootDevice

module.exports.BasicDevice

Kind: static interface of module.exports

basicDevice.needUpgrade ⇒ boolean

是否有固件更新，为了显示小红点,一般不需要开发者设置，自己使用

Kind: instance property of BasicDevice

basicDevice.needUpgrade

是否有固件更新，为了显示小红点

Kind: instance property of BasicDevice

Param Type
value boolean

basicDevice.deviceID ⇒ string

获取设备 id，每一个真实设备都有一个唯一的 id

Kind: instance property of BasicDevice
Read only: true

basicDevice.model ⇒ string

获取设备的 model,设备类型的唯一标识

Kind: instance property of BasicDevice
Read only: true

basicDevice.isReady ⇒ boolean

设备是否已经可用,没有did的设备的插件，可能调用此方法判断接口是否可用。此方法没什么其他存在的意义，一般也不需要使用此方法

Kind: instance property of BasicDevice
Read only: true

basicDevice.parentDevice ⇒ BasicDevice

如果有父设备，直接获取 父设备 Device，一般是网关子设备才会有父设备，注意：设备组的子设备没有父设备，或者说设备组子设备的父设备不是这个设备组

Kind: instance property of BasicDevice
Read only: true

basicDevice.isRootDevice ⇒ boolean

是否是根设备，没有父设备的设备，即为根设备。一般网关子设备不是根设备，其他的都是

Kind: instance property of BasicDevice
Read only: true

basicDevice.orderTime ⇒ Number

设备绑定到当前账号（当前家庭）下的时间戳（北京时间）

Kind: instance property of BasicDevice
Returns: Number - 单位秒
Read only: true
Since: 10057

basicDevice.getFreqFlag ⇒ object

是否为常用设备

Kind: instance property of BasicDevice
Returns: object - 成功时：{code:0,data:[true|false]}
Read only: true
Since: 10052

basicDevice.getFreqCameraFlag ⇒ object

是否为常用摄像机

Kind: instance property of BasicDevice
Returns: object - 成功时：{code:0,data:[true|false]}
Read only: true
Since: 10052

basicDevice.isVirtualDevice ⇒ boolean

是否虚拟设备，虚拟设备主要指老的设备组（Yeelight灯组，飞利浦灯组）。 注意：mesh设备组，灯组2.0均不是虚拟设备

Kind: instance property of BasicDevice
Read only: true
Since: 10003

basicDevice.owner ⇒ IAccount

设备所有者的小米账号, 可以使用 load 获取 account 下的所有数据。 不调用 load 只有 ID，nickName 字段有值。 注:Service.account 不load时只有ID可用，与此处不一样。

Kind: instance property of BasicDevice
Returns: IAccount - 账号信息。详见Account.js
Read only: true
See: module:miot/Account

basicDevice.name ⇒ string

设备的名称。注意与loadRealDeviceConfig返回的deviceName的区别

Kind: instance property of BasicDevice
Read only: true

basicDevice.session ⇒ string

设备的 token 加密后生成的固定值，在设备快连入网时生成，能唯一标识设备的生命周期，直至被重置、重新快连入网。可以使用此字段，鉴定设备有没有被重新绑定。注意该 Session 并非设备与服务器交互时认证所用 Token，只能用于标识作用 使用方法：将session保存到手机里(Host.storage.set)，或者userdata（Service.smarthome.setDeviceData）,后续打开插件后，对比保存的session与当前session，如果相同，则表示未重置

Kind: instance property of BasicDevice
Read only: true

basicDevice.iconURL ⇒ string

开发者平台配置的设备图标 一个图片的下载地址，和米家设备列表页的图标一样

Kind: instance property of BasicDevice
Read only: true

basicDevice.permitLevel ⇒ int

当前账户对设备的控制权限，主要用于分享的设备 4:普通分享 36:只读分享。一般情况下，分享的设备可以被控制，但是不能添加/删除/修改 自动化和倒计时定时。如果出现被分享的设备，有不该有的功能，请通过此处的permitLevel判断并增加权限控制

Kind: instance property of BasicDevice
Read only: true

basicDevice.isSetPinCode ⇒ boolean

是否设置了进入插件使用密码，如果你们的设置页面有修改密码功能，可以通过此字段，判断密码是否设置了。

Kind: instance property of BasicDevice
Read only: true

basicDevice.showMode ⇒ int

是否在设备列表显示，一般不需要使用此方法。 0 -- 不显示

Kind: instance property of BasicDevice
Read only: true

basicDevice.mac ⇒ string

获取设备的 mac 地址，蓝牙设备返回为空字符串

Kind: instance property of BasicDevice
Read only: true

basicDevice.lastVersion ⇒ string

获取当前固件的版本，记住，只能获取wifi设备/combo设备的固件版本，其他设备的固件版本，请使用其他方法读取。比如：蓝牙使用BTDevice.getVersion()。如果是zigbee，红外等设备，请尝试此方法和蓝牙的getVersion方法，看哪个能获取到正确的值，然后就使用哪个。

Kind: instance property of BasicDevice
Read only: true

basicDevice.latestVersion ⇒ string

获取当前最新固件的版本，蓝牙设备连接后可获取，wifi设备调用 checkFirmwareUpdateAndAlert 后可获取到

Kind: instance property of BasicDevice
Read only: true

basicDevice.latest_mcu_version ⇒ string

获取当前最新固件的版本的mcu的版本号，使用时需要判空

Kind: instance property of BasicDevice
Read only: true
Hide:
Since: 10052

basicDevice.IP ⇒ string

获取设备的 ip，蓝牙设备的ip为空

Kind: instance property of BasicDevice
Read only: true

basicDevice.RSSI ⇒ string

获取 wifi 信号强度，蓝牙/Mesh设备的为空

Kind: instance property of BasicDevice
Read only: true

basicDevice.SSID ⇒ string

获取连接 wifi 的名称，蓝牙/Mesh设备的为空

Kind: instance property of BasicDevice
Read only: true

basicDevice.BSSID ⇒ string

获取连接 wifi 的mac 地址，蓝牙/Mesh设备为空

Kind: instance property of BasicDevice
Read only: true

basicDevice.type ⇒ int

获取设备类型，0：wifi单模设备，1：yunyi设备，2：云接入设备，3：zigbee设备，5：虚拟设备，6：蓝牙单模设备，7：本地AP设备，8：蓝牙wifi双模设备，9：其他，10：功能插件，11：SIM卡设备，12：网线设备，13：NB-IoT，14：第三方云接入，15：红外遥控器，16：BLE Mesh，17：虚拟设备（新设备组）

Kind: instance property of BasicDevice
Read only: true

basicDevice.lastModified ⇒ long

获取上次修改（修改名称，绑定/解绑等）的时间戳, 例如1532587811237 暂时没想到它的使用场景，有开发者想到了可以联系米家更新文档

Kind: instance property of BasicDevice
Returns: long - 时间戳
Read only: true

basicDevice.location ⇒ int

本地设备还是远程设备, 0未知 1本地 2远程。 iOS中，本地设备指的是既没有绑定到iot平台，又不是被分享的设备。注意：不是寻常理解的，同一个路由器的是本地设备，不同路由器的是远程设备，iOS中，无法获取一个设备是否在同一个局域网

Kind: instance property of BasicDevice
Returns: int - 0未知 1本地 2远程。
Read only: true

basicDevice.latitude ⇒ double

设备的纬度

Kind: instance property of BasicDevice
Read only: true

basicDevice.longitude ⇒ double

设备的经度

Kind: instance property of BasicDevice
Read only: true

basicDevice.isVoiceDevice ⇒ boolean

是否支持语音（一般指小爱同学）控制

Kind: instance property of BasicDevice
Read only: true

basicDevice.isOnline ⇒ boolean

设备是否在线 true 在线。离线设备在插件内几乎所有功能均不可操作

Kind: instance property of BasicDevice
Read only: true

basicDevice.mtu

获取蓝牙设备的mtu大小，当设备connect/disconnect 时候，会发生变化

Kind: instance property of BasicDevice

basicDevice.isOwner ⇒ boolean

是否是自己的设备，若是别人（包含家属）分享给你的设备，isOwner则为false

Kind: instance property of BasicDevice
Read only: true

basicDevice.isFamily ⇒ boolean

当前账户对设备的控制权限，主要用于分享的设备 4:普通分享 36:只读分享 68:家庭分享

Kind: instance property of BasicDevice
Read only: true

basicDevice.isShared ⇒ boolean

是否是别人分享的设备，若是家属分享给你的设备，isShared为fasle，isFamily为true

Kind: instance property of BasicDevice
Read only: true

basicDevice.isBinded ⇒ boolean

是否是已经绑定的设备，一般返回true

Kind: instance property of BasicDevice
Read only: true
Since: 10005

basicDevice.isReadonlyShared ⇒ boolean

是否是别人分享的只读设备,权限比isShared更小。受iot后台基础配置 - 产品共享影响。产品共享可配置为：支持（用户不可选共享权限），支持（用户可选共享权限）（可查看可操作设备，可查看不可操作设备），不支持共享 如果后台配置选择的支持（用户可选共享权限），然后设备拥有者分享时选择的是可查看不可操作设备，则此选项为True

Kind: instance property of BasicDevice
Read only: true

basicDevice.extra ⇒ string

Deprecated

除了基本信息的其他部分额外信息都在这个字段返回，如：{"fw_version":"1.4.0","mcu_version":"0001","isSetPincode":0} 可以解析为 json

Kind: instance property of BasicDevice
Read only: true

basicDevice.parentModel ⇒ string

Deprecated

父设备的 model,10023及其之后返回空字符串

Kind: instance property of BasicDevice
Read only: true

basicDevice.timeZone ⇒ string

Deprecated

获取设备时区,非实时加载，可能为空.如果需要自行获取最新设备时区值，请使用smarthome.getDeviceTimeZone(did)

Kind: instance property of BasicDevice

basicDevice.propInfo ⇒ json

Deprecated

获取 prop中保存的信息。当某设备有莫人属性时，这里为莫人属性的值，否则无此字段。不同设备类型，propInfo中包含的属性可能不同，propInfo一半是个json。

Kind: instance property of BasicDevice
Read only: true

basicDevice.resetFlag ⇒ int

Deprecated

重置标志，本地设备才会返回该字段，为1时表示设备刚刚reset过

Kind: instance property of BasicDevice
Read only: true

basicDevice.getDeviceWifi()

获取小米WiFi设备控制类 Device.getDeviceWifi().callMethod(xxx)

Kind: instance method of BasicDevice

basicDevice.deleteDevices(didAndPids)

批量删除设备, 不能删除 小米路由器/本地蓝牙/局域网直连设备，不能删除与自己设备无关的设备，比如，其他生态链公司的设备。

Kind: instance method of BasicDevice
Since: 10011

Param Type Description
didAndPids [ 'Array' ].<object> did 与 pid（Device.type） 列表 [{did:xx,pid:xx}, {did:xx,pid:xx}]

basicDevice.getSubDevices() ⇒ [ 'Promise' ].<Array.<BasicDevice>>

获取子设备列表，一般网关才会有子设备，注意此方法无法获取设备组的子设备。获取虚拟设备组的子设备，请使用Device.getDeviceWifi().getVirtualDevices()方法。Mesh设备组暂时没有查询子设备的方法。

Kind: instance method of BasicDevice
Returns: [ 'Promise' ].<Array.<BasicDevice>> - resolve：array子设备列表 reject：{code:xxx,message:xxx} -1:找不到网关设备 其他code：服务端错误/网络错误
Since: 10004
Example

import 'Device' from 'miot'
Device.getSubDevices()
.then(devices => {//get device list})

basicDevice.getLinkedBTDevices([did]) ⇒ Promise

获取蓝牙网关关联的普通蓝牙和蓝牙mesh设备列表。

Kind: instance method of BasicDevice
Returns: Promise - 返回数组设备信息的promise， {"mesh":[], "normal":""} resolve：array {iconURL,did,model,userId,extra,name,session,permitLevel,parentId,parentModel,mac,propInfo,ip,ssid,bssid,pid,latitude,longitude,isVoiceDevice,isOnline,ownerId,ownerName}，字段具体含义和BasicDevice中对应字段含义一样 reject：{code:xxx,error:xxx,extra:xxx} code只会等于-1。 res.code -1:网关设备不存在 401:只能查找当前设备或者父网关设备的列表 404:无子设备数据
Since: 10020

Param Type Default Description
[did] string "Device.deviceID" 蓝牙网关的did，可以为空，为空时默认取当前Device.deviceID

basicDevice.loadRealDeviceConfig(model) ⇒ DeviceConfig

获取某个model设备的默认配置，例如iconurl，名称等等

Kind: instance method of BasicDevice
Returns: DeviceConfig - 设备配置 resolve：DeviceConfig reject：不会走reject
Since: 10010

Param Type Description
model string 指定设备的model

basicDevice.getBluetoothLE(peripheralID) ⇒ IBluetoothLE

获取小米BLE蓝牙控制类, 注意: 在 iOS 平台上, 如果没有指定peripheralID, 则须先执行Bluetooth.scan(), 扫描到与device.mac匹配的蓝牙设备之后才能 connect 成功, 否则将不能成功执行后来的所有操作.

Kind: instance method of BasicDevice

Param Type Default Description
peripheralID string null - iOS平台上可以直接指定与设备 mac 匹配的peripheralID, android 平台不需要此参数

Example

import {Device} from 'miot/device'

const peripheralUUID4IOS = ...;

Device.getBluetoothLE(peripheralUUID4IOS).connect()
.then(ble=>{
     ble....
})
.catch(error=>{

})

basicDevice.reportDeviceGPSInfo() ⇒ [ 'Promise' ].<GPSInfo>

将当前手机的定位信息作为新的设备位置进行上报，该操作会更新设备的地理位置信息。

Kind: instance method of BasicDevice
Returns: [ 'Promise' ].<GPSInfo> - resolve：GPSInfo reject：{code:xxx,message:xxx} 其他code：网络错误/服务端错误
Since: 10020

basicDevice.getDeviceTimeZone() ⇒ Promise

获取当前设备的时区信息（国际标准时区），这里的设置不是指手机，而是指iot设备。注意：国际标准时区中，没有Asia/Beijing。

Kind: instance method of BasicDevice
Returns: Promise - 成功进入then，失败进入catch。then：res="Asia/Shanghai"; resolve：timezone string reject：{code: xxx, message: xxx}
Since: 10021

basicDevice.getDeviceBleMac() ⇒ Promise

获取当前设备ble mac

Kind: instance method of BasicDevice
Returns: Promise - 成功进入then，失败进入catch。res： {"code": 0, "message": "ok", "result": {"data": {"ble_mac": "B0:41:1D:E9:2E:CE"}}}; reject：{code: xxx, message: xxx} 使用场景: 设备同时存在wifi mac与 ble mac,且绑定插件时上报的是wifi mac，既Device.mac获取的是wifi mac 使用条件: 设备ble mac上报给了后台，该接口方可获取到数据
Since: 10057
Example

Device.getDeviceBleMac().then((res)=>{
  let mac = res['result']['data']['ble_mac'];
}).catch((err)=>{
  console.log('get ble mac failed  : ', err);
});

basicDevice.changeDeviceName(newName, did) ⇒ Promise

修改设备/子设备的名字，注意不支持蓝牙网关对子设备名称的修改

Kind: instance method of BasicDevice
Returns: Promise - 成功进入then，失败进入catch resolve：成功时，res为新名称。同时，DeviceEvent的deviceNameChanged会被触发 reject：{code: xxx, message: xxx} -1:新名称不合法 -2:非当前设备或者子设备，没有改名权限 其他code：网络问题/服务端问题
Since: 10022

Param Type Default Description
newName String 设备的新的名称
did String 如果修改自身的名称，可不传，如果修改子设备的，则需要传子设备的did。如果did是其他，调用此方法会走reject

basicDevice.getCurrentDeviceValue() ⇒ [ 'Promise' ].<Object>

获取当前设备的设备信息

Kind: instance method of BasicDevice
Returns: [ 'Promise' ].<Object> - 当前设备的值 resolve:类似{'prop.2.1':'on','prop.light':8}这样的{key:value}键值对，其中键为设备属性名称，值为设备属性值 reject：device.prop为空，则走reject，返回null
Since: 10024

basicDevice.getVirtualDevices()

Deprecated

获取虚拟设备的子设备列表，

Kind: instance method of BasicDevice

basicDevice.getRecommendScenes()

Deprecated

获取设备定向推荐信息，展示推荐入口使用：用于获取插件上方偶尔弹出的提示条/广告条数据，比如：设备信号差，请调整设备位置。

Kind: instance method of BasicDevice

basicDevice.requestAuthorizedDeviceListData()

Deprecated

获取当前设备列表中的指定model的设备列表。需要在common_extra_config增加配置，暂时用于秒秒测的互联互通功能。

Kind: instance method of BasicDevice

basicDevice.checkIsHomeKitDevice()

Deprecated

检查当前设备是否支持HomeKit，Android系统不支持HomeKit设备。需要在plato平台配置homekit_config，包含在内的设备，isHomekit才可能返回true

Kind: instance method of BasicDevice

basicDevice.checkHomeKitConnected()

Deprecated

检查当前设备是否已经接入了HomeKit，Android不支持。如果没有接入，可以调用下面的bindToHomeKit方法，将设备接入

Kind: instance method of BasicDevice

basicDevice.bindToHomeKit()

Deprecated

将当前设备绑定到HomeKit中

Kind: instance method of BasicDevice

basicDevice.checkFirmwareUpdateAndAlert()

Deprecated

检查wifi设备固件升级弹窗。该方法会触发升级弹窗alert提示。

Kind: instance method of BasicDevice

basicDevice.readDeviceNetWorkInfo() ⇒ Object

Deprecated

实时获取设备的网络信息包括网络强度，此方法一般情况下不走reject

Kind: instance method of BasicDevice
Returns: Object - NetworkInfo

basicDevice.createScene(同上loadScenes的sceneType, opt) ⇒ IScene

Deprecated

创建场景

Kind: instance method of BasicDevice
See: module:miot/service/scene

Param Type Description
同上loadScenes的sceneType SceneType
opt json 同上loadScenes的opt，此处传入opt，后续获取场景时，可根据此opt来筛选

basicDevice.createTimerScene(opt) ⇒ IScene

Deprecated

创建定时场景

Kind: instance method of BasicDevice
See: module:miot/service/scene

Param Type Default Description
opt json 同上loadScenes的opt，此处传入opt，后续获取场景时，可根据此opt来筛选

basicDevice.loadScenes(sceneType, opt) ⇒ [ 'Promise' ].<Array.<IScene>>

Deprecated

加载本设备相关的场景

Kind: instance method of BasicDevice
See: module:miot/service/scene

Param Type Default Description
sceneType * SceneType.Timer(定时场景)，SceneType.Artificial(人工场景)，SceneType.Automatic(自动场景)
opt * {identify,name} identify：代表场景的分类，创建场景时可自定义此参数；如果获取场景的时候传入identify，表示获取identify类场景列表；如果不需要对场景分类，此参数可忽略。name:场景名字

basicDevice.loadTimerScenes(opt) ⇒ [ 'Promise' ].<Array.<IScene>>

Deprecated

加载定时场景

Kind: instance method of BasicDevice
See: module:miot/service/scene

Param Type Default Description
opt json 同上loadScenes的opt

basicDevice.reportLog(log)

Deprecated

上报日志，写入文件，在用户反馈时可以查看。比如某个地方报错/出错了，打上log，用户反馈后，能在后台查看到。查看地址：https://iot.mi.com/fe-op/operationCenter/userFeedback

Kind: instance method of BasicDevice

Param Type
log string

basicDevice.getRoomInfoForCurrentHome(did) ⇒ [ 'Promise' ].<Object>

查询设备的房间信息

Kind: instance method of BasicDevice
Returns: [ 'Promise' ].<Object> - {code: 0, data: {roomId, homeId, roomName, homeName} }
Since: 10039

Param Type Default Description
did string null DeviceID，默认为当前设备

basicDevice.getAllDevicesOfBelongedCompanies() ⇒ [ 'Promise' ].<Object>

获取与当前设备相同企业组的所有设备(包括当前设备)

Kind: instance method of BasicDevice
Returns: [ 'Promise' ].<Object> - 成功时{code:0,data:[{...device},{...device},...]} 失败时：{code:-1,message:"cannot get current device info"} {code:-2,message:"get company identifier error"}
Since: 10052
Example

Device.getAllDevicesOfBelongedCompanies().then(res=>{
 alert(JSON.stringify(res));
}).catch(err =>{
 alert(JSON.stringify(err));
});

module.exports.RootDevice ⇒ BasicDevice

Kind: static constant of module.exports

module.exports~DeviceEvent : object

DeviceEvent 当前设备事件：可以理解为iOS中的通知，或者Android中的广播.表示此事件发生后，通知监听此事件的组件执行某操作。

Kind: inner namespace of module.exports

DeviceEvent.BLESpecNotifyActionEvent

订阅ble spec 消息推送；除了订阅之外，插件需要与设备建立蓝牙连接，并主动扫描设备的特征值，设备才会给插件推送消息。

Kind: static property of DeviceEvent

Param Type Description
device IDevice
messages [ 'Map' ].<string, object> 接收到的数据,value为property或者event的值
originData [ 'Map' ].<string, object> 接收到的数据，value为相应property或者event推送到手机的原始内容

Example

//详细使用示例可以参考com.xiaomi.bledemo/Main/BleSpec.js
       let listener0= DeviceEvent.BLESpecNotifyActionEvent.addListener((device, data) => {
          console.log('receive prop(event) changed notification:' + JSON.stringify(data))
          data.forEach((key, value) => {
            console.log(`receive prop(event) changed notification,prop:${ key }`, JSON.stringify(value));
          });
        });

        this._s1 = BluetoothEvent.bluetoothSeviceDiscovered.addListener((blut, services) => {
          if (services.length <= 0) {
          return;
          }
          console.log('bluetoothSeviceDiscovered', blut.mac, services.map(s => s.UUID), bt.isConnected);

          const s = services.map(s => ({ uuid: s.UUID, char: [] }));
          services.forEach(s => {
            s.startDiscoverCharacteristics();
          });
        }

        bt = Device.getBluetoothLE();
        if(bt.isConnected){
          bt.startDiscoverServices();
          bt.subscribeMessages('prop.2.1','event.2.1').then(res => {
            console.log('subscribe exception success,res:',JSON.stringify(res));
          }).catch(err => console.log('subscribe exception fail'))
        } else if(bt.isConnecting){
          let listener1 = BluetoothEvent.bluetoothConnectionStatusChanged.addListener((blut, isConnect) => {
          console.log('bluetoothConnectionStatusChanged', blut, isConnect);
          if (bt.mac === blut.mac) {
            if(isConnect){
              bt.startDiscoverServices();
              bt.subscribeMessages('prop.2.1','event.2.1').then(res => {
                console.log('subscribe exception success,res:',JSON.stringify(res));
              }).catch(err => console.log('subscribe exception fail'))
            }else{
              console.log('connect bledevice error');
            }
            listener1.remove();
          }
        }else{
          bt.connect(scType,{ did: Device.deviceID }).then(res=>{
            bt.startDiscoverServices();
            bt.subscribeMessages('prop.2.1','event.2.1').then(res => {
              console.log('subscribe exception success,res:',JSON.stringify(res));
              }).catch(err => console.log('subscribe exception fail'))
            });
          });
        }

"deviceNameChanged" (device)

设备名称变更事件

Kind: event emitted by DeviceEvent
Since: 1.0.0

Param Type Description
device IDevice 发生变更的设备

"deviceTimeZoneChanged" (device)

设备时区变更事件

Kind: event emitted by DeviceEvent
Since: 1.0.0

Param Type Description
device IDevice 发生变更的设备

"bleDeviceFirmwareNeedUpgrade" (device)

蓝牙设备的固件版本有更新

Kind: event emitted by DeviceEvent
Since: 10039

Param Type
device IDevice

"deviceStatusChanged" (device, newStatus)

设备状态变更事件

Kind: event emitted by DeviceEvent

Param Type Description
device IDevice 发生变更的设备
newStatus [ 'Map' ].<string, object> { isOnline: false }

"deviceReceivedMessages" (device, messages, originData)

设备消息,注意订阅的消息都是通过此方法返回。

Kind: event emitted by DeviceEvent

Param Type Description
device IDevice
messages [ 'Map' ].<string, object> 接收到的数据
originData array 接收到的数据, [{key,time,value}]

Example

import {Device, DeviceEvent} from 'miot'

let msgSubscription = null;
// 普通设备：
Device.getDeviceWifi().subscribeMessages("prop.power", "event.something").then(subcription=>{
     msgSubscription = subcription;
});
// miot-spec设备（参数为：prop.siid.piid或event.siid.eiid）：
Device.getDeviceWifi().subscribeMessages("prop.2.1", "event.3.1").then(subcription=>{
     msgSubscription = subcription;
});

...
const subscription = DeviceEvent.deviceReceivedMessages.addListener(
(device, messages)=>{
 // 普通设备
  if(messages.has('prop.power')){
     const power = messages.get('prop.power');
     ...
  }
 // miot-spec设备
  if(messages.has('prop.2.1')){
     const power = messages.get('prop.2.1');
     ...
  }
  ...
})
...

msgSubscription&&msgSubscription.remove();

"multiSwitchNameChanged" (value, did)

多键开关名称变更事件

Kind: event emitted by DeviceEvent
Since: 10037

Param Type Description
value [ 'Map' ].<string, object> {"1":{"ai_desc":"","home_id":1,"id":1,"name":"","icon":"","room_id":1},"2":{"ai_desc":"","home_id":1,"id":2,"name":"","icon":"","room_id":1}}
did String 设备did

"pinCodeVerifyPassed"

插件密码校验通过（Android only）

Kind: event emitted by DeviceEvent
Since: 10047
Example

DeviceEvent.pinCodeVerifyPassed.addListener(() => { console.log('android pinCodeVerifyPassed'); });
})

"pinCodeSwitchChanged" (device, switchStatus)

插件密码设置改变事件

Kind: event emitted by DeviceEvent
Since: 10053

Param Type Description
device IDevice 发生变更的设备
switchStatus [ 'Map' ].<string, object> { isSetPinCode: false/true }

module.exports~DeviceConfig : Object

Kind: inner typedef of module.exports
Properties

Name Type Description
deviceIconURL string 设备的实物icon url
deviceName string 设备类型的名称。注意此名称不是设备名称
resetPageURL string 设备的重置引导url

module.exports~GPSInfo : Object

Kind: inner typedef of module.exports
Properties

Name Type Description
longitude number 经度
latitude number 纬度
countryCode string 国家码
adminArea string 地区信息
locality string 城市信息
subLocality string 城区信息
thoroughfare string 街道信息
language string 地区语言信息
⚠️ **GitHub.com Fallback** ⚠️