Getting Started

Copia un prompt di configurazione con i passaggi di installazione e la guida markdown completa per questo 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.

Installazione

bun add @capgo/capacitor-mqtt
bunx cap sync

Importazione

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

API Panoramica

`connect`

Vedi le definizioni di origine per il contratto corrente.

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`

Vedi le definizioni di origine per il contratto corrente.

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

await MqttBridge.disconnect();

`subscribe`

Vedi le definizioni di origine per il contratto corrente.

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

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

`publish`

Vedi le definizioni di origine per il contratto corrente.

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

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

Riferimento di tipo

`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;

Fonte di verità

Questa pagina è generata dal plugin. src/definitions.tsRiavvia la sincronizzazione quando i dati pubblici API cambiano in fase di sviluppo.

Continua da Getting Started

Se stai utilizzando Getting Started per pianificare dashboard e API operazioni, connettilo con Usando @capgo/capacitor-mqtt per la capacità nativa in Usando @capgo/capacitor-mqtt, Panoramica di API per i dettagli di implementazione in Panoramica di API, Introduzione per i dettagli di implementazione in Introduzione, Chiavi di API per i dettagli di implementazione in API Chiavi, e Dispositivi per i dettagli di implementazione in Dispositivi.