メインコンテンツにジャンプ

ガイド

WiFi のチュートリアル

@capgo/capacitor-wifi を使用

デバイスの WiFi 接続を管理するための WiFi プラグイン。

インストール

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

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

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

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`);
});

フルリファレンス

Using @capgo/capacitor-wifiから続けてください。

__CAPGO_KEEP_0__を使用している場合 Using @capgo/capacitor-wifi APIの計画ダッシュボードとオペレーションを実施する場合、@API/__CAPGO_KEEP_1__-wifiと接続してください。 @capgo/capacitor-wifiの実装詳細については、@capgo/capacitor-wifiを参照してください。 for the implementation detail in @capgo/capacitor-wifi, __CAPGO_KEEP_0__ 実装の詳細については、 API の概要 実装の詳細については、API の概要 導入 実装の詳細については、導入、 API のキー 実装の詳細については、API のキー