@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`);
});
リファレンス全文
- GitHub: https://github.com/Cap-go/capacitor-wifi/
- ドキュメント: /docs/plugins/wifi/
@capgo/capacitor-wifi の使用から続けます
使用している場合 @capgo/capacitor-wifi の使用方法 ダッシュボードと API の運用を計画するには、これを次と連携させます @capgo/capacitor-wifi 実装の詳細については、@capgo/capacitor-wifi を参照してください。 スタートガイド スタートガイドの実装詳細については、 API の概要 「API の概要」の実装の詳細については、 はじめに はじめにの実装詳細、および API キー API Keys の実装詳細については、