メインコンテンツへスキップ
@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 を参照してください。 スタートガイド スタートガイドの実装詳細については、 API の概要 「API の概要」の実装の詳細については、 はじめに はじめにの実装詳細、および 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 Live Updates で即座に配信できます。

アプリ審査を待たずに WiFi 変更をリリース

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

Capgo から始める