跳过内容
Capgo - 实时更新 Capacitor 应用程序 Capgo

开始使用

安装

标题为“安装”的部分
终端窗口
bun add @capgo/capacitor-wifi
bunx cap sync

导入

标题为“导入”的部分
import { CapacitorWifi } from '@capgo/capacitor-wifi';

API 概述

API概述

addNetwork

添加网络

显示系统对话框，添加设备的Wi-Fi网络。 在Android SDK 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，否则不会将流量路由到网络。 在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`);
});

getIpAddress

标题：获取 IP 地址

获取设备当前的 IP 地址。 支持 Android 和 iOS。

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


const { ipAddress } = await CapacitorWifi.getIpAddress();
console.log('IP Address:', ipAddress);

getRssi

标题：获取 RSSI

获取当前网络的接收信号强度指标 (RSSI) 值，单位为 dBm。 仅在 Android 上可用。

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


const { rssi } = await CapacitorWifi.getRssi();
console.log('Signal strength:', rssi, 'dBm');

getSsid

标题：获取 SSID

获取当前网络的服务集标识符 (SSID)。 支持 Android 和 iOS。

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


const { ssid } = await CapacitorWifi.getSsid();
console.log('Connected to:', ssid);

getWifiInfo

标题：获取 WiFi 信息

获取当前连接的 WiFi 网络的详细信息。 本方法提供单次调用中包括 SSID、BSSID、IP 地址、频率、链路速度和信号强度等详细网络信息。 在 iOS 上，某些字段可能不可用且为 undefined。

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


const info = await CapacitorWifi.getWifiInfo();
console.log('Network:', info.ssid);
console.log('BSSID:', info.bssid);
console.log('IP:', info.ip);
console.log('Frequency:', info.frequency, 'MHz');
console.log('Speed:', info.linkSpeed, 'Mbps');
console.log('Signal:', info.signalStrength);

isEnabled

“isEnabled”标题

检查设备上的 Wi-Fi 是否启用。 仅在 Android 上可用。

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


const { enabled } = await CapacitorWifi.isEnabled();
console.log('WiFi is', enabled ? 'enabled' : 'disabled');

startScan

“startScan”标题

开始扫描 Wi-Fi 网络。 仅在 Android 上可用。 结果通过 ‘networksScanned’ 事件监听器传递。 注意：可能由于系统限制或硬件问题而失败。

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


await CapacitorWifi.addListener('networksScanned', () => {
  console.log('Scan completed');
});
await CapacitorWifi.startScan();

checkPermissions

“checkPermissions”标题

检查当前位置访问权限。 位置权限在两种平台上都需要，用于 Wi-Fi 操作。

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


const status = await CapacitorWifi.checkPermissions();
console.log('Location permission:', status.location);

requestPermissions

“requestPermissions”标题

向用户请求位置权限。 位置权限在两种平台上都需要，用于 Wi-Fi 操作。

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


const status = await CapacitorWifi.requestPermissions();
if (status.location === 'granted') {
  console.log('Permission granted');
}

类型参考

类型参考

AddNetworkOptions

添加网络选项

添加网络选项

export interface AddNetworkOptions {
  /**
   * The SSID of the network to add
   *
   * @since 7.0.0
   */
  ssid: string;


  /**
   * The password for the network (optional for open networks)
   *
   * @since 7.0.0
   */
  password?: string;


  /**
   * Whether the network is hidden (Android only)
   *
   * @since 7.0.0
   * @default false
   */
  isHiddenSsid?: boolean;


  /**
   * The security type of the network (Android only)
   *
   * @since 7.0.0
   * @default NetworkSecurityType.WPA2_PSK
   */
  securityType?: NetworkSecurityType;
}

ConnectOptions

连接选项

连接到网络的选项

export interface ConnectOptions {
  /**
   * The SSID of the network to connect to
   *
   * @since 7.0.0
   */
  ssid: string;


  /**
   * The password for the network (optional for open networks)
   *
   * @since 7.0.0
   */
  password?: string;


  /**
   * Whether the network is hidden (Android only)
   *
   * @since 7.0.0
   * @default false
   */
  isHiddenSsid?: boolean;


  /**
   * Whether to automatically route app traffic through the connected Wi-Fi network (Android only)
   * When enabled, it binds the app process to the connected network using ConnectivityManager.bindProcessToNetwork()
   * This is useful for connecting to local/device-hosted APs (e.g., ESP32, IoT devices) that don't have internet access.
   *
   * @since 7.0.0
   * @default false
   */
  autoRouteTraffic?: boolean;
}

DisconnectOptions

断开连接选项

断开与网络的连接选项

export interface DisconnectOptions {
  /**
   * The SSID of the network to disconnect from (optional)
   *
   * @since 7.0.0
   */
  ssid?: string;
}

GetAvailableNetworksResult

获取可用网络结果

getAvailableNetworks() 的结果

export interface GetAvailableNetworksResult {
  /**
   * List of available networks
   *
   * @since 7.0.0
   */
  networks: Network[];
}

GetIpAddressResult

获取 IP 地址结果

getIpAddress() 的结果

export interface GetIpAddressResult {
  /**
   * The device's IP address
   *
   * @since 7.0.0
   */
  ipAddress: string;
}

GetRssiResult

获取 RSSI 结果

getRssi() 的结果

export interface GetRssiResult {
  /**
   * The signal strength in dBm
   *
   * @since 7.0.0
   */
  rssi: number;
}

GetSsidResult

获取 SSID 结果

getSsid() 的结果

export interface GetSsidResult {
  /**
   * The SSID of the current network
   *
   * @since 7.0.0
   */
  ssid: string;
}

WifiInfo

Wi-Fi 信息

Wi-Fi 信息全面概述。

export interface WifiInfo {
  /**
   * The SSID (network name) of the current network
   *
   * @since 7.0.0
   */
  ssid: string;


  /**
   * The BSSID (MAC address) of the access point.
   * Not available on iOS.
   *
   * @since 7.0.0
   */
  bssid?: string;


  /**
   * The device's IP address on the network
   *
   * @since 7.0.0
   */
  ip: string;


  /**
   * The network frequency in MHz.
   * Not available on iOS.
   *
   * @since 7.0.0
   */
  frequency?: number;


  /**
   * The connection speed in Mbps.
   * Not available on iOS.
   *
   * @since 7.0.0
   */
  linkSpeed?: number;


  /**
   * The signal strength (0-100).
   * Calculated from RSSI on Android.
   * Not available on iOS.
   *
   * @since 7.0.0
   */
  signalStrength?: number;
}

IsEnabledResult

isEnabled() 的结果

isEnabled() 的结果

export interface IsEnabledResult {
  /**
   * Whether Wi-Fi is enabled
   *
   * @since 7.0.0
   */
  enabled: boolean;
}

PermissionStatus

权限状态

复制到剪贴板

export interface PermissionStatus {
  /**
   * Location permission state
   *
   * @since 7.0.0
   */
  location: PermissionState;
}

RequestPermissionsOptions

请求权限选项

复制到剪贴板

export interface RequestPermissionsOptions {
  /**
   * Permissions to request
   *
   * @since 7.0.0
   */
  permissions?: 'location'[];
}

NetworkSecurityType

网络安全类型

网络安全类型。

export enum NetworkSecurityType {
  /**
   * Open network with no security
   *
   * @since 7.0.0
   */
  OPEN = 0,


  /**
   * WEP security
   *
   * @since 7.0.0
   */
  WEP = 1,


  /**
   * WPA/WPA2 Personal (PSK)
   *
   * @since 7.0.0
   */
  WPA2_PSK = 2,


  /**
   * WPA/WPA2/WPA3 Enterprise (EAP)
   *
   * @since 7.0.0
   */
  EAP = 3,


  /**
   * WPA3 Personal (SAE)
   *
   * @since 7.0.0
   */
  SAE = 4,


  /**
   * WPA3 Enterprise
   *
   * @since 7.0.0
   */
  WPA3_ENTERPRISE = 5,


  /**
   * WPA3 Enterprise 192-bit mode
   *
   * @since 7.0.0
   */
  WPA3_ENTERPRISE_192_BIT = 6,


  /**
   * Passpoint network
   *
   * @since 7.0.0
   */
  PASSPOINT = 7,


  /**
   * Enhanced Open (OWE)
   *
   * @since 7.0.0
   */
  OWE = 8,


  /**
   * WAPI PSK
   *
   * @since 7.0.0
   */
  WAPI_PSK = 9,


  /**
   * WAPI Certificate
   *
   * @since 7.0.0
   */
  WAPI_CERT = 10,
}

真实来源

Section titled “真实来源”

本页面是由插件生成的。 src/definitions.ts. 当公共 API 在上游更改时，请重新运行同步。