メインコンテンツへスキップ
@capgo/capacitor-wifi デバイスAPI オープンソース

Wi-Fi Capacitor プラグイン

CapacitorアプリのWiFi接続を管理

インストール

bun add @capgo/capacitor-wifi bunx cap sync
npm、pnpm、または yarn
  • npm install @capgo/capacitor-wifi
  • pnpm add @capgo/capacitor-wifi
  • yarn add @capgo/capacitor-wifi

ガイド

Capacitor で WiFi を使用する方法

実機でテストする

Capgo アプリをダウンロードして、QR code をスキャンしてください。

WiFiプラグイン プレビューQR code

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

リファレンス全文

@capgo/capacitor-wifi の活用方法を見る

以下を使用している場合: @capgo/capacitor-wifi を使用 ダッシュボードと API の操作を計画するには、以下と連携してください @capgo/capacitor-wifi @capgo/capacitor-wifi の実装詳細については、 はじめに Getting Started の実装の詳細については、 API の概要 API Overview の実装の詳細については、 はじめに はじめに の実装詳細、および API キー API Keys の実装詳細については、

よくある質問

WiFi プラグイン FAQ

Capacitor アプリに WiFi プラグインをインストールするには?

"bun add @capgo/capacitor-wifi" (または "npm install @capgo/capacitor-wifi") を実行した後、"bunx cap sync" を実行して iOS および Android プロジェクトにネイティブの code を反映させてください。その後、アプリの code から "@capgo/capacitor-wifi" をインポートします。

@capgo/capacitor-wifi は React、Vue、Angular で使えますか?

はい。WiFi は Capacitor パッケージなので、Ionic、React、Vue、Angular、Svelte、あるいは純粋な JavaScript など、Capacitor 上で動作するあらゆる Web フレームワークで使用可能です。

@capgo/capacitor-wifi はどの Capacitor バージョンをサポートしていますか?

Capgo プラグインは Capacitor のメジャーバージョンに合わせています。使用している Capacitor のメジャーバージョンと一致するプラグインのメジャーバージョンを使ってください (例: Capacitor 8 ならプラグイン v8)。GitHub の README にある互換性テーブルに、メンテナンス中のバージョンが記載されています。

@capgo/capacitor-wifi は無料のオープンソースですか?

はい。code のソースコードは GitHub 上の https://github.com/Cap-go/capacitor-wifi/ で公開されており、npm から無料でインストールできます。バグ報告やプルリクエストも歓迎しています。

App Store の審査なしで、WiFi を使用する code をアップデートできますか?

このプラグインをインストールまたはアップグレードするとネイティブの code が変わるため、ストア向けの新しいビルドが必要です。その後は、プラグインを呼び出す JavaScript、HTML、CSS の変更を Capgo によるライブアップデートで即座に配信できます。

アプリの審査を待たずに WiFi 設定の変更を配信

ストアビルドにプラグインを組み込めば、Capgo のライブアップデートで JavaScript、HTML、CSS の変更を数分でユーザーに配信できます。

Capgo から始める