作者： Next

插件提供设备端和微信用户直接通话的能力。

1. 选择接口

开发者请根据场景选择不同的通话接口。

1.1 安卓 WMPF 设备呼叫手机微信

使用 initByCaller 接口，businessType 传 1。

1.2 Linux 设备呼叫手机微信

Linux 设备不运行微信小程序插件，请使用微信小程序音视频通话 SDK (Linux 设备)。

1.3 手机微信呼叫安卓 WMPF 设备

• 推荐：使用 callWMPF 接口。需插件 2.4.0 开始支持。若使用 license 计费，必须使用本接口。
• 使用 initByCaller 接口，businessType 传 2。此方式不支持 license 计费。

1.4 手机微信呼叫 Linux 设备

使用 callDevice 接口。需插件 2.4.0 开始支持。

请注意：呼叫 Linux 设备时，微信不进行消息推送，需要开发者自行将设备端加入房间所需参数（如 roomId 等）从微信端推送到设备端。

2. 使用前必读

2.1 进入通话页面

发起通话的几个接口既可以在微信小程序页面调用，也可以在插件页面调用。但是最终通话流程必须在插件页面才能进行。

• 如果发起通话时在微信小程序页面，接口调用成功后，开发者需要手动跳转到插件页面，插件页面加载完成后进入通话流程。
• 如果发起通话时在插件页面，接口调用成功后就会直接进入通话流程。此时请勿重复进行页面跳转，否则当前通话会被中断。
• 不建议页面栈内存在多个插件页面实例。

// 发起通话成功后，仅在当前不是插件页面的情况下需进行跳转。
wx.redirectTo({
  // 此处只需要传入 path 即可，如果开发者有其他参数需要传递给<a href="https://weixin-xiaochengxu-kaifa.yuannext.com">微信小程序</a>，也可以自行拼接 query，并通过插件 getPluginOnloadOptions 接口获取。
  url: wmpfVoip.CALL_PAGE_PATH,
  // 插件 2.3.9 开始支持 CALL_PAGE_PATH, 低版本请传入 'plugin-private://wxf830863afde621eb/pages/call-page-plugin/call-page-plugin',
})

2.2 最大通话时长

为了降低开发者的开发成本，插件提供了限制最大通话时长的能力。最大通话时长应为 > 0 的数字。

通话时长从 startVoip 事件开始计时，超时后通话自动结束并弹 toast 提示用户，同时触发 hangUpVoip 事件，origin 为 'timeLimit'。

2.3 groupId 与 roomId

在插件 2.4.0 以下版本中，通话房间 ID 被称为 groupId，这个名字比较容易与设备组的 ID 产生混淆，因此从 2.4.0 开始，房间号统一更名为 roomId，但为保持向下兼容，groupId 参数仍予以保留。

二者除名字不同外，无其他差异。

本插件主要用于提供「微信小程序音视频通话（for 硬件）」的部分基础能力和统一的通话界面。完整的接入流程和开发指南请参考相关文档。

插件接入可参考：微信小程序示例代码

1. 微信小程序引入插件

关于微信小程序插件详细说明请参考微信小程序使用插件文档

在「微信小程序管理后台」添加插件后，使用者还需要在微信小程序的 app.json 中声明本插件。可以在主包引入，也可以在分包引入。

// 主包引入
{
  "plugins": {
    "wmpf-voip": {
      "version": "latest", // latest 表示自动使用最新版本。也可使用具体版本，如 2.3.8
      "provider": "wxf830863afde621eb"
    }
  }
}

// 分包引入
{
  "subpackages": [
    {
      "root": "xxxx",
      "pages": [],
      "plugins": {
        "wmpf-voip": {
          "version": "latest", // latest 表示自动使用最新版本。也可使用具体版本，如 2.3.8
          "provider": "wxf830863afde621eb"
        }
      }
    }
  ]
}

完成声明后，可以在微信小程序中来确认是否引入成功

const wmpfVoip = requirePlugin('wmpf-voip').default
console.log(wmpfVoip) // 有结果即表示引入插件成功

2. 插件接口

从功能上，插件提供的接口可以分为以下几类

2.1 发起通话

发起通话的过程中，插件主要负责通话房间创建、发送接听提醒和通话页面的展示。可以在微信小程序页面或插件页面调用initByCaller 发起通话。

2.2 结束通话

通常情况下，通话结束需要用户点击操作。某些场景下，微信小程序也可以调用 forceHangUpVoip 主动结束当前通话。

非用户点击结束通话可能有以下场景：

• 用户操作硬件设备的某些按钮结束通话。例如，设备有单独的话机听筒时，用户挂断听筒。
• 用户通话时长超过限制。建议使用 initByCaller 的 timeLimit 参数。插件低版本也可以根据 calling 事件的 keepTime 字段计算通话时长。

2.3 通话事件

开发者可以通过 onVoipEvent 绑定通话事件的监听，以便更好地分析通话过程。

2.4 自定义设置

插件提供下列接口对通话过程和界面进行设置

• setCustomBtnText：自定义接听页面按钮。
• setVoipEndPagePath：设置插件功能执行完成后的跳转页面路径。
• setUIConfig：设置插件通话界面。

2.5 授权查询

在微信客户端内，可以使用wx.getDeviceVoIPList查询当前登录的用户同意或拒绝授权了哪些设备。

在硬件端，可以通过插件getIotBindContactList接口查询用户是否授权某台设备。

推荐开发者在微信用户授权设备时，即 wx.requestDeviceVoIP 回调 success 后，在后台存储 SN 与 openId。在设备端联系人页面中，配合 getIotBindContactList 接口进行授权验证。

2.6 页面参数

微信小程序可以通过插件getPluginEnterOptions获取从插件页面进入微信小程序时的启动参数。

如果微信小程序在前台时进入插件页面，则需要使用getPluginOnloadOptions获取插件通话页面 onLoad 时页面路径中的参数。

3. 更新日志

请参考《微信小程序音视频通话插件更新日志》

1. 产品介绍

微信小程序框架已适配手表穿戴类设备，可针对 RTOS（实时操作系统）等低功耗设备场景，实现最小可用的微信小程序运行。

2. 技术方案

由于市场主流穿戴设备的 CPU 性能和内存大小十分有限（整机内存小于 8M），我们针对性实现了最小可用的微信小程序框架，提供：

1. 熟悉的 WXML + WXSS + JS 的微信小程序开发体验
2. 最必要的微信小程序 wx 接口
3. 基本完整的微信小程序页面框架和组件系统
4. 基础的 WXSS 样式和内置组件支持
5. 微信小程序代码包编译器
6. 模拟调试环境

穿戴设备的硬件资源十分有限。为减小存储占用，该微信小程序框架只提供普通微信小程序的功能子集，请开发者严格按照本文档提供的特性列表实现微信小程序。由于接口能力的差异较大，一般需要开发者针对穿戴设备单独开发新的微信小程序。

2.1 UI能力

2.1.1 组件框架

可以使用微信小程序中 Page、Component能力。支持完整的 WXML、WXSS 语法。

2.1.1.1 支持的特性

可以在微信小程序中使用 App、getApp、Page、getCurrentPages、Component。支持 ES6 import / export 与 CommonJS require 两种 JS 模块加载机制。

2.1.1.2 使用差异

使用微信小程序组件框架时应注意下列差异：

• 组件的 styleIsolation 需在 JSON 中配置，不支持在组件 options 中指定
• 不再支持 addGlobalClass，请使用 styleIsolation 代替
• 当使用组件间通信与事件时，可以直接定义 export 属性，不需要声明 wx://component-export。

2.1.1.3 暂未支持的特性

以下能力暂未支持

• Chaining API

• behavior

• WXS

• 暂不支持自定义组件的下列方法：

  • createSelectorQuery
  • createIntersectionObserver
  • createMediaQueryObserver
  • getTabBar
  • animate
  • clearAnimation
  • applyAnimatedStyle
  • clearAnimatedStyle
  • setUpdatePerformanceListener

2.1.2 内置组件

目前仅支持下列内置组件

2.1.2.1 view

属性：无

2.1.2.2 image

属性：

说明：

• 不建议显示高清图片。部分穿戴设备的屏幕分辨率边长仅 200～300 像素，且内存有限，过大图片无法清晰渲染且可能导致内存溢出。
• 不建议使用图片组件显示微信小程序码、二维码、条形码等，建议使用 qrcode 组件。

2.1.2.3 text

属性：无

2.1.2.4 qrcode

穿戴设备微信小程序框架的专属组件，能够根据输入的文本生成并渲染二维码。

考虑到资源消耗，穿戴设备不建议使用图片展示二维码。
对于需要展示微信小程序码的情况，可以参考扫普通链接二维码打开微信小程序 。

2.1.2.5 scroll-view

2.1.2.6 swiper/swiper-item

swiper 支持属性：

2.1.3 WXSS样式

• display: block/flex（支持弹性盒子布局），不支持 inline/inline-block/inline-flex/grid
• position 绝对布局（top、right、bottom、left）
• width、height、margin、padding 等组件尺寸设置
• color 等文本属性
• border 相关属性：border-radius 不支持分别设置四角圆角大小，不支持百分比写法。
• background 相关属性: background-image, background-color
• font-size 等字体设置暂不支持

不支持子元素选择器、后代选择器、接续兄弟选择器、后续兄弟选择器，若有相关开发需求，请通过普通选择器实现。
注意：WXML支持内联样式，但不支持binding（不可以通过setData()修改WXML组件的style属性值）。

2.2 微信小程序配置

2.2.1 app.json

配置项：

window:

用于设置微信小程序的状态栏、导航条、标题、窗口背景色。穿戴设备微信小程序框架只支持设置窗口背景色。

networkTimeout

各类网络请求的超时时间，单位均为毫秒。穿戴设备微信小程序框架只支持设置request的超时时间。

2.2.2 component.json

配置项

styleIsolation

2.2.3 page.json

每一个微信小程序页面可以使用同名.json文件来对本页面的窗口表现进行配置，页面中配置项会覆盖 app.json 的 window 中相同的配置项。

配置项：

2.3 接口能力

• JSAPI 调用方式与完整版一致，支持回调和 Promise 两种调用形式，详情请参考相关文档。
• 本节仅说明和完整版的差异部分，完整的 API 接口说明请参考官网文档。为避免重复，本文省略参数中 success/fail/complete 回调函数的说明，如无特殊说明，均提供与完整版一致的 success/fail/complete 回调接口

2.3.1 微信生态能力

• wx.login：一致
• wx.checkSession: 一致
• wx.getAccountInfoSync：一致

2.3.2 系统信息

• wx.getWindowInfo：一致。额外增加返回值 screenShape。
• wx.getDeviceInfo: 仅支持返回 brand、model、system、platform、cpuType、memorySize。额外增加返回值 deviceType。

wx.getWindowInfo 新增返回值

wx.getDeviceInfo 新增返回值

注意：

本框架不提供wx.getSystemInfo系列接口，请使用getWindowInfo/getDeviceInfo代替。

2.3.3 网络请求

wx.request()

• 参数仅支持 url、data、header、timeout、method(仅支持GET, POST)、dataType、responseType、redirect。
• 返回的 RequestTask 仅支持 abort
• success 回调参数仅支持 data、statusCode、header
• fail 回调参数一致

注意

• 目前暂未提供文件系统支持，故暂未支持 wx.downloadFile/wx.uploadFile。
• 目前仅支持https，不支持TCP、UDP、WebSocket等其他类型的网络请求。

2.3.4 页面路由

• wx.navigateTo：参数仅支持 url
• wx.navigateBack：一致
• wx.redirectTo：一致
• wx.reLaunch：一致

注意：暂未提供tabBar

2.3.5 数据存储

• wx.getStorageInfo(sync)：一致
• wx.setStorage(Sync)：参数仅支持 key、data
• wx.getStorage(Sync)：参数仅支持 key
• wx.removeStorage(Sync)：一致
• wx.clearStorage(Sync)：一致

注意

1. 目前只提供KV存储，暂不提供文件存储。
2. 暂不支持加密存储

2.3.6 UI

• wx.showToast：一致
• wx.hideToast：参数不支持 noConflict，toast 和 loading 默认不可混用
• wx.showLoading：一致
• wx.hideLoading：参数不支持 noConflict，toast 和 loading 默认不可混用
• wx.showModal：参数不支持 editable 和 placeholderText
• wx.getMenuButtonBoundingClientRect：一致

注意：暂无 navigationBar、tabBar、homeButton

2.3.7 生命周期

• wx.getLaunchOptionsSync：参数仅支持 path、scene、query
• wx.getEnterOptionsSync：参数仅支持 path、scene、query
• wx.onUnhandledRejection：一致
• wx.onError：一致
• wx.onPageNotFound：一致
• wx.onAppShow：参数仅支持 path、scene、query
• wx.onAppHide：一致

2.3.8 事件

• bind:touchstart
• bind:touchend
• bind:tap
• bind:longpress

其中事件对象仅支持 type, target, currentTarget 字段，target/currentTarget 仅支持 dataset 字段。

2.3.9 其他

• console.log/info/error/warn/debug：输出会打印在模拟器的命令行窗口中，可以通过 console.log 调试微信小程序逻辑。
• setTimeout/clearTimeout
• setInterval/clearInterval

2.4 其他差异

• 暂不支持微信小程序插件
• 暂不支持微信小程序分包

3. 开发流程

3.1 注册穿戴设备微信小程序框架专属AppID

前置条件：名下需有普通微信小程序的AppID，并作为该微信小程序的管理员。
步骤：

1. 打开微信开发者平台
2. 扫码登录
3. 点击「前往控制台」

4. 选择「我的业务–微信小程序」

5. 页面右上角，切换到穿戴设备微信小程序要挂靠的普通微信小程序。
6. 切换到「硬件设置」
7. 点击「申请创建」

8. 创建成功，获得「穿戴端AppID」

3.2 安装开发者工具拓展

1. 打开「微信开发者工具」(需使用版本号 ≥ 2.01.2507252,建议下载最新 nightly 版开发者工具进行使用)
2. 在「工具栏」选择「设置–拓展设置」
3. 在弹出的页面中，左侧选择「模拟器插件」，右侧选择安装「低功耗硬件微信小程序模式」

3.3 启用低功耗微信小程序模式

装好插件后，将开发模式切换到「低功耗硬件微信小程序模式」

3.4 开发调试

点击「详情」，确保其中设置的AppID与微信开发者平台一致。

我们不建议开发者将JS代码编译为ES5。穿戴设备微信小程序框架支持ES2023，减少不必要的polyfill有助于显著节省最终微信小程序代码包体积，进而节省运行时内存占用。

3.5 体验与发布

完成开发后，可在「微信开发者工具」中点击「上传」。新上传的版本将覆盖旧的「开发版微信小程序」。
开发者可以前往微信开发者平台，管理微信小程序版本、提交审核、发布上线。

4. 联系我们

有合作意向的硬件厂商、微信小程序开发者，欢迎发送邮件联系我们：wx_iot@tencent.com。