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

ガイド

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 設定を開き、ネットワークを事前に埋め込むことで、Wi-Fi ネットワークを追加するシステムのダイアログを表示します。iOS では、ネットワークに直接接続します。
  • connect - Android では、Wi-Fi ネットワークに接続します。この接続は、デフォルトではネットワーク経由でトラフィックをルーティングしないように設計されています。autoRouteTraffic を true に設定すると、接続されたネットワークにアプリのトラフィックをバインドできます (ローカル/デバイスホスト AP の場合に便利)。Android では、持続的な接続を作成するには、addNetwork() を使用してください。iOS では、持続的な接続を作成します。
  • disconnect - iOS では、現在の Wi-Fi ネットワークから切断します。ただし、ネットワークを追加したプラグイン経由で切断します。
  • getAvailableNetworks - 最近のスキャンから、Android でのみ利用可能な Wi-Fi ネットワークのリストを取得します。

使用例

addNetwork

Android SDK 30+ では、システムの Wi-Fi 設定を開き、ネットワークを事前に埋め込むことで、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

__CAPGO_KEEP_0__を使用して計画ダッシュボードと__CAPGO_KEEP_0__の操作を実行している場合、@__CAPGO_KEEP_0__/__CAPGO_KEEP_1__-wifiと接続してください。 capgoを使用して計画ダッシュボードとcapgoの操作を実行している場合、@capgo/capacitor-wifiと接続してください。 APIを使用して計画ダッシュボードとAPIの操作を実行している場合、@API/__CAPGO_KEEP_1__-wifiと接続してください。 capgoを使用して計画ダッシュボードとcapgoの操作を実行している場合、@capgo/capacitor-wifiと接続してください。 実装詳細については @capgo/capacitor-wifi に Getting Started 実装詳細については Getting Started に API Overview 実装詳細については API Overview に Introduction 実装詳細については Introduction に API Keys 実装詳細については API Keys に