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

ガイド

Wi-Fiのチュートリアル

デバイスでテスト

Download the Capgo app, then scan the QR code.

Wi-Fi プラグインのプレビュー QR code

@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

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

フルリファレンス

Using @capgo/capacitor-wifi

Capacitor Wi-Fiプラグインを使用している場合、Wi-Fi接続を設定するには、まずWi-Fi接続を設定する必要があります。 Using @capgo/capacitor-wifi to plan dashboard and API operations, connect it with @capgo/capacitor-wifi 実装詳細については @capgo/capacitor-wifi に Getting Started 実装詳細については Getting Started に API Overview 実装詳細については API Overview に Introduction 実装詳細については Introduction に API Keys for the implementation detail in API Keys.