@quec/rn-device-module 1.9.13 → 2.16.1

package/plugin.ts

@@ -0,0 +1,1180 @@
+import * as d from '@quec/quec-rnplugin-meta/lib/decorators'
+import * as t from '@quec/quec-rnplugin-meta/lib/types'
+
+/**
+ * 设备桥组件
+ */
+@d.Plugin("QuecRNDeviceModule", "3.2.0", t.PluginType.Module, ["vic.huang@quectel.com"], t.Platforms.All)
+export class QuecRNPlugin {
+
+    /**
+     获取当前设备WS订阅通道状态，订阅状态为true，不代表设备在线，只代表app和云端对当前设备进行了订阅
+     @param promise 回调 callback {"subscribe": true/false }
+     */
+    @d.Method('1.8.0')
+    isWebSocketSubscribe(promise: t.PromiseCb) {
+    }
+
+    /**
+     获取设备通道连接中状态
+     @param promise 回调 callback {"connectingState": 0/1/2/3/4/5/6/7}
+      *  onlineStateMaskWS   = 1 << 0,
+      *  onlineStateMaskWifi = 1 << 1,
+      *  onlineStateMaskBle  = 1 << 2,
+      * （0: all offline, 1: websocket online, 2 : wifi online, 3: wifi + websocket online, 4: ble online, 5: websocket + ble online, 6: ble + wifi online , 7: wifi + ble + ws online)
+     */
+    @d.Method('1.8.0')
+    getDeviceConnectingState(promise: t.PromiseCb) {
+    }
+
+    /**
+     * 设备链路连接状态状态通知
+     * @param object 事件数据 {"connectingState": 0/1/2/3/4/5/6/7}
+     *  connectingStateMaskWS   = 1 << 0,
+     *  connectingStateMaskWifi = 1 << 1,
+     *  connectingStateMaskBle  = 1 << 2,
+     * （0: all offline, 1: websocket online, 2 : wifi online, 3: wifi + websocket online, 4: ble online, 5: websocket + ble online, 6: ble + wifi online , 7: wifi + ble + ws online)
+     */
+    @d.Event('1.8.0')
+    onDeviceConnectingState(object: Object) {
+    }
+
+    /**
+     writeDpsByHttp
+     @param dps – dps 确保code和value不为空 [ {id:0, code:"electric" type:BOOL, value:false} ,{id:1, code:"electric2", type:INT, value:2}]
+     @param deviceList – deviceList 设备列表 [{"deviceKey":"", "productKey":""}]
+     @param type - 类型 1：透传 2：属性 3：服务
+     @param extraData – {
+      dataFormat 数据类型 1：Hex 2：Text（当type为透传时，需要指定 dataFormat）
+      cacheTime 缓存时间，单位为秒，缓存时间范围 1-7776000 秒，启用缓存时必须设置缓存时间
+      isCache  是否启用缓存 1：启用 2：不启用，默认不启用
+      isCover 是否覆盖之前发送的相同的命令 1：覆盖 2：不覆盖，默认不覆盖，启用缓存时此参数有效
+
+      **查看接口定义
+      }
+     @param promise 回调 callback
+     */
+    @d.Method('1.8.0')
+    writeDpsByHttp(dps: Array<Object>, deviceList: Array<Object>, type: t.Integer, extraData: Object, promise: t.PromiseCb) {
+    }
+
+    /**
+     read data points
+     @param dps – dps [ {id:0, type:BOOL, value:false} ,{id:1, type:INT, value:2}]
+     @param extraData – map
+      cacheTime  number  指令缓存时间，ws通道有效,单位是s
+      msgId   number  消息Id，ws通道有效
+     @param promise 回调 callback
+     */
+    @d.Method('1.6.8')
+    readDpsWithExtraData(dps: Array<Object>, extraData: Object, promise: t.PromiseCb) {
+    }
+
+    /**
+     read data points
+     @param dps – dps [ {id:0, type:BOOL, value:false} ,{id:1, type:INT, value:2}]
+     @param extraData – map
+      cacheTime  number  指令缓存时间，ws通道有效,单位是s
+      msgId   number  消息Id，ws通道有效
+     @param mode – mode 下发模式： 0 auto，1: websocket 2:wifi 3:ble
+     @param promise 回调 callback
+     */
+    @d.Method('1.6.8')
+    readDpsWithExtraDataAndMode(dps: Array<Object>, extraData: Object, mode: t.Integer, promise: t.PromiseCb) {
+    }
+
+    /**
+     write data points
+     @param dps – dps [ {id:0, type:BOOL, value:false} ,{id:1, type:INT, value:2}]
+     @param extraData – map
+      cacheTime  number  指令缓存时间，ws通道有效,单位是s
+      msgId   number  消息Id，ws通道有效
+     @param promise 回调 callback
+     */
+    @d.Method('1.6.8')
+    writeDpsWithExtraData(dps: Array<Object>, extraData: Object, promise: t.PromiseCb) {
+    }
+
+
+    /**
+     write data points
+     @param dps – dps [ {id:0, type:BOOL, value:false} ,{id:1, type:INT, value:2}]
+     @param extraData – map
+      cacheTime  number  指令缓存时间，ws通道有效,单位是s
+      msgId   number  消息Id，ws通道有效
+     @param mode – mode 下发模式： 0 auto，1: websocket 2:wifi 3:ble
+     @param promise 回调 callback
+     */
+    @d.Method('1.6.8')
+    writeDpsWithExtraDataAndMode(dps: Array<Object>, extraData: Object, mode: t.Integer, promise: t.PromiseCb) {
+    }
+
+    /**
+     获取设备通道状态
+     @param promise 回调 callback {"state": 0/1/2}
+      * （0: 未开启, 1: 未授权, 2 : 可用)
+     */
+    @d.Method('1.4.0')
+    getBleState(promise: t.PromiseCb) {
+    }
+
+    /**
+     获取物模型以及属性值
+     @param params  map
+      productKey  string  产品key
+      deviceKey   string   设备key
+      codeList   string  非必填  查询的属性标识符
+      gatewayDk string  网关设备的 Device Key
+      gatewayPk string  网关设备的 Product Key
+      和查询类型配合使用，如果查询多个属性，使用英文逗号分隔
+
+      type  string 非必填 查询类型
+      1 查询设备基础属性
+      2 查询物模型属性
+      3 查询定位信息
+      查询类型可以单选和多选，如果需要查询多个类型的属性值，使用英文逗号分隔
+
+      filterType 过滤类型
+      0: 仅获取属性定义(默认行为)
+      1: 获取属性和事件定义
+      2: 获取属性,事件和服务定义 (为后续预留)
+     @param promise promise 执行回调
+     */
+    @d.Method('2.16.0')
+    getTslAndAttrs(params: Object, promise: t.PromiseCb) {
+    }
+
+    /**
+     read data points
+     @param dps – dps [ {id:0, type:BOOL, value:false} ,{id:1, type:INT, value:2}]
+     @param promise 回调 callback
+     */
+    @d.Method('1.4.0')
+    readDps(dps: Array<Object>, promise: t.PromiseCb) {
+    }
+
+    /**
+     write data points
+     @param dps – dps [ {id:0, type:BOOL, value:false} ,{id:1, type:INT, value:2}]
+     @param promise 回调 callback
+     */
+    @d.Method('1.4.0')
+    writeDps(dps: Array<Object>, promise: t.PromiseCb) {
+    }
+
+    /**
+     * write transparent data
+     * @param data 透传数据, 二进制base64转换的字符串
+     * @param mode 发送模式
+     * @param extraData 额外参数(预留)
+     * @param promise 回调callback
+     */
+    @d.Method('1.7.0')
+    writeTransparent(data: String, mode: t.Integer, extraData: Object, promise: t.PromiseCb) {
+    }
+
+    /**
+     read data points
+     @param dps – dps [ {id:0, type:BOOL, value:false} ,{id:1, type:INT, value:2}]
+     @param mode – mode 下发模式： 0 auto，1: websocket 2:wifi 3:ble
+     @param promise 回调 callback
+     */
+    @d.Method('1.4.0')
+    readDpsWithMode(dps: Array<Object>, mode: t.Integer, promise: t.PromiseCb) {
+    }
+
+    /**
+     write data points
+     @param dps – dps [ {id:0, type:BOOL, value:false} ,{id:1, type:INT, value:2}]
+     @param mode – mode 下发模式： 0 auto，1: websocket 2:wifi 3:ble
+     @param promise 回调 callback
+     */
+    @d.Method('1.4.0')
+    writeDpsWithMode(dps: Array<Object>, mode: t.Integer, promise: t.PromiseCb) {
+    }
+
+    /**
+     获取设备通道状态
+     @param promise 回调 callback {"onlineState": 0/1/2/3/4/5/6/7}
+      *  onlineStateMaskWS   = 1 << 0,
+      *  onlineStateMaskWifi = 1 << 1,
+      *  onlineStateMaskBle  = 1 << 2,
+      * （0: all offline, 1: websocket online, 2 : wifi online, 3: wifi + websocket online, 4: ble online, 5: websocket + ble online, 6: ble + wifi online , 7: wifi + ble + ws online)
+     */
+    @d.Method('1.4.0')
+    getOnlineState(promise: t.PromiseCb) {
+    }
+
+
+    /**
+     建立通道，（设备会自动根据设备通道能力capabilitiesBitmask建立通道，此API用于手动切换指定通道）
+     @param mode – mode 建立通道模式： 0 auto，1: websocket 2:wifi 3:ble
+      * 注意：1，建立的通通与已连接通道不同时，已连接通道会断开。
+      * 2，当设备不具备相应通道，建立其不具备的通道会失败。不会再自动建立其他通道
+     */
+    @d.Method('1.4.0')
+    connectChannel(mode: t.Integer) {
+    }
+
+    /**
+     断开通道，（
+     @param type – type 通道类型，0: 关闭所有通道（关闭wifi和ble）, 2:wifi 3:ble
+     */
+    @d.Method('1.4.0')
+    disconnectChannel(type: t.Integer) {
+    }
+
+    /**
+     * 设备在离线状态通知
+     * @param object 事件数据 {"onlineState": 0/1/2/3/4/5/6/7}
+     *  onlineStateMaskWS   = 1 << 0,
+     *  onlineStateMaskWifi = 1 << 1,
+     *  onlineStateMaskBle  = 1 << 2,
+     * （0: all offline, 1: websocket online, 2 : wifi online, 3: wifi + websocket online, 4: ble online, 5: websocket + ble online, 6: ble + wifi online , 7: wifi + ble + ws online)
+     */
+    @d.Event('1.4.0')
+    onDeviceOnlineState(object: Object) {
+    }
+
+    /**
+     * 设备dps更新 (尽量)
+     * @param object 事件数据 {
+     * type: （1：ws 2: wifi 3: ble，）
+     * action: {
+     * 1.读取消息(面板不需要处理)
+     * 2.设备上报-读响应
+     * 3.发生消息(面板不需要处理)
+     * 4.设备上报-写响应
+     * 5.调用 EXE-SERV2服务 (面板暂时不需要处理)
+     * 6.设备上报-服务调用
+     * 7.设备告警-info
+     * 8.设备告警-warn
+     * 9.设备告警-error
+     * 10.位置信息LOCATION
+     * 11.发生RAW (面板暂时不需要处理)
+     * 12.接受RAW (面板暂时不需要处理)
+     * 13.设备上报-自动上报
+     * 14.设备在线状态 (面板不需要处理)
+     * 15.设备上报-信号量
+     * 16.设备上报-设备
+     * 17.设备上报-设备被移除(value: 1 解绑, 2.重置, 3.分享过期, 4.取消分享, 5.覆盖分享, 6. 用户注销, 7. 从设备组中移除)
+     * 18.设备状态信息回复
+     * 19.透传数据方向 app → iot
+     * 20.透传数据 方向 iot→ app
+     * }
+     * pk: "xxxx",
+     * dk: "xxxx",
+     * "dps": [{id: 0, type:BOOL, value, true/false},{id: 1, type:INT, value, 1}, ...]
+     * "transparent": "xxx"(二进制数据base64后转字符串),
+     * }
+     */
+    @d.Event('1.4.0')
+    onDeviceDpsUpdate(object: Object) {
+    }
+
+    /**
+     * 设备信息更新
+     * @param object 事件数据
+     */
+    @d.Event('1.4.0')
+    onDeviceInfoUpdate(object: Object) {
+    }
+
+
+
+
+    /**
+     获取websocket是否登录成功
+     @param isLoginCallback Func 接受是否登录websocket回调  已登录成功 true  登录失败  false
+     */
+    @d.Method('1.0.0', t.Platforms.All, true)
+    isWebSocketLoginCallback(isLoginCallback: t.SuccessCb) {
+    }
+
+    /**
+     订阅设备
+     @param list 订阅设备列表，订阅结果QuecDeviceServiceWebSocketDelegate返回
+      [
+      {
+      "deviceKey": "1234567890",
+      "messageType": [
+      "ONLINE"
+      ],
+      "productKey": "p12345"
+      },
+      {
+      "deviceKey": "1234567890",
+      "messageType": [
+      "ONLINE",
+      "STATUS"
+      ],
+      "productKey": "p12345"
+      }
+      ]
+     */
+    @d.Method('1.0.0', t.Platforms.All, true)
+    subscribeDevicesWithList(list: Array<Object>) {
+    }
+
+    /**
+     取消订阅设备
+     @param list 取消订阅设备列表，取消订阅结果QuecDeviceServiceWebSocketDelegate返回
+      [
+      {
+      "deviceKey": "1234567890",
+      "productKey": "p12345"
+      },
+      {
+      "deviceKey": "1234567890",
+      "productKey": "p12345"
+      }
+      ]
+     */
+    @d.Method('1.0.0', t.Platforms.All, true)
+    unSubscribeDevicesWithList(list: Array<Object>) {
+    }
+
+    /**
+     获取设备业务属性值
+
+     @param params 发送数据，需要在delegate的websocketDidOpen回调之后才能调用
+      透传
+      {
+      "cmd": "send",
+      "data": {
+      "cacheTime": 3600,
+      "dataFormat": "Text",
+      "deviceKey": "866123456789015",
+      "isCache": true,
+      "productKey": "p12345",
+      "raw": "123456",
+      "type": "RAW"
+      }
+      }
+      物模型
+      {
+      "cmd": "send",
+      "data": {
+      "deviceKey": "1234567890",
+      "kv": "[{\"id\":5,\"name\":\"openapi\",\"type\":\"BOOL\",\"value\":\"true\"}]",
+      "productKey": "p12345",
+      "type": "WRITE-ATTR"
+      }
+      }
+     */
+    @d.Method('1.0.0', t.Platforms.All, true)
+    sendDataToDeviceByWebSocketWithDataDict(params: Object) {
+    }
+
+    /**
+     获取设备列表
+     @param pageNumber number 页码
+     @param pageSize number 页大小
+     @param promise promise 执行回调
+      callback  {"data": {"list" : [], "total" : 12}}
+     */
+    @d.Method('1.0.0', t.Platforms.All, true)
+    getDeviceListWithPageNumber(pageNumber: t.Integer, pageSize: t.Integer, promise: t.PromiseCb) {
+    }
+
+    /**
+     获取设备业务物模型属性值
+     @param params  map
+      productKey  string  产品key
+      deviceKey   string   设备key
+      codeList   string  非必填  查询的属性标识符
+      gatewayDk string  网关设备的 Device Key
+      gatewayPk string  网关设备的 Product Key
+      和查询类型配合使用，如果查询多个属性，使用英文逗号分隔
+      type  string 非必填 查询类型
+      1 查询设备基础属性
+      2 查询物模型属性
+      3 查询定位信息
+      查询类型可以单选和多选，如果需要查询多个类型的属性值，使用英文逗号分隔
+     @param promise promise 执行回调
+     */
+    @d.Method('1.0.0', t.Platforms.All, true)
+    getProductTSLWithProductKey(params: Object, promise: t.PromiseCb) {
+    }
+
+    /**
+     获取设备业务属性值
+     @param params  map
+      productKey  string  产品key
+      deviceKey   string   设备key
+      codeList   string  非必填  查询的属性标识符
+      和查询类型配合使用，如果查询多个属性，使用英文逗号分隔
+      type  string 非必填 查询类型
+      1 查询设备基础属性
+      2 查询物模型属性
+      3 查询定位信息
+      查询类型可以单选和多选，如果需要查询多个类型的属性值，使用英文逗号分隔
+     @param promise promise 执行回调
+     */
+    @d.Method('1.0.0', t.Platforms.All, true)
+    getDeviceBusinessAttributesWithProductKey(params: Object, promise: t.PromiseCb) {
+    }
+
+    /**
+     更改分享设备名称
+     @param deviceName   string   设备名称
+     @param shareCode  string   分享码
+     @param promise promise 执行回调
+     */
+    @d.Method('1.0.0', t.Platforms.All, true)
+    updateDeviceNameByShareUserWithDeviceName(deviceName: string, shareCode: string, promise: t.PromiseCb) {
+    }
+
+    /**
+     更改分享设备名称
+     @param deviceName   string   deviceName
+     @param productKey  string   product key
+     @param deviceKey string   deviceKey
+     @param promise promise 执行回调
+     */
+    @d.Method('1.0.0', t.Platforms.All, true)
+    updateDeviceName(deviceName: string, productKey: string, deviceKey: string, promise: t.PromiseCb) {
+    }
+
+    /**
+     查询网关设备下子设备列表
+     @param  params
+     deviceKey string  必传  网关设备deviceKey
+     productKey string  必传 网关设备productKey
+     pageNumber number 必传 页码
+     pageSize number 必传 页大小
+     @param promise promise 执行回调
+      callback  {"data": {"list" : [], "total" : 12}}
+     */
+    @d.Method('1.0.0', t.Platforms.All, true)
+    getGatewayDeviceChildListWithParams(params: Object, promise: t.PromiseCb) {
+    }
+
+    /**
+     设备解绑
+     @param deviceKey  string  device key
+     @param productKey  string  product key
+     @param promise promise 执行回调
+     */
+    @d.Method('1.0.0', t.Platforms.All, true)
+    unbindDeviceWithDeviceKey(deviceKey: string, productKey: string, promise: t.PromiseCb) {
+    }
+
+    /**
+     设备解绑
+     @param shareCode  string  分享码
+     @param promise promise 执行回调
+     */
+    @d.Method('1.0.0', t.Platforms.All, true)
+    unShareDeviceByShareUserWithShareCode(shareCode: string, promise: t.PromiseCb) {
+    }
+
+    /**
+     获取设备属性图表列表
+     @param params
+     productKey 产品key
+     deviceKey 设备key
+     startTimestamp 开始时间（毫秒时间戳）
+     endTimestamp 结束时间（毫秒时间戳）
+     attributeCode 物模型属性标识符，查询多个属性时使用英文逗号分隔
+     gatewayDk 网关设备的 Device Key
+     gatewayPk 网关设备的 Product Key
+     countType 聚合类型（默认3）：1-最大值 2-最小值 3-平均值 4-差值 5-总值
+     timeGranularity 统计时间粒度（默认2）：1-月 2-日 3-小时 4-分钟 5-秒
+     callback  {"data": []}
+     @param promise promise 执行回调
+     */
+    @d.Method('1.1.0')
+    getPropertyChartListWithParams(params: Object, promise: t.PromiseCb) {
+    }
+
+    /**
+     获取设备分享人列表
+     @param deviceKey  string  设备名称
+     @param productKey  string   产品key
+     @param promise promise 执行回调
+     */
+    @d.Method('1.1.0')
+    getDeviceShareUserListWithDeviceKey(deviceKey: string, productKey: string, promise: t.PromiseCb) {
+    }
+
+    /**
+     分享人设置分享信息
+     @param params
+     deviceKey  string   设备key
+     productKey   string   产品key
+     acceptingExpireTime  number   分享二维码种子失效时间 时间戳（毫秒），表示该分享在此时间戳时间内没有使用，会失效
+     coverMark   number   覆盖标志:1 直接覆盖上条有效分享（默认）（覆盖原有的分享码）；2 直接添加，允许多条并存；3 只有分享时间延长了，才允许覆盖上条分享
+     isSharingAlwaysValid   bool   设备是否永久有效
+     sharingExpireTime   number   设备使用到期时间 时间戳（毫秒），表示该分享的设备，被分享人可以使用的时间，isSharingAlwaysValid为YES时该参数无效
+     @param promise promise 执行回调
+     */
+    @d.Method('1.1.0')
+    setShareInfoByOwnerWithDeviceKey(params: Object, promise: t.PromiseCb) {
+    }
+
+    /**
+     分享人取消分享
+     @param shareCode   string   分享码
+     @param promise promise 执行回调
+     */
+    @d.Method('1.1.0')
+    unShareDeviceByOwnerWithShareCode(shareCode: string, promise: t.PromiseCb) {
+    }
+
+    /**
+     获取设备历史轨迹
+     @param params
+     productKey 产品key
+     deviceKey 设备key
+     startTimestamp 开始时间（毫秒时间戳）
+     endTimestamp 结束时间（毫秒时间戳）
+     gatewayDk 网关设备的 Device Key
+     gatewayPk 网关设备的 Product Key
+     locateTypes 定位类型（默认查询所有类型的定位），查询多种定位时使用英文逗号分隔
+     GNSS-全球导航卫星系统
+     GPS-美国导航定位系统
+     GL-俄罗斯格洛纳导航定位系统
+     GA-欧盟伽利略卫星导航系统
+     BD/PQ-中国导航定位系统
+     LBS-基于通信运营商的基站定位系统
+     @param promise
+     */
+    @d.Method('1.1.0')
+    getLocationHistoryWithParams(params: Object, promise: t.PromiseCb) {
+    }
+
+    /**
+     * 获取设备信息
+     * @param deviceKey string 设备key
+     * @param productKey string 产品key
+     * @param promise promise 执行回调
+     */
+    @d.Method('1.2.0')
+    getDeviceInfoByDeviceKey(deviceKey: string, productKey: string, promise: t.PromiseCb) {
+    }
+
+    /**
+     * 获取设备属性信息
+     * @param params map
+     productKey 产品key
+     deviceKey 设备key
+     startTimestamp 开始时间（毫秒时间戳）
+     endTimestamp 结束时间（毫秒时间戳）
+     attributeCode 物模型属性标识符，查询多个属性时使用英文逗号分隔
+     gatewayDk 网关设备的 Device Key
+     gatewayPk 网关设备的 Product Key
+     pageNumber 当前页，默认为第 1 页
+     pageSize 页大小，默认为 10 条
+     * @param promise promise 执行回调
+     */
+    @d.Method('1.2.0')
+    getPropertyDataListWithParams(params: Object, promise: t.PromiseCb) {
+    }
+
+    /**
+     * 获取设备属性环比统计数据
+     * @param params map
+     productKey 产品key
+     deviceKey 设备key
+     currentTimestamp 当前时间（毫秒时间戳
+     attributeCode 物模型属性标识符，查询多个属性时使用英文逗号分隔
+     gatewayDk 网关设备的 Device Key
+     gatewayPk 网关设备的 Product Key
+     countType 聚合类型（默认3）：1-最大值 2-最小值 3-平均值 4-差值 5-总值
+     timeGranularities 统计时间粒度，查询多个粒度时使用英文逗号分隔（默认1）：1-日 2-周 3-月 4-年
+     callback  {"data": []}
+     * @param promise promise 执行回调
+     */
+    @d.Method('1.2.0')
+    getPropertyStatisticsWithParams(params: Object, promise: t.PromiseCb) {
+    }
+
+    /**
+     * WebSocket 已打开事件
+     * @param object 事件数据 data = {"code":"this is code", @"message":" this is reason"}
+     * reminder.data = {}
+     */
+    @d.Event('1.0.0')
+    onWebSocketDidOpen(object: Object) {
+    }
+
+    /**
+     * WebSocket 错误事件
+     * @param object 事件数据 data = {"code":"this is code", @"message":" this is reason"}
+     */
+    @d.Event('1.0.0')
+    onWebSocketDidError(object: Object) {
+    }
+
+
+    /**
+     * WebSocket 消息事件
+     * @param object 事件数据
+     * object.data = {
+     *     "cmd": "message",
+     *     "data": {
+     *         "createdAt": 1609316592000,
+     *         "data": {
+     *             "value": 1
+     *         },
+     *         "deviceKey": "866123456789015",
+     *         "productKey": "123456",
+     *         "ticket": "5f9924d171977c33bc5ad1b1",
+     *         "type": "ONLINE"
+     *     }
+     * }
+     * error
+     * {
+     *     cmd = error;
+     *     data =     {
+     *         code = 4010;
+     *         msg = "user not logged in";
+     *         reqMsg = "";
+     *     };
+     */
+    @d.Event('1.0.0')
+    onWebSocketDidReceiveMessage(object: Object) {
+    }
+
+    /**
+     * 通过分享码查询设备信息
+     * @param shareCode 分享码
+     * @param promise 回调
+     */
+    @d.Method('1.3.0')
+    getDeviceInfoByShareCode(shareCode: string, promise: t.PromiseCb) {
+    }
+
+    /**
+     获取设备列表-根据设备名称搜索
+     @param deviceName 设备名称
+     @param pageNumber number 页码
+     @param pageSize number 页大小
+     @param promise 回调  callback  {"data": {"list" : [], "total" : 12}}
+     */
+    @d.Method('1.3.0')
+    getDeviceListByDeviceName(deviceName: string, pageNumber: t.Integer, pageSize: t.Integer, promise: t.PromiseCb) {
+    }
+
+    /**
+     通过SN绑定设备
+     @param serialNumber  string 设备SN码
+     @param productKey  string 产品key
+     @param deviceName  string 设备名称
+     @param promise 回调 callback
+     */
+    @d.Method('1.3.0')
+    bindDeviceBySerialNumber(serialNumber: string, productKey: string, deviceName: string, promise: t.PromiseCb) {
+    }
+
+    /**
+     通过authCode绑定设备
+     可用于wifi/wifi+蓝牙设备绑定
+     @param params Map  包含以下属性
+      authCode  string 设备authCode
+      productKey  string 产品key
+      deviceKey  string 设备key
+      deviceName  string 设备名称
+     @param promise 回调 callback
+     */
+    @d.Method('1.3.0')
+    bindDeviceByAuthCode(params: object, promise: t.PromiseCb) {
+    }
+
+    /**
+     通过authCode + password绑定设备
+     可用于蓝牙设备绑定
+     @param params Map  包含以下属性
+      authCode   string 设备authCode
+      productKey   string 产品key
+      deviceKey   string 设备key
+      password   string 设备password
+      deviceName   string 设备名称
+     @param promise 回调 callback
+     */
+    @d.Method('1.3.0')
+    bindDeviceByPSWAuthCode(params: object, promise: t.PromiseCb) {
+    }
+
+    /**
+     查询设备升级信息
+     @param productKey  string  产品key
+     @param deviceKey  string  设备key
+     @param params  map  其他信息  非必传
+      batteryLevelLimit  number  设备剩余电量百分比
+      mcuVersions    array      固件信息  componentNo  string  升级组件标识   version  string  升级组件版本
+      minSignalIntensity  number  设备最小信号量 dbM
+      moduleVersion    string    模组版本
+      upgradeTime   number     升级时间时间戳，默认为当前时间戳
+      useSpace     number      所需磁盘空间，KB
+      {'batteryLevelLimit':1, 'mcuVersions':[{'componentNo': '', 'version': ''}], 'minSignalIntensity':1, 'moduleVersion':'', 'upgradeTime':1, 'useSpace':1}
+     @param promise 回调 callback
+     */
+    @d.Method('1.3.0')
+    getFetchPlanWithProductKey(productKey: string, deviceKey: string, params: object, promise: t.PromiseCb) {
+    }
+
+    /**
+     上报设备升级信息
+     @param params   map
+      productKey   string   产品key
+      deviceKey   string  设备key
+      componentNo  string  升级固件标识
+      reportStatus  number  升级状态 0 - 1 2
+     @param promise 回调 callback
+     */
+    @d.Method('1.3.0')
+    reportDeviceUpgradeStatusWithProductKey(params: object, promise: t.PromiseCb) {
+    }
+
+    /**
+     设备批量控制
+     @param params Map
+      data 遵循tsl格式的json string [{"id":62,"value":99,"type":"INT","name":"温度(temp)"},{"id":63,"value":"true","type":"BOOL","name":"开关机状态(powerstate)"}]
+      deviceList 设备列表 [{"deviceKey":"", "productKey":""}]
+      type   number   类型 1：透传 2：属性 3：服务
+      dataFormat   number  数据类型 1：Hex 2：Text（当type为透传时，需要指定 dataFormat）
+      cacheTime  number  非必传   缓存时间，单位为秒，缓存时间范围 1-7776000 秒，启用缓存时必须设置缓存时间
+      isCache number 非必传  是否启用缓存 1：启用 2：不启用，默认不启用
+      isCover number 非必传  是否覆盖之前发送的相同的命令 1：覆盖 2：不覆盖，默认不覆盖，启用缓存时此参数有效
+     @param promise 回调 callback
+     */
+    @d.Method('1.3.0')
+    sendDataToDevicesByHttpWithData(params: object, promise: t.PromiseCb) {
+    }
+
+    /**
+     创建定时任务
+     @param params productKey – string 必传  产品key
+      deviceKey – string 必传 设备key
+      type – string 必传  定时任务类型，once: 执行一次，day-repeat: 每天重复，custom-repeat: 自定义重复，multi-section: 多段执行，random: 随机执行，delay: 延迟执行（倒计时）
+      timers:[{
+      action – string 必传 定时任务执行的命令，格式：物模型的 json 字符串,
+      time – string 非必传  执行时间，格式为 HH:mm:ss, 当 type = once || day-repeat || custom-repeat ||
+      multi-section 时必填,
+      startTime – string 非必传  当 type 为 random 时必填，格式为 "HH:mm:ss"，如 "12:00:00"
+      endTime – string 非必传  当 type 为 random 时必填，格式为 "HH:mm:ss"，如 "12:00:00"
+      delay – number 非必传 延迟执行时间，单位为秒, 当 type = delay 时必填，单位为 s
+      }]
+      enabled – 定时任务状态：false-停止（默认） true-启动
+      dayOfWeek – string 非必传  周几执行：1-周一 2-周二 3-周三 4-周四 5-周五 6-周六 7-周日, 可以多选，传多个值时使用英文逗号分隔, 当 type = custom-repeat || multi-section || random 时必填
+     @param promise 回调 callback  {"data": {}}
+     */
+    @d.Method('1.3.0')
+    addCornJob(params: object, promise: t.PromiseCb) {
+    }
+
+    /**
+     修改定时任务
+     @param params
+     productKey – string 必传  产品key
+     deviceKey – string 必传 设备key
+     ruleId – string 必传 规则唯一标识，修改规则实例信息时必填
+     type – string 必传  定时任务类型，once: 执行一次，day-repeat: 每天重复，custom-repeat: 自定义重复，multi-section: 多段执行，random: 随机执行，delay: 延迟执行（倒计时）
+     timers:[{
+     action – string 必传 定时任务执行的命令，格式：物模型的 json 字符串,
+     time – string 非必传  执行时间，格式为 HH:mm:ss, 当 type = once || day-repeat || custom-repeat ||
+     multi-section 时必填,
+     startTime – string 非必传  当 type 为 random 时必填，格式为 "HH:mm:ss"，如 "12:00:00"
+     endTime – string 非必传  当 type 为 random 时必填，格式为 "HH:mm:ss"，如 "12:00:00"
+     delay – number 非必传 延迟执行时间，单位为秒, 当 type = delay 时必填，单位为 s
+     }]
+     enabled – 定时任务状态：false-停止（默认） true-启动
+     dayOfWeek – string 非必传  周几执行：1-周一 2-周二 3-周三 4-周四 5-周五 6-周六 7-周日, 可以多选，传多个值时使用英文逗号分隔, 当 type = custom-repeat || multi-section || random 时必填
+     @param promise 回调 callback  {"data": {}}
+     */
+    @d.Method('1.3.0')
+    setCronJob(params: object, promise: t.PromiseCb) {
+    }
+
+    /**
+     查询设备下定时任务列表
+     @param params
+     productKey – string 必传  产品key
+     deviceKey – string 必传 设备key
+     type – string 必传  定时任务类型，once: 执行一次，day-repeat: 每天重复，custom-repeat: 自定义重复，multi-section: 多段执行，random: 随机执行，delay: 延迟执行（倒计时）
+     page – number 分页页码，默认: 1
+     pageSize – number 分页大小，默认: 10
+     @param promise 回调 callback  {"data": {"list" : [], "total" : 12}}
+     */
+    @d.Method('1.3.0')
+    getCronJobList(params: object, promise: t.PromiseCb) {
+    }
+
+    /**
+     查询定时任务详情
+     @param ruleId – string 必传 定时任务ID
+     @param promise 回调 callback  {"data": {}}
+     */
+    @d.Method('1.3.0')
+    getCronJobInfo(ruleId: string, promise: t.PromiseCb) {
+    }
+
+    /**
+     批量删除定时任务
+     @param params – {ruleIdList:[] String[] 必传 定时任务ID}
+     @param promise 回调 callback  {"data": {}}
+     */
+    @d.Method('1.3.0')
+    batchDeleteCronJob(params: object, promise: t.PromiseCb) {
+    }
+
+    /**
+     查询产品下定时任务限制数
+     @param  productKey – string 必传  产品key
+     @param promise 回调callback  {"data": {}}
+     */
+    @d.Method('1.3.0')
+    getProductCornJobLimit(productKey: string, promise: t.PromiseCb) {
+    }
+
+    /**
+     打开websocket
+     */
+    @d.Method('1.3.0')
+    openWebSocket() {
+    }
+
+    /**
+     关闭websocket
+     */
+    @d.Method('1.3.0')
+    closeWebSocket() {
+    }
+
+    /**
+     *
+     * 查询产品的tls模型
+     * @param param -{productKey:String } --必传
+     * @param promise  -{callback:{data:{}}
+     */
+    @d.Method('1.5.0')
+    getProductTSLWithCacheByProductKey(param: object, promise: t.PromiseCb) {
+    }
+
+
+    /**
+     * 门锁事件日志
+     * @param params {codeList:["",""],productKey:"",deviceKey:"",startTime:long,endTime:long,pageNumber:1,pageSize:10}
+     * @param promise
+     */
+    @d.Method('1.9.0')
+    listDeviceEvent(params: Object, promise: t.PromiseCb) {
+    }
+
+    /**
+     设备解绑
+     @param pk  string  产品id
+     @param dk  string  设备id
+     @param shareCode  string  分享码
+     @param promise promise 执行回调
+     */
+    @d.Method('1.9.6', t.Platforms.All, true)
+    unShareDeviceByShareUserWithShareCodeIpc(pk: string, dk: string, shareCode: string, promise: t.PromiseCb) {
+    }
+
+    /**
+     订阅设备(非当前面板设备)
+     @param pk  string  产品id
+     @param dk  string  设备id
+     @param promise promise 执行回调
+     */
+    @d.Method('2.0.0', t.Platforms.All)
+    subscribeDevice(pk: string, dk: string) {
+    }
+
+
+    /**
+     取消订阅 (非当前面板设备)
+     @param pk  string  产品id
+     @param dk  string  设备id
+     @param promise promise 执行回调
+     */
+    @d.Method('2.0.0', t.Platforms.All)
+    unSubscribeDevice(pk: string, dk: string) {
+    }
+
+    /**
+     设置主从设备关联关系
+     @param list - array<DeviceModel> 关联设备列表
+      [
+      {
+      "deviceKey": "1234567890",
+      "productKey": "p12345",
+      ...设备其他信息
+      },
+      {
+      "deviceKey": "1234567890",
+      "productKey": "p12345"
+      ...设备其他信息
+      }
+      ]
+
+     @param master - DeviceModel Object 主设备信息
+     @param fid - string 家庭 id, 没有传空
+     @param promise promise 执行回调
+     */
+    @d.Method('2.0.0', t.Platforms.All)
+    deviceAssociationWithList(list: Array<Object>, master: Object, fid: string, promise: t.PromiseCb) {
+    }
+
+    /**
+     设备关联关系查询
+     @param master - DeviceModel Object 主设备信息
+     @param fid - string 家庭 id, 没有传空
+     @param codelist - string 物模型code, 用逗号分隔
+     @param promise promise 执行回调
+     */
+    @d.Method('2.0.0', t.Platforms.All)
+    deviceAssociation(master: Object, fid: string, codelist: string, promise: t.PromiseCb) {
+    }
+
+    /**
+     设备关联关系解除
+     @param device - DeviceModel Object 从设备信息
+     @param fid - string 家庭 id, 没有传空
+     @param promise promise 执行回调
+     */
+    @d.Method('2.0.0', t.Platforms.All)
+    deviceDisassociation(device: Object, fid: string, promise: t.PromiseCb) {
+    }
+
+    /**
+     设备关联关系配置查询
+     @param pk string 主设备pk
+     @param promise promise 执行回调
+     */
+    @d.Method('2.0.0', t.Platforms.All)
+    deviceAssociationConfig(pk: string, promise: t.PromiseCb) {
+    }
+
+    /**
+     通过设备dk，pk获取指定设备设备通道状态
+     @param pk - string 设备 productkey
+     @param dk - string 设备 devicekey
+     @param promise 回调 callback {"onlineState": 0/1/2/3/4/5/6/7}
+      *  onlineStateMaskWS   = 1 << 0,
+      *  onlineStateMaskWifi = 1 << 1,
+      *  onlineStateMaskBle  = 1 << 2,
+      * （0: all offline, 1: websocket online, 2 : wifi online, 3: wifi + websocket online, 4: ble online, 5: websocket + ble online, 6: ble + wifi online , 7: wifi + ble + ws online)
+     */
+    @d.Method('2.0.0')
+    getDeviceOnlineState(pk: string, dk: string, promise: t.PromiseCb) {
+    }
+
+
+    /**
+     设备关联选中的设备
+     @param list 设备列表数组，Object是devcie model
+     */
+    @d.Event('2.0.0')
+    deviceAssociationSelected(list: Array<Object>) {
+    }
+
+    /**
+     设置离线提醒开关
+     @param enableOfflineReminder number 开关 0关闭1开启
+     @param productKey - string productKey
+     @param deviceKey - string deviceKey
+     @param promise promise回调
+     */
+    @d.Method('2.4.0', t.Platforms.All)
+    setOfflineReminder(enableOfflineReminder: t.Integer, productKey: string, deviceKey: string, promise: t.PromiseCb) {
+    }
+
+    /**
+     离线提醒开关查询
+     @param productKey - string productKey
+     @param deviceKey - string deviceKey
+     @param promise promise 回调
+     */
+    @d.Method('2.4.0', t.Platforms.All)
+    getOfflineReminderInfo(productKey: string, deviceKey: string, promise: t.PromiseCb) {
+    }
+
+    /**
+     获取设备是否有OTA计划
+     @param device - DeviceModel Object 设备信息
+     @param promise promise 回调
+     */
+    @d.Method('2.4.0', t.Platforms.All)
+    checkDeviceUpdatePlan(device: Object, promise: t.PromiseCb) {
+    }
+
+    /**
+     打开设备OTA详情
+     @param productKey - string productKey
+     @param deviceKey - string deviceKey
+     @param promise promise 回调
+     */
+    @d.Method('2.4.0', t.Platforms.All)
+    openDeviceOTAPage(productKey: string, deviceKey: string, promise: t.PromiseCb) {
+    }
+
+    /**
+     获取当前手机设置时区
+     @param promise promise 执行回调
+     */
+    @d.Method('2.5.7', t.Platforms.All)
+    getTimeDifferenceWithGMT(promise: t.PromiseCb) {
+    }
+
+    /**
+     获取当前设备设置时区
+     @param productKey - string productKey
+     @param deviceKey - string deviceKey
+     @param promise promise 执行回调
+     */
+    @d.Method('2.5.7', t.Platforms.All)
+    getDeviceTimeZone(productKey: string, deviceKey: string, promise: t.PromiseCb) {
+    }
+
+    /**
+     设置设备时区
+     @param productKey - string productKey
+     @param deviceKey - string deviceKey
+     @param timezone - string 时区
+     @param promise promise 执行回调
+     */
+    @d.Method('2.5.7', t.Platforms.All)
+    setDeviceTimeZone(productKey: string, deviceKey: string, timezone: string, promise: t.PromiseCb) {
+    }
+
+    /**
+     获取设备当前连接WiFi信息
+     @param productKey - string productKey
+     @param deviceKey - string deviceKey
+     @param promise promise 执行回调
+     */
+    @d.Method('2.10.0', t.Platforms.All)
+    getDeviceStateInfo(productKey: string, deviceKey: string, promise: t.PromiseCb) {
+    }
+
+    /**
+     跳转WiFi列表页
+     @param productKey - string productKey
+     @param deviceKey - string deviceKey
+     @param oldSsid - string 已连接ssid
+     @param signal_strength - string 信号强度
+     @param supportOnlineWiFiScan - boolean 设备是否支持在线WiFi扫描
+     @param promise promise 执行回调
+     */
+    @d.Method('2.10.0', t.Platforms.All)
+    jumpDeviceWiFiListPage(productKey: string, deviceKey: string, oldSsid: string, signal_strength: string, supportOnlineWiFiScan: boolean, promise: t.PromiseCb) {
+    }
+
+
+    /**
+     获取产品说明书地址
+     @param productKey - string productKey
+     @param deviceKey - string deviceKey
+     @param promise promise 执行回调 { "data":{"url": "https://xxx.pdf"}}
+     */
+    @d.Method('2.10.0', t.Platforms.All)
+    getProductDescription(productKey: string, promise: t.PromiseCb) {
+    }
+
+    /**
+     * 设备信息更新
+     * @param object 设备状态数据
+     */
+    @d.Event('2.10.0')
+    onDeviceStatusUpdate(object: Object) {
+    }
+
+    /**
+     获取设备列表
+     @param pageNumber number 页码
+     @param pageSize number 页大小
+     @param promise promise 执行回调
+      callback  {"data": {"list" : [], "total" : 12}}
+     */
+    @d.Method('2.11.5', t.Platforms.All)
+    getFamilyDeviceList(pageNumber: t.Integer, pageSize: t.Integer, promise: t.PromiseCb) {
+    }
+
+    /**
+     * 设备校时 only pure bt
+     * @param productKey - string productKey
+     * @param deviceKey - string deviceKey
+     * @param promise 回调
+     */
+    @d.Method('2.11.0', t.Platforms.All)
+    timeZoneSync(productKey: string, deviceKey: string, promise: t.PromiseCb) {
+    }
+
+    /**
+     * 纯蓝牙设备解绑
+     * @param productKey - string productKey
+     * @param deviceKey - string deviceKey
+     * @param isInit - boolean 是否重置设备
+     * @param random - string 非必传 random
+     * @param pureBtResetCredentials - string 非必传 重置凭证
+     * @param promise 回调
+     */
+    @d.Method('2.11.0', t.Platforms.All)
+    unbindlingPureBtDevice(productKey: string, deviceKey: string, isInit: boolean, random: string, pureBtResetCredentials: string, promise: t.PromiseCb) {
+    }
+
+    /**
+     获取产品物模型(无网络获取缓存)
+     @param productKey - string productKey
+     @param promise promise 执行回调
+     */
+    @d.Method('2.11.0', t.Platforms.All)
+    getTsl(productKey: string, promise: t.PromiseCb) {
+    }
+
+    /**
+     * 激活设备(设备配网)
+     * @param productKey productKey
+     * @param deviceKey deviceKey
+     * @param promise 执行结果
+     */
+    @d.Method('2.12.0', t.Platforms.All)
+    startVerifyDevice(productKey: string, deviceKey: string, promise: t.PromiseCb) {
+    }
+
+    /**
+     * 已绑定设备配网
+     * @param productKey productKey
+     * @param deviceKey deviceKey
+     * @param promise 执行结果
+     */
+    @d.Method('2.14.5', t.Platforms.All)
+    startNetConfigDevice(productKey: string, deviceKey: string, promise: t.PromiseCb) {
+    }
+
+    /**
+     * 被分享人查询分享权限
+     * @param shareCodeList 分享码列表
+     * @param promise 执行结果
+     */
+    @d.Method('2.19.0', t.Platforms.All)
+    getSharePermList(shareCodeList: Array<string>, promise: t.PromiseCb) {
+    }
+
+    /**
+     * 立刻上传设备历史数据
+     * @param productKey productKey
+     * @param deviceKey deviceKey
+     * @param promise 执行结果
+     */
+    @d.Method('3.1.0', t.Platforms.All)
+    uploadDeviceHistoricalData(productKey: string, deviceKey: string, promise: t.PromiseCb) {
+    }
+
+    /**
+     * 获取产品语音技能支持
+     * @param productKey productKey
+     * @param uid 终端用户id
+     * @param account 当前用户的账号(优先邮箱 没有就手机号, 都没有就不传)
+     * @param promise 执行结果 callback {"supportAlexa": true/false, "supportAssistant": true/false,}
+     * supportAlexa 是否支持Alexa 语音
+     * supportAssistant 是否支持google assistant
+     */
+    @d.Method('3.2.0', t.Platforms.All)
+    getVoiceSupport(productKey: string, uid: string, account: string, promise: t.PromiseCb) {
+    }
+}