01 系统服务模块 - MiEcosystem/miot-plugin-sdk GitHub Wiki

Service 模块提供的能力主要包括米家服务端及米家云平台提供的服务能力 能力主要包括： 账号管理(Account.js) 房间管理(room.js) 智能场景(scene.js) 云服务(smarthome.js) Spec协议(spec.js) 云存储(storage.js)

Export: public
Doc_name: 系统服务模块
Doc_index: 1
Doc_directory: service
Example

import {Service} from 'miot'

Service.getServerName().then(res=>{...})
Service.getUTCTimeFromServer().then(...)

Service.smarthome.reportGPSInfo(...).then(...)

Service.account.ID
Serivce.account.nickName
Service.account.avatar
Service.account.load().then(account=>{})

Service.scene.loadTimerScenes(...).then(scenes=>{})
Service.security.loadSecureKeys(...).then(keys=>{
...
})

Service.storage.getUserConfigs(key).then()

• miot/Service
  • static
    • .getServiceTokenWithSid(sid) ⇒ Promise
    • .revokePrivacyLicense() ⇒ [ 'Promise' ].<Object>
    • .deleteDevice() ⇒ [ 'Promise' ].<Object>
    • .applyForDeviceIDAndToken(model, mac) ⇒ Promise
  • inner
    • ~smarthome
    • ~miotcamera
    • ~ircontroller
    • ~account : IAccount
    • ~scene
    • ~security
    • ~storage
    • ~spec
    • ~callSmartHomeAPI(api, params)
    • ~callSmartHomeCameraAPI(api, subDomain, post, params)
    • ~callSmartHomeCameraAPI(api, subDomain, post, params)
    • ~callSmartHomeCameraAPI(host, path, method, params, needDevice) ⇒ [ 'Promise' ].<object>
    • ~getServerName() ⇒ [ 'Promise' ].<{countryName:"", countryCode:"", serverCode:""}>
    • ~getTimeZoneOfServer()
    • ~getUTCFromServer() ⇒ [ 'Promise' ].<long>
    • ~callSpecificAPI(url, method, params) ⇒ Promise

传入域名返回 serverToken 等信息，目前只支持小爱音箱的域名 Android从SDK-10039开始支持该接口

Kind: static method of miot/Service

since 10042 撤销隐私授权,插件调用该接口后需要主动调用退出插件

Kind: static method of miot/Service
Returns: [ 'Promise' ].<Object> - 成功时返回：{code:0,data:true}; 失败时返回：{code:-1,message:'invalid device'} ,或 {code:-2,message:'xxxxx'}
Example

Service.revokePrivacyLicense()
       .then(res=>{
         console.log(JSON.stringify(res));
         if( res.code ===0){
           console.log('success');
         }
       }).catch(err=>{
          console.log(JSON.stringify(err));
       });

since 10042 删除设备,插件调用该接口后需要主动调用退出插件

Kind: static method of miot/Service
Returns: [ 'Promise' ].<Object> - 成功时返回：{code:0,data:true}; 失败时返回：{code:-1,message:'invalid device'} ,或 {code:-2,message:'xxxxx'}
Example

Service.deleteDevice()
       .then(res=>{
         console.log(JSON.stringify(res));
         if( res.code ===0){
           console.log('success');
         }
       }).catch(err=>{
          console.log(JSON.stringify(err));
       });

某设备向服务器申请did和token Android暂不支持此方法

Kind: static method of miot/Service
Returns: Promise - resolve({res,did,token})

设备相关 API

Kind: inner property of miot/Service
See: module:miot/service/smarthome

摄像机相关 API

Kind: inner property of miot/Service
See: module:miot/service/miotcamera

红外 相关 API

Kind: inner property of miot/Service
See: module:miot/service/ircontroller

当前的用户信息

Kind: inner property of miot/Service
See: module:miot/Account

场景 API 的调用

Kind: inner property of miot/Service
See: module:miot/service/scene

安全相关设置操作

Kind: inner property of miot/Service
See: module:miot/service/security

用户存储操作, userProfile

Kind: inner property of miot/Service
See: module:miot/service/storage

spec 的请求

Kind: inner property of miot/Service
See: module:miot/service/spec

通用的请求米家后台接口的方法，与米家服务器交互。 不同设备开放的接口请参照与米家后台对接时提供的文档或说明，以后台给出的信息为准。 米家客户端只封装透传网络请求，无法对接口调用结果解释，有问题请直接联系项目对接后台人员或 PM。

想使用某个接口之前，先检查 SDK 是否已经收录，可在 miot-sdk/service/apiRepo.js 文件中查阅。 如果 SDK 暂时没有收录，可通过 issue 提出申请，提供接口的相关信息。

Kind: inner method of miot/Service
Since: 10024

专用摄像头相关接口请求 api in miot-sdk/service/apiRepo.js subDomain in miot-sdk/service/cameraSubDomain.js

Kind: inner method of miot/Service
Since: 10035

专用摄像头相关接口请求 api in miot-sdk/service/apiRepo.js subDomain in miot-sdk/service/cameraSubDomain.js

Kind: inner method of miot/Service
Since: 10044

小爱音箱相关接口请求,注意此请求传的是一个对象，里面部分对象有默认值，可不传

Kind: inner method of miot/Service
Returns: [ 'Promise' ].<object> - 透传接口，直接返回服务端返回的值 path, method = 0, params, needDevice = 1
Since: 10041

获取 米家 App 设置的地区和服务器信息 Android上返回的countryCode为大写，iOS上为小写，建议使用时在拿到countryCode后调用一下toLowerCase方法，都统一成小写

Kind: inner method of miot/Service

获取服务器所在时区

Kind: inner method of miot/Service

从米家服务器获取当前UTC时间戳（会发送网络请求）

Kind: inner method of miot/Service

调用当前手机设备的网关http服务 只封装透传网络请求，无法对接口调用结果解释，有问题请直接联系项目对接后台人员或 PM。

Kind: inner method of miot/Service
Returns: Promise - 成功时：返回网络请求的结果对应字符串， 相当于：response.body().string() 失败时：{"code":xxx, "message":"xxx" }
Since: 10031