Prise en main

Copiez un prompt de configuration avec les étapes d'installation et le guide markdown complet pour ce plugin.

        Set up this Capacitor plugin in the project.

Use the package manager already used by the project.
Install these package(s): `@capgo/capacitor-mqtt`
Run the required Capacitor sync/update step after installation.
Read this markdown guide for the full setup steps: https://raw.githubusercontent.com/Cap-go/website/refs/heads/main/apps/docs/src/content/docs/docs/plugins/mqtt/getting-started.mdx
Use that guide for platform-specific steps, native file edits, permissions, config changes, imports, and usage setup.
If that guide references other docs pages, read them too.

Installer

bun add @capgo/capacitor-mqtt
bunx cap sync

Importer

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

API Aperçu

`connect`

Voir les définitions de source pour le contrat actuel.

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

await MqttBridge.connect({} as {
    serverURI: string;
    port: number;
    clientId: string;
    username: string;
    password: string;
    setCleanSession: boolean;
    connectionTimeout: number;
    keepAliveInterval: number;
    setAutomaticReconnect: boolean;
    setLastWill?: {
      willTopic: string;
      willPayload: string;
      willQoS: number;
      setRetained: boolean;
    };
  });

`disconnect`

Voir les définitions de source pour le contrat actuel.

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

await MqttBridge.disconnect();

`subscribe`

Voir les définitions de source pour le contrat actuel.

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

await MqttBridge.subscribe({} as { topic: string; qos: number });

`publish`

Voir les définitions de source pour le contrat actuel.

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

await MqttBridge.publish({} as { topic: string; payload: string; qos: number; retained: boolean });

Référence de type

`onConnectionLostListener`

export type onConnectionLostListener = (x: { connectionStatus: string; reasonCode: number; message: string }) => void;

`onConnectCompleteListener`

export type onConnectCompleteListener = (x: { reconnected: boolean; serverURI: string }) => void;

`onMessageArrivedListener`

export type onMessageArrivedListener = (x: { topic: string; message: string }) => void;

Source de vérité

Cette page est générée à partir du plugin’s src/definitions.ts. Re-run the sync when the public API changes upstream.

Continuez de l'étape de démarrage

Si vous utilisez Démarrage pour planifier le tableau de bord et les opérations API, connectez-le avec En utilisant @capgo/capacitor-mqtt pour la capacité native dans En utilisant @capgo/capacitor-mqtt, Vue d'ensemble de API pour le détail d'implémentation dans Vue d'ensemble de API, Introduction pour le détail d'implémentation dans Introduction, Clés de API pour les détails d'implémentation dans les clés API et Appareils pour les détails d'implémentation dans Appareils.