# Device 设备模块

# 概述

Device 模块为设备类型的小程序相关模块,提供获取设备数据、物模型相关接口。

# 导入模块

import { Device } from '@ezviz/mini-sdk';

# deviceSerial

序列号

Device.deviceSerial;

# localIndex

当前资源号

Device.localIndex;

# resourceIdentifier

当前资源类型

Device.resourceIdentifier;

# channelNo

当前通道号

Device.channelNo;

# version

设备版本号

Device.version;

# isOnline

设备是否在线

Device.isOnline;

# isMine

是否是设备拥有者

Device.isMine;

# name

设备名称

Device.name;

# devicePicPrefix

设备图片前缀

Device.devicePicPrefix;

# offlineTime

离线时间

Device.offlineTime;

# deviceCategory

大类

Device.deviceCategory;

# deviceType

设备类别

Device.deviceType;

# customType

行业设备自定义型号

Device.customType;

# deviceInfo

设备详情信息的对象

Device.deviceInfo;

# resourceInfo

设备资源信息的对象

Device.resourceInfo;

# wifiInfo

wifi 信息

Device.wifiInfo;

# getEIBConfig

获取 eib 配置

/**
 * @description getEIBConfig 获取eib配置
 * @param {string} deviceType 设备类别
 * @param {string} version 设备版本
 * @param {func} result 回调
 */
Device.getEIBConfig = (deviceType, version, result) => {
  // 回调信息
};

# getRNConfig

获取 RN 相关配置

/**
 * @description getRNConfig 获取RN相关配置
 * @param {string} deviceType 设备类别
 * @param {string} version 设备版本
 * @param {func} result 回调
 */
Device.getRNConfig = (deviceType, version, result) => {
  // 回调信息
};

# getLanguageConfig

获取语言配置

/**
 * @description getLanguageConfig 获取语言配置
 * @param {func} result 回调
 */
Device.getLanguageConfig = (deviceType, version, result) => {
  // 回调信息
};

# getLocalFeatures

获取自描述完整信息

/**
 * @description getLocalFeatures 获取自描述完整信息
 * @param {object} params { deviceSerial, localIndex }
 *  - @param {string} deviceType 设备类别
 *  - @param {string} version 设备版本
 * @param {func} result 回调
 */
Device.getLocalFeatures = (params, result) => {
  // 回调信息
};

# getLocalFeature

根据 key 获取自描述(本地)

/**
 * @description getLocalFeature 根据key获取自描述(本地)
 * @param {object} params { deviceSerial, localIndex } 不传时默认为当前设备
 *  - @param {string} deviceSerial
 *  - @param {string} localIndex
 * @param {string} itemKey 自描述key
 * @param {func} result 回调
 */
Device.getLocalFeature = (params, itemKey, result) => {
  // 回调信息
};

# setFeatureValue

设置自描述值

/**
 * @description setFeatureValue 设置自描述值
 * @param {object} params { deviceSerial, localIndex } 不传时默认为当前设备
 *  - @param {string} deviceSerial
 *  - @param {string} localIndex
 * @param {string} itemKey 自描述key
 * @param {string} value 自描述值
 * @param {func} result 回调
 */
Device.setFeatureValue = (params, itemKey, value, result) => {
  // 回调信息
};

# setFeatureAction

设置自描述值(Acion类型)

/**
 * @description setFeatureAction 设置自描述值(Acion类型)
 * @param {object} params { deviceSerial, localIndex } 不传时默认为当前设备
 *  - @param {string} deviceSerial
 *  - @param {string} localIndex
 * @param {string} itemKey 自描述key
 * @param {string} value 自描述值
 * @param {func} result 回调
 */
Device.setFeatureAction = (params, itemKey, value, result) => {
  // 回调信息
};

# getFeature

根据key获取自描述(从服务获取)

/**
 * @description getFeature 根据key获取自描述(从服务获取)
 * @param {object} params { deviceSerial, localIndex } 不传时默认为当前设备
 *  - @param {string} deviceSerial
 *  - @param {string} localIndex
 * @param {object} itemKey 自描述key
 * @param {func} result 回调
 */
Device.getFeature = (params, itemKey, result) => {
  // 回调信息
};

# getLocalActions

获取所有 action 功能点自描述

/**
 * @description getLocalActions 获取所有 action 功能点自描述
 * @param {object} params { deviceSerial, localIndex } 不传时默认为当前设备
 *  - @param {string} deviceSerial
 *  - @param {string} localIndex
 * @param {func} result 回调
 */
Device.getLocalActions = (params, result) => {
  // 回调信息
};

# getLocalAction

获取单个 action 功能点自描述

/**
 * @description getLocalAction 获取单个 action 功能点自描述
 * @param {object} params { deviceSerial, localIndex } 不传时默认为当前设备
 *  - @param {string} deviceSerial
 *  - @param {string} localIndex
 * @param {object} itemKey 自描述key
 * @param {func} result 回调
 */
Device.getLocalAction = (params, itemKey, result) => {
  // 回调信息
};

# getDeviceInfo

获取设备信息(网络)

/**
 * @description getDeviceInfo 获取设备信息(网络)
 * @param {string} deviceSerial 序列号
 * @param {func} result
 */
Device.getDeviceInfo(deviceSerial, (result) => {
  // 回调信息
});

# getLocalDeviceInfo

获取设备信息(本地)

/**
 * @description getLocalDeviceInfo 获取设备信息(本地)
 * @param {string} deviceSerial 序列号
 * @param {func} result
 */
Device.getLocalDeviceInfo = (deviceSerial, result) => {
  // 回调信息
});

# saveLocalDeviceInfo

保存设备信息(本地)

/**
 * @description saveLocalDeviceInfo 保存设备信息(本地)
 * @param {object} deviceInfo 设备信息
 * @param {func} result
 */
Device.saveLocalDeviceInfo(deviceInfo, (result) => {
  // 回调信息
});

# getGroupInfo

获取当前分组信息(本地)

/**
 * @description getGroupInfo 获取当前分组信息(本地)
 * @param {object} params { deviceSerial, localIndex } 不传时默认为当前设备
 *  - @param {string} deviceSerial
 *  - @param {string} localIndex
 * @param {func} result
 */
Device.getGroupInfo = (params, result) => {
  // 回调信息
});

# getGroups

获取所有分组信息(本地)

/**
 * @description getGroups 获取所有分组信息(本地)
 * @param {func} result
 */
Device.getGroups = (params, result) => {
  // 回调信息
});

# getResourceInfo

获取资源信息

/**
 * @description getResourceInfo 获取资源信息
 * @param {object} params { deviceSerial, localIndex }
 *  - @param {string} deviceSerial
 *  - @param {string} localIndex
 * @param {func} result
 */
Device.getResourceInfo = (params, result) => {
  // 回调信息
});

# getResourceInfoList

获取资源信息(多资源设备)

/**
 * @description getResourceInfoList 获取资源信息
 * @param {object} params { deviceSerial }
 *  - @param {string} deviceSerial
 * @param {func} result
 */
Device.getResourceInfoList = (params, result) => {
  // 回调信息
});

# getSupport

获取能力集(本地)

/**
 * @description getSupport 获取能力集(本地)
 * @param {object} deviceInfo 设备信息
 * @param {number} index 能力集编号
 */
Device.getSupport = (deviceInfo, index) => {
  // return 0不支持、1支持

});

# openPlayer

打开预览

/**
 * @description openPlayer 打开预览
 * @param {object} params { deviceSerial }
 *  - @param {string} deviceSerial
 * @param {func} result
 */
Device.openPlayer = (params, result) => {
  // 回调信息
});

# openAddSharePage

添加后置页进入分享

/**
 * @description openAddSharePage 添加后置页进入分享
 * @param {object} params { deviceSerial }
 *  - @param {string} deviceSerial
 * @param {func} result
 */
Device.openAddSharePage = (params, result) => {
  // 回调信息
});

# getSubDevicesList

获取子设备列表

/**
 * @description getSubDevicesList 获取子设备列表
 * @param {object} params { deviceSerial }
 *  - @param {string} deviceSerial
 * @param {func} result
 */
Device.getSubDevicesList = (params, result)  => {
  // 回调信息
});

# reloadGroup

刷新分组

/**
 * @description reloadGroup 刷新分组
 * @param {object} params { groupId }
 * @param {func} result
 */
Device.reloadGroup = (params, result)  => {
  // 回调信息
});

# editResourceName

修改资源名称

/**
 * @description editResourceName 修改资源名称
 * @param {object} params
 * @param {string} name
 * @param {func} result
 */
Device.editResourceName = (params, name, result) => {
  // 回调信息
});

# addDevice

添加设备

/**
 * @description addDevice 添加设备
 * @param {object} params
 * @param {func} result
 */
Device.addDevice = (params, result)  => {
  // 回调信息
});

# shareDevice

分享设备

/**
 * @description shareDevice 分享设备
 * @param {object} params
 * @param {func} result
 */
 Device.shareDevice = (params, result) => {
  // 回调信息
});