Wi-Fi プラグインの使用 (@capgo/capacitor-wifi)
デバイスの Wi-Fi 接続を管理するための Wi-Fi プラグイン
インストール
bun add @capgo/capacitor-wifi
bunx cap sync
このプラグインが公開するもの
addNetwork- Android SDK 30 以降では、システムの Wi-Fi 設定を開き、ネットワークを事前に埋め込んだ状態で表示します。iOS では、ネットワークに直接接続します。connect- Android では、ネットワークに接続しますが、デフォルトではトラフィックをルーティングしないようにします。autoRouteTraffic を true に設定すると、接続したネットワークにアプリのトラフィックをバインドできます (ローカル/デバイスホスト AP の場合に便利)。Android で持続的な接続を使用するには、addNetwork() を使用してください。iOS では、持続的な接続を作成します。disconnect- iOS では、このプラグインを使用して追加されたネットワークのみから切断します。getAvailableNetworks- Android では、最後のスキャンから利用可能な Wi-Fi ネットワークのリストを取得します。
使用例
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に設定すると、接続されたネットワークにアプリのトラフィックをバインドできます (ローカル/デバイスホスト 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
Androidで利用可能なWi-Fiネットワークのリストを取得します。
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/
Keep going from Using @capgo/capacitor-wifi
Capacitor Wi-Fiを使用している場合 Using @capgo/capacitor-wifi to plan dashboard and API operations, connect it with @capgo/capacitor-wifi Capacitor-WiFiの実装詳細については@capgo/capacitor-wifiを参照してください。 Getting Started Capacitor-WiFiの実装詳細についてはGetting Startedを参照してください。 API Overview for the implementation detail in API Overview, Capacitor-WiFiの導入 Capacitor-WiFiの実装詳細についてはCapacitor-WiFiの導入、 API Keys for the implementation detail in API Keys.