【小程序】应用程序编程接口汇总——授权API、OTA API、家庭API

IoT砖家涂拉拉2024-02-23 12:34

授权API

ty.authorize

权限请求方法

需引入BaseKit，且在>=1.2.10版本才可使用

参数

Object object

属性 类型 默认值 必填 说明
scope string 是 scope 权限名称 举例子： scope.bluetooth 蓝牙权限 scope.writePhotosAlbum 写入相册权限 scope.userLocationBackground 后台定位权限 scope.record 麦克风权限 scope.camera 摄像头权限 scope.userLocation 低精度定位权限 scope.userPreciseLocation 高精度定位权限
complete function 否 接口调用结束的回调函数（调用成功、失败都会执行）
success function 否 接口调用成功的回调函数
fail function 否 接口调用失败的回调函数

函数定义示例

复制代码 
/**
 * 权限请求方法
 */
export function authorize(params: {
  /**
   * scope 权限名称
   * 举例子：
   * scope.bluetooth 蓝牙权限
   * scope.writePhotosAlbum 写入相册权限
   * scope.userLocationBackground 后台定位权限
   * scope.record 麦克风权限
   * scope.camera 摄像头权限
   * scope.userLocation 低精度定位权限
   * scope.userPreciseLocation 高精度定位权限
   */
  scope: string;
  complete?: () => void;
  success?: (params: null) => void;
  fail?: (params: {
    errorMsg: string;
    errorCode: string | number;
    innerError: {
      errorCode: string | number;
      errorMsg: string;
    };
  }) => void;
}): void;

ty.authorizeStatus

查询权限状态

需引入BaseKit，且在>=1.2.10版本才可使用

参数

Object object

属性 类型 默认值 必填 说明
scope string 是 scope 权限名称 举例子： scope.bluetooth 蓝牙权限 scope.writePhotosAlbum 写入相册权限 scope.userLocationBackground 后台定位权限 scope.record 麦克风权限 scope.camera 摄像头权限 scope.userLocation 低精度定位权限 scope.userPreciseLocation 高精度定位权限
complete function 否 接口调用结束的回调函数（调用成功、失败都会执行）
success function 否 接口调用成功的回调函数
fail function 否 接口调用失败的回调函数

函数定义示例

复制代码 
/**
 * 查询权限状态
 */
export function authorizeStatus(params: {
  /**
   * scope 权限名称
   * 举例子：
   * scope.bluetooth 蓝牙权限
   * scope.writePhotosAlbum 写入相册权限
   * scope.userLocationBackground 后台定位权限
   * scope.record 麦克风权限
   * scope.camera 摄像头权限
   * scope.userLocation 低精度定位权限
   * scope.userPreciseLocation 高精度定位权限
   */
  scope: string;
  complete?: () => void;
  success?: (params: null) => void;
  fail?: (params: {
    errorMsg: string;
    errorCode: string | number;
    innerError: {
      errorCode: string | number;
      errorMsg: string;
    };
  }) => void;
}): void;

👉 立即开发。

OTA API

ty.device.checkOTAUpdateInfo

检查固件升级信息

需引入DeviceKit，且在>=1.2.6版本才可使用

参数

Object object

属性 类型 默认值 必填 说明
deviceId string 是 deviceId 设备 id
complete function 否 接口调用结束的回调函数（调用成功、失败都会执行）
success function 否 接口调用成功的回调函数
fail function 否 接口调用失败的回调函数

ty.device.checkOTAUpgradeStatus

获取设备的固件版本状态

需引入DeviceKit，且在>=2.2.0版本才可使用

参数

Object object

属性 类型 默认值 必填 说明
deviceId string 是 deviceId 设备 id
complete function 否 接口调用结束的回调函数（调用成功、失败都会执行）
success function 否 接口调用成功的回调函数
fail function 否 接口调用失败的回调函数

object.success 回调参数

参数

Object res

属性 类型 说明
status number status 设备的固件版本状态 0 已是最新版本、1 有待升级的固件、2 正在升级

object.fail 回调参数

参数

Object res

属性 类型 说明
errorMsg string 插件错误信息
errorCode string 错误码
innerError object 插件外部依赖错误信息 {errorMsg: string, errorCode: string }

ty.device.openOTAUpgrade

跳转设备升级页面

需引入DeviceKit，且在>=2.2.0版本才可使用

参数

Object object

属性 类型 默认值 必填 说明
deviceId string 是 deviceId 设备 id
complete function 否 接口调用结束的回调函数（调用成功、失败都会执行）
success function 否 接口调用成功的回调函数
fail function 否 接口调用失败的回调函数

👉 立即开发。

家庭API

ty.home.getCurrentHomeInfo

获取当前家庭信息

需引入HomeKit，且在>=3.0.1版本才可使用

请求参数

Object object

属性 类型 默认值 必填 说明
complete function 否 接口调用结束的回调函数（调用成功、失败都会执行）
success function 否 接口调用成功的回调函数
fail function 否 接口调用失败的回调函数

返回结果

  • success
属性 类型 说明
homeName string 家庭名称
homeId string 家庭 id
longitude string 经度
latitude string 维度
address string 详细地址
admin boolean 是否是管理员 true 是管理员; false 非管理员
  • fail
属性 类型 说明
errorMsg string 插件错误信息
errorCode string 错误码
innerError object 插件外部依赖错误信息 {errorMsg: string, errorCode: string }

请求示例

复制代码 
ty.home.getCurrentHomeInfo({
  success: (res) => {
    console.log(res);
  },
  fail: (error) => {
    console.log(error);
  }
})

返回示例

复制代码 
{
  "homeId": "26725023",
  "admin": true,
  "latitude": "30.30039978027344",
  "longitude": "120.0689010620117",
  "homeName": "我的家庭",
  "address": "华策中心A座"
}

ty.home.getDeviceIdList

获取当前维度下的设备 id 列表

需引入HomeKit，且在>=3.1.0版本才可使用

请求参数

Object object

属性 类型 默认值 必填 说明
ownerId number 是 维度 id（比如家庭id）
complete function 否 接口调用结束的回调函数（调用成功、失败都会执行）
success function 否 接口调用成功的回调函数
fail function 否 接口调用失败的回调函数

返回结果

  • success
属性 类型 说明
devIds Array<String> 设备 id 列表
  • fail
属性 类型 说明
errorMsg string 插件错误信息
errorCode string 错误码
innerError object 插件外部依赖错误信息 {errorMsg: string, errorCode: string }

请求示例

复制代码 
ty.home.getDeviceIdList({
  ownerId: '26725023',
  success: (res) => {
    console.log(res);
  },
  fail: (error) => {
    console.log(error);
  }
})

返回示例

复制代码 
{
  "devIds": [
    "vdevo168845027498793", 
    "64710761ecfabcaaf553", 
    "6c87332fc414a65029ovfr"
  ]
}

ty.home.getRoomList

从 sdk 本地缓存中获取当前家庭维度下房间的设备 id 列表

需引入HomeKit，且在>=3.1.0版本才可使用

请求参数

Object object

属性 类型 默认值 必填 说明
ownerId number 是 维度 id（比如家庭 id）
complete function 否 接口调用结束的回调函数（调用成功、失败都会执行）
success function 否 接口调用成功的回调函数
fail function 否 接口调用失败的回调函数

返回结果

  • success
属性 类型 说明
roomDatas Array<RoomInfo> 房间列表

RoomInfo

属性 类型 说明
name String 房间名称
roomId number 房间 id
deviceIds Array<String> 设备 id 列表
  • fail
属性 类型 说明
errorMsg string 插件错误信息
errorCode string 错误码
innerError object 插件外部依赖错误信息 {errorMsg: string, errorCode: string }

请求示例

复制代码 
ty.home.getRoomList({
  ownerId: '26725023',
  success: (res) => {
    console.log(res);
  },
  fail: (error) => {
    console.log(error);
  }
})

返回示例

复制代码 
{
  "roomDatas": [{
    "name": "Living room",
    "deviceIds": ["vdevo160395678273817"],
    "roomId": 18585095
  }, {
    "name": "Master bedroom",
    "deviceIds": ["64710761ecfabcaaf553"],
    "roomId": 18585096
  }, {
    "name": "Second bedroom",
    "deviceIds": [],
    "roomId": 18585097
  }]
}

ty.home.getDeviceRoomInfo

获取设备房间信息

需引入HomeKit，且在>=3.0.1版本才可使用

请求参数

Object object

属性 类型 默认值 必填 说明
deviceId string 是 设备 id
complete function 否 接口调用结束的回调函数（调用成功、失败都会执行）
success function 否 接口调用成功的回调函数
fail function 否 接口调用失败的回调函数

返回结果

  • success
属性 类型 说明
roomId number The room ID.
name string The room name.
  • fail
属性 类型 说明
errorMsg string 插件错误信息
errorCode string 错误码
innerError object 插件外部依赖错误信息 {errorMsg: string, errorCode: string }

请求示例

复制代码 
ty.home.getDeviceRoomInfo({
  deviceId: '64710761ecfabcaaf553',
  success: (res) => {
    console.log(res);
  },
  fail: (error) => {
    console.log(error);
  }
})

返回示例

复制代码 
{
  "name": "Living room",
  "roomId": 18585096
}

👉 立即开发。

相关推荐
步步为营DotNet28 分钟前
深度解析CancellationToken：.NET中的优雅取消机制
java·前端·.net
gaolei_eit2 小时前
Vue3项目ES6转ES5，兼容低版本的硬件设备，React也
javascript·react.js·es6
一位搞嵌入式的 genius2 小时前
从 ES6 到 ESNext：JavaScript 现代语法全解析（含编译工具与实战）
前端·javascript·ecmascript·es6
linweidong4 小时前
C++ 模块化编程（Modules）在大规模系统中的实践难点？
linux·前端·c++
leobertlan7 小时前
2025年终总结
前端·后端·程序员
子兮曰7 小时前
OpenClaw架构揭秘：178k stars的个人AI助手如何用Gateway模式统一控制12+通讯频道
前端·javascript·github
冷雨夜中漫步8 小时前
Python快速入门（6）——for/if/while语句
开发语言·经验分享·笔记·python
百锦再8 小时前
Reactive编程入门：Project Reactor 深度指南
前端·javascript·python·react.js·django·前端框架·reactjs
莲华君8 小时前
React快速上手：从零到项目实战
前端·reactjs教程
百锦再8 小时前
React编程高级主题：测试代码
android·前端·javascript·react.js·前端框架·reactjs
热门推荐
01GitHub 镜像站点02Claude Code + GLM4.7 避坑指南：解决 Unable to connect to Anthropic services03openclaw配置教程（linux+局域网ollama）04UV安装并设置国内源05Linux下V2Ray安装配置指南06AI 规范驱动开发“三剑客”深度对比：Spec-Kit、Kiro 与 OpenSpec 实战指南07openclaw使用nginx反代部署过程 与disconnected (1008): pairing required解决08Claude Code Skills 实用使用手册09在Trae中使用Pencil MCP10Vue-skills的中文文档