跳过主要内容

指南

WiFi 教程

使用 @capgo/capacitor-wifi

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

安装

bun add @capgo/capacitor-wifi
bunx cap sync

本插件暴露的内容

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

示例使用

addNetwork

在 Android 设备上显示一个系统对话框,添加一个 Wi-Fi 网络。SDK 在 Android 30+ 上,会打开系统 Wi-Fi 设置,网络会被预填充。 在 iOS 上,这会直接连接到网络。

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,否则不会将流量路由到网络中(适用于本地/设备托管 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 来规划仪表板和API操作,连接它与 @capgo/capacitor-wifi 查看@capgo/capacitor-wifi的实现细节 Getting Started Getting Started 实现细节 API 简介 API 实现细节 介绍 __CAPGO_KEEP_0__ 密钥 API 实现细节 for the implementation detail in API Keys.