设备信息与控制 device

背景信息

SDK的安装与API调用方法，请参考快速开始。

获取设备物模型

getDeviceTSL

请求参数

出参

调用示例

import { device } from 'aliyun-livinglink-sdk';
device.getDeviceTSL({
  iotId:'xxx',
  productKey:'xxx'
}).then((res)=>{
  // success
}).catch((err)=>{
  // fail
})

返回示例

{
    "schema": "http://aliyun/iot/thing/desc/schema",
    "profile": {
        "productKey": "xxxxxxx",
        "deviceName": "xxxxxxxxxxxxxxxx"
    },
    "link": "/sys/a1xxxxpck/YzqEnxxxx2pjjo/thing/",
    "services": [
        {
            "outputData": [],
            "identifier": "ToggleLightSwitch",
            "inputData": [],
            "method": "thing.service.ToggleLightSwitch",
            "name": "翻转主灯开关",
            "required": false,
            "callType": "async"
        }
    ],
    "properties": [
        {
            "identifier": "LightSwitch",
            "dataType": {
                "specs": {
                    "0": "关闭",
                    "1": "开启"
                },
                "type": "bool"
            },
            "name": "主灯开关",
            "accessMode": "rw",
            "required": true
        }
    ],
    "events": [
        {
            "outputData": [
                {
                    "identifier": "ErrorCode",
                    "dataType": {
                        "specs": {
                            "0": "正常"
                        },
                        "type": "enum"
                    },
                    "name": "故障代码"
                }
            ],
            "identifier": "Error",
            "method": "thing.event.Error.post",
            "name": "故障上报",
            "type": "info",
            "required": true
        }
    ]
}

API支持度

获取产品信息

getProductInfo

请求参数

出参

调用示例

import { device } from 'aliyun-livinglink-sdk';
device.getProductInfo({
  iotId:'xxx',
  productKey:'xxx'
}).then((res)=>{
  // success
}).catch((err)=>{
  // fail
})

API支持度

获取设备信息

getDeviceInfo

请求参数

出参

调用示例

import { device } from 'aliyun-livinglink-sdk';
device.getDeviceInfo({
  iotId:'xxx',
  productKey:'xxx'
}).then((res)=>{
  // success
}).catch((err)=>{
  // fail
})

API支持度

获取设备组详情

getDeviceGroupInfo

请求参数

出参

调用示例

import { device } from 'aliyun-livinglink-sdk';
device.getDeviceGroupInfo({
  homeId:'xxx',
  controlGroupId:'xxx'
}).then((res)=>{
  // success
}).catch((err)=>{
  // fail
})

API支持度

订阅设备（组）事件

subscribeAll

请求参数

出参

调用示例

import { device } from 'aliyun-livinglink-sdk';
device.subscribeAll({
  iotId:'xxx',
  productKey:'xxx'
}).then((res)=>{
  // success
}).catch((err)=>{
  // fail
})

返回示例

[
  //  （主）设备订阅结果
  {
    code: '200',
    message: 'success
  },
   //  设备组订阅结果
  {
    code: '200',
    message: 'success
  }
]

API支持度

取消订阅设备（组）事件

unsubscribeAll

请求参数

出参

调用示例

import { device } from 'aliyun-livinglink-sdk';
device.unsubscribeAll({
  iotId:'xxx',
  productKey:'xxx'
}).then((res)=>{
  // success
}).catch((err)=>{
  // fail
})

返回示例

[
  //  取消（主）设备订阅结果
  {
    code: '200',
    message: 'success
  },
   //  取消设备组订阅结果
  {
    code: '200',
    message: 'success
  }
]

API支持度

获取设备属性

getProps

请求参数

出参

调用示例

import { device } from 'aliyun-livinglink-sdk';
device.getProps({
  iotId:'xxx',
  productKey:'xxx'
}).then((res)=>{
  // success
}).catch((err)=>{
  // fail
})

返回示例

{
  powerstate: 0,
  mode: 33,
  brightness: 5
}

API支持度

监听设备属性变化事件

onPropsChange

请求参数

出参

调用示例

import { device } from 'aliyun-livinglink-sdk';

device.onPropsChange((props)=>{
  console.log(props)
})

API支持度

获取设备云端在离线状态

getStatus

请求参数

出参

调用示例

device.getStatus({
  iotId:'xxx',
  productKey:'xxx'
}).then((res)=>{
  // success
}).catch((err)=>{
  // fail
})

返回示例

3

API支持度

监听设备云端在离线状态事件

onStatusChange

请求参数

出参

调用示例

import { device } from 'aliyun-livinglink-sdk';

device.onStatusChange((status)=>{
  console.log(props)
})

API支持度

获取设备事件

getEvents

请求参数

出参

调用示例

import { device } from 'aliyun-livinglink-sdk';
device.getEvents({
  iotId:'xxx',
  productKey:'xxx'
}).then((res)=>{
  // success
}).catch((err)=>{
  // fail
})

返回示例

[
  {
    "identifier": "Error",
    "time": 1517420842314,
    "type": "info",
    "value": {
      "Shrink5": 12,
      "Shrink20": {
        "testKey2": "val2",
        "testKey": "val"
      }
    }
  }
]

API支持度

设置设备属性

setProps

请求参数

出参

调用示例

import { device } from 'aliyun-livinglink-sdk';
device.setProps({
  iotId:'xxx',
  productKey:'xxx'
},{
  powerstate:0,
  mode:2
}).then((res)=>{
  // success
}).catch((err)=>{
  // fail
})

返回示例

{
  code:'200',
  message:'success'
}

API支持度

设置设备服务

callService

请求参数

出参

调用示例

import { device } from 'aliyun-livinglink-sdk';
device.callService({
  iotId:'xxx',
  productKey:'xxx'
}, 'CommonService',{
  method: 0,
  flag: 0,
}).then((res)=>{
  // success
}).catch((err)=>{
  // fail
})

返回示例

{
  code:'200',
  message:'success'
}

API支持度

开启本地连接

startLocalConnect

请求参数

出参

调用示例

device.startLocalConnect({
  iotId:'xxx',
  productKey:'xxx'
},).then((res)=>{
  // success
}).catch((err)=>{
  // fail
})

返回示例

{
  result:'success',
}

API支持度

断开本地连接

stopLocalConnect

请求参数

出参

调用示例

import { device } from 'aliyun-livinglink-sdk';
device.stopLocalConnect({
  iotId:'xxx',
  productKey:'xxx'
},).then((res)=>{
  // success
}).catch((err)=>{
  // fail
})

返回示例

{
  result:'success',
}

API支持度

查询本地连接状态

getLocalConnectionState

请求参数

出参

调用示例

import { device } from 'aliyun-livinglink-sdk';
device.getLocalConnectionState({
  iotId:'xxx',
  productKey:'xxx'
},).then((res)=>{
  // success
}).catch((err)=>{
  // fail
})

返回示例

{
  localConnectionState: 1,
  type: 2
}

API支持度

查询设备组本地连接状态

getGroupLocalConnectionState

请求参数

出参

调用示例

import { device } from 'aliyun-livinglink-sdk';
device.getGroupLocalConnectionState({
  iotId:'xxx',
  productKey:'xxx'
},).then((res)=>{
  // success
}).catch((err)=>{
  // fail
})

返回示例

{
  groupLocalStatus: 1,
  devicesLocalStatus: [
    {
      "iotId":"xxx1"
      "productKey":"X5eCzh6fEH7",
      "deviceName":"5gJtxDVeGAkaEztpisjX",
      "time":1510292697471,
      "status":3
    },
    {
      "iotId":"xxx2"
      "productKey":"X5eCzh6fEH7",
      "deviceName":"5gJtxDVeGAkaEztpisjX",
      "time":1510292697471,
      "status":1
    },
  ]
}
// 说明：status表示设备生命周期，目前有以下几个状态，1：本地在线；3：本地离线；time表示当前状态的开始时间

API支持度

监听设备本地连接状态事件

onLocalConnectChange

请求参数

出参

调用示例

import { device } from 'aliyun-livinglink-sdk';
device.onLocalConnectChange((msg)=>{
  console.log(msg)
})

API支持度

监听设备解绑事件

deviceUnbindEvent

请求参数

出参

调用示例

import { device } from 'aliyun-livinglink-sdk';
device.deviceUnbindEvent((msg)=>{
 console.log(msg)
})

API支持度

获取语料

getFunctionCorpus

请求参数

出参

调用示例

import { device } from 'aliyun-livinglink-sdk';
device.getFunctionCorpus({
 iotId:'xxx',
 productKey:'xxx'
},).then((res)=>{
 // success
}).catch((err)=>{
 // fail
})

返回示例

[
 { functionName: "开关", corpusList: ["打开灯", "关上灯"] },
 { functionName: "开关", corpusList: ["打开灯", "关上灯"] }
]

API支持度

查询父子设备信息

getSubDevice

请求参数

出参

调用示例

import { device } from 'aliyun-livinglink-sdk';
device.getSubDevice({
 iotId:'xxx',
 productKey:'xxx',
 skillId: 3404
}).then((res)=>{
 // success
}).catch((err)=>{
 // fail
})

返回示例

{
 hasSubDevice: true,
 childrenDevices:[
 {
 alias: "开关"
 childrenDevices: null
 devId: "a80171c72e190156567f2a5d3c04931ae1"
 devType: "开关"
 devTypeEn: "switch"
 elementCode: "e1"
 gmtCreate: "2023-06-20T06:16:34.000Z"
 icon: "https://ai-genie-center.oss-cn-hangzhou.aliyuncs.com/app-data/iot-center/1f9e27pdq_切片.png"
 linkType: 1
 parentDeviceId: "a80171c72e190156567f2a5d3c04931a"
 productKey: "18427591",
 skillId: 3404
 status: "{\"sceneNumber\":\"10312\",\"sceneOn\":\"10331\",\"sceneOff\":\"10332\",\"onlinestate\":\"offline\",\"sdkVersion\":\"14\",\"vendorModelVersion\":\"10\",\"powerstate\":\"0\",\"versionNumber\":\"66306\",\"subscribeGroupAddr\":\"61952\",\"tid\":\"182\"}"
 typeGroup: "开关"
 userId: "1368863065974110870"
 zone: "",
 shareInfo:{
 isShareDevice: false
 ownerNickName: null
 shareId: 0
 status: 0
 supportShare: false
 supportShareControl: false
 }
 }
 ]
}

API支持度

监听Mesh设备连接状态事件

onMeshStatusChange

请求参数

出参

调用示例

import { device } from 'aliyun-livinglink-sdk';
device.onMeshStatusChange((msg)=>{
 console.log(msg)
})

API支持度