【小程序】应用程序编程接口汇总——授权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
}

👉 立即开发。

相关推荐
兮动人19 小时前
C语言之指针入门
c语言·开发语言·c语言之指针入门
lifewange19 小时前
UI自动化页面元素定位有几种方式
前端·ui·自动化
ada7_20 小时前
LeetCode(python）78.子集
开发语言·数据结构·python·算法·leetcode·职场和发展
牛奶20 小时前
2026 春涧·前端走向全栈
前端·人工智能·全栈
Piper蛋窝20 小时前
AI 有你想不到，也它有做不到 | 2025 年深度使用 Cursor/Trae/CodeX 所得十条经验
前端·后端·代码规范
LYFlied20 小时前
WebAssembly为何能实现极致性能：从设计原理到执行优势
前端·wasm·跨端
韩立学长20 小时前
【开题答辩实录分享】以《在线作业标准流程指导系统的设计与实现》为例进行选题答辩实录分享
java·javascript
nbsaas-boot20 小时前
Go 项目中如何正确升级第三方依赖（Go Modules 实战指南）
开发语言·后端·golang
百万蹄蹄向前冲21 小时前
2026云服务器从零 搭建与运维 指南
服务器·javascript·后端
释怀不想释怀21 小时前
vue布局，动态路由
前端·html
热门推荐
01GitHub 镜像站点02手把手教你通过Gemini3 pro 学生认证，白用一年，手慢无！03安娜的档案(Anna’s Archive) 镜像网站/国内最新可访问入口（持续更新）04Linux下V2Ray安装配置指南05Labelme从安装到标注：零基础完整指南06jdk21下载、安装（Windows、Linux、macOS）072025 最新教程：注册并切换到美区 Apple ID08GitLab 零基础入门指南：从安装到项目管理全流程09Figma MCP + Cursor 完全配置与使用指南：实现设计到代码的智能转换10UV安装并设置国内源