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.

Installare

Puoi utilizzare la nostra configurazione assistita dall'IA per installare il plugin. Aggiungi le Capgo competenze al tuo strumento di AI utilizzando il seguente comando:

npx skills add https://github.com/Cap-go/capgo-skills --skill capacitor-plugins

Usa quindi la seguente richiesta:

Use the `capacitor-plugins` skill from `Cap-go/capgo-skills` to install the `@capgo/capacitor-mqtt` plugin in my project.

Se preferisci l'installazione manuale, installa il plugin eseguendo i seguenti comandi e segui le istruzioni specifiche per la piattaforma riportate di seguito:

bun add @capgo/capacitor-mqtt
bunx cap sync

Importa

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

API Panoramica

`connect`

Vedi le definizioni di origine per il contratto corrente.

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`

Vedi le definizioni di riferimento per il contratto corrente.

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

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

`subscribe`

Vedi le definizioni di riferimento per il contratto corrente.

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

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

`publish`

Vedi le definizioni di riferimento per il contratto corrente.

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

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

Riferimento al 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’s src/definitions.tsRiscrivi la sincronizzazione quando il pubblico API cambia in modo upstream.

Continua da Getting Started

If sei stai utilizzando Avvio rapido per pianificare dashboard e API operazioni, connettilo con Utilizza @capgo/capacitor-mqtt per la capacità nativa in Utilizza @capgo/capacitor-mqtt, API Overview per i dettagli di implementazione in API Overview, Introduzione per i dettagli di implementazione in Introduzione, Tasti API per i dettagli di implementazione in API Keys, e Dispositivi per i dettagli di implementazione nei dispositivi.