跳过主要内容
返回到插件
@capgo/capacitor-wifi
教程
由 github.com/Cap-go

WiFi

管理您的 Capacitor 应用程序的WiFi连接

指南

WiFi教程

使用@capgo/capacitor-wifi

WiFi插件,用于管理设备WiFi连接

安装

bun add @capgo/capacitor-wifi
bunx cap sync

此插件暴露的内容

  • addNetwork - 在设备上显示系统对话框,添加一个Wi-Fi网络。 在AndroidSDK 30+上,这会打开系统Wi-Fi设置,网络预填充。 在iOS上,这会直接连接到网络。
  • connect - 连接到Wi-Fi网络。 在Android上,这会创建一个临时连接,除非设置autoRouteTraffic为true,否则不会将流量绑定到连接的网络(适用于本地/设备托管AP)。 在Android上使用addNetwork()来创建一个持久连接。 在iOS上,这会创建一个持久连接。
  • disconnect - 从当前Wi-Fi网络断开连接。 在iOS上,只断开了通过此插件添加的网络
  • getAvailableNetworks - 从上一次扫描中获取可用的 Wi-Fi 网络列表。仅在 Android 上可用。

示例用途

addNetwork

Show a system dialog to add a Wi-Fi network to the device. On Android SDK 30+, this opens the system Wi-Fi settings with the network pre-filled. On iOS, this connects to the network directly.

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

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

connect

连接到 Wi-Fi 网络。 在 Android 上,创建一个临时连接,除非设置了 autoRouteTraffic 为 true,否则不会将流量路由到网络。 在 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`);
});

完整参考