メインコンテンツへスキップ
@capgo/capacitor-mqtt コミュニケーション オープンソース

MQTT Capacitor プラグイン

iOS、Android、Webでのリアルタイムメッセージングを実現するMQTTサポート。

インストール

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

ガイド

Capacitor で MQTT を使用する方法

実機でテストする

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

MQTTプラグインのプレビューQR code

@capgo/capacitor-mqtt の使用方法

AndroidおよびiOSでMQTT接続を実現するCapacitorプラグイン。

インストール

bun add @capgo/capacitor-mqtt
bunx cap sync

bunx cap sync プラグインのネイティブcodeをネイティブプロジェクトにコピーします。プラグインをアップグレードするたびに再度実行してください。

インポート

import { MqttBridge } from '@capgo/capacitor-mqtt';

API の概要

メソッド 説明
connect 現在の動作については、ソースの定義を参照してください。
disconnect 現在の動作については、ソースの定義を参照してください。
subscribe 現在の動作については、ソースの定義を参照してください。
publish 現在の動作については、ソースの定義を参照してください。

例

connect()

現在のコントラクトについては、API のリファレンスを参照してください。

import { MqttBridge } from '@capgo/capacitor-mqtt';

const result = await MqttBridge.connect({
  serverURI: 'https://example.com',
  port: 8080,
  clientId: 'client-id-123',
  username: 'username',
  password: 'password',
  setCleanSession: true,
  connectionTimeout: 1000,
  keepAliveInterval: 1000,
  setAutomaticReconnect: true,
});
console.log(result);

disconnect()

現在のコントラクトについては、API のリファレンスを参照してください。

import { MqttBridge } from '@capgo/capacitor-mqtt';

const result = await MqttBridge.disconnect();
console.log(result);

subscribe()

現在のコントラクトについては、API のリファレンスを参照してください。

import { MqttBridge } from '@capgo/capacitor-mqtt';

const result = await MqttBridge.subscribe({
  topic: 'topic',
  qos: 1,
});
console.log(result);

publish()

現在のコントラクトについては、API のリファレンスを参照してください。

import { MqttBridge } from '@capgo/capacitor-mqtt';

const result = await MqttBridge.publish({
  topic: 'topic',
  payload: 'payload',
  qos: 1,
  retained: true,
});
console.log(result);

イベントをリッスンする

addListener ハンドルを返します。画面がアンマウントされるときに handle.remove() を呼び出してください。

完全なリファレンス

続きは「@capgo/capacitor-mqtt の使用方法」から

使用している場合 @capgo/capacitor-mqtt の使用方法 ネイティブプラグインの作業を計画するには、次と連携してください: @capgo/capacitor-mqtt @capgo/capacitor-mqtt の実装の詳細については、 スタートガイド スタートガイドの実装詳細については、 Capgo プラグインディレクトリ Capgo プラグインディレクトリのプロダクトワークフローについては、 Capgo による Capacitor プラグイン Capgo による Capacitor Plugins の実装詳細、および プラグインの追加または更新 プラグインの追加または更新に関する実装詳細についてはこちら。

よくある質問

MQTTプラグイン FAQ

Capacitor アプリに MQTT plugin をインストールするには?

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

@capgo/capacitor-mqtt は React、Vue、Angular で動作しますか?

はい。MQTT は Capacitor パッケージであるため、Ionic、React、Vue、Angular、Svelte、およびプレーンな JavaScript を含む、Capacitor 内で動作するあらゆる Web フレームワークで使用可能です。

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

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

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

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

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

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

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

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

Capgo から始める