跳转至正文
@capgo/capacitor-wifi 设备 API 开源

WiFi Capacitor 插件

为您的 Capacitor 应用管理 WiFi 连接

安装

bun add @capgo/capacitor-wifi bunx cap sync
npm、pnpm 或 yarn
  • npm install @capgo/capacitor-wifi
  • pnpm add @capgo/capacitor-wifi
  • yarn add @capgo/capacitor-wifi

指南

如何在 Capacitor 中使用 WiFi

在设备上测试

下载 Capgo App,然后扫描二维码 code。

WiFi 插件预览二维码 code

使用 @capgo/capacitor-wifi

用于管理设备 WiFi 连接的 WiFi 插件。

安装

bun add @capgo/capacitor-wifi
bunx cap sync

插件暴露的内容

  • addNetwork - 显示系统对话框以向设备添加 Wi-Fi 网络。在 Android SDK 30+ 上,这会打开已预填网络信息的系统 Wi-Fi 设置。在 iOS 上,这会直接连接到该网络。
  • connect - 连接到 Wi-Fi 网络。在 Android 上,这会创建一个默认不通过该网络路由流量的临时连接。将 autoRouteTraffic 设置为 true 可将应用流量绑定到已连接的网络(适用于本地/设备托管的 AP)。若需在 Android 上建立持久连接,请改用 addNetwork()。在 iOS 上,这会创建一个持久连接。
  • disconnect - 断开当前 Wi-Fi 网络连接。在 iOS 上,仅断开通过此插件添加的网络。
  • getAvailableNetworks - 获取上次扫描时可用的 Wi-Fi 网络列表。仅 Android 端可用。

用法示例

addNetwork

显示系统对话框以向设备添加 Wi-Fi 网络。在 Android SDK 30+ 上,这会打开预填好网络信息的系统 Wi-Fi 设置。在 iOS 上,这会直接连接到该网络。

import { CapacitorWifi, NetworkSecurityType } from '@capgo/capacitor-wifi';

await CapacitorWifi.addNetwork({
  ssid: 'MyNetwork',
  password: 'mypassword',
  isHiddenSsid: false,
  securityType: NetworkSecurityType.WPA2_PSK
});

connect

连接到 Wi-Fi 网络。在 Android 上,这会创建一个默认不通过该网络路由流量的临时连接。将 autoRouteTraffic 设置为 true 可将应用流量绑定到已连接的网络(适用于本地/设备托管的 AP)。若需在 Android 上建立持久连接,请改用 addNetwork()。在 iOS 上,这会创建一个持久连接。

import { CapacitorWifi } from '@capgo/capacitor-wifi';

await CapacitorWifi.connect({
  ssid: 'MyNetwork',
  password: 'mypassword',
  autoRouteTraffic: true // Android only: route app traffic through this network
});

disconnect

断开当前 Wi-Fi 网络连接。在 iOS 上,仅断开通过此插件添加的网络。

import { CapacitorWifi } from '@capgo/capacitor-wifi';

await CapacitorWifi.disconnect();

getAvailableNetworks

获取上次扫描时可用的 Wi-Fi 网络列表。仅 Android 端可用。

import { CapacitorWifi } from '@capgo/capacitor-wifi';

const { networks } = await CapacitorWifi.getAvailableNetworks();
networks.forEach(network => {
  console.log(`SSID: ${network.ssid}, Signal: ${network.rssi} dBm`);
});

完整参考

继续探索 @capgo/capacitor-wifi

如果你正在使用 使用 @capgo/capacitor-wifi 要规划 dashboard 和 API 操作,请将其连接到 @capgo/capacitor-wifi 有关 @capgo/capacitor-wifi 的实现细节, 快速入门 有关“入门指南”中的实现细节, API 概览 关于 API Overview 中的实现细节, 简介 关于简介中的实现细节,以及 API 密钥 关于 API Keys 中的实现细节。

常见问题

WiFi 插件常见问题

如何在 Capacitor 应用中安装 WiFi 插件?

运行 "bun add @capgo/capacitor-wifi"(或 "npm install @capgo/capacitor-wifi"),然后运行 "bunx cap sync",让 iOS 和 Android 项目识别到原生 code。然后在应用的 code 中从 "@capgo/capacitor-wifi" 导入。

@capgo/capacitor-wifi 是否支持 React、Vue 和 Angular?

支持。WiFi 是一个 Capacitor 包,因此任何运行在 Capacitor 中的 Web 框架都能用,包括 Ionic、React、Vue、Angular、Svelte 和纯 JavaScript。

@capgo/capacitor-wifi 支持哪个版本的 Capacitor?

Capgo 插件遵循 Capacitor 的主版本号:请使用与 Capacitor 主版本号一致的插件主版本(例如插件 v8 对应 Capacitor 8)。GitHub README 中的兼容性表列出了仍在维护的版本。

@capgo/capacitor-wifi 是免费开源的吗?

是的。code 的源码公开在 GitHub 上,地址为 https://github.com/Cap-go/capacitor-wifi/,也可以从 npm 免费安装。欢迎提交 Bug 报告和 Pull Request。

我可以在不经过 App Store 审核的情况下更新使用 WiFi 的 code 吗?

安装或升级插件会改动原生 code,因此需要重新做一次商店构建。之后,调用该插件的 JavaScript、HTML 和 CSS 改动就能通过 Capgo live updates 立即发布。

无需等待应用审核,即可发布 WiFi 相关变更

只要插件已包含在你的商店版本中,Capgo live updates 就能在几分钟内把 JavaScript、HTML 和 CSS 的改动推送给用户。

开始使用 Capgo