Per iniziare

Installa

Puoi usare il nostro setup assistito dall'IA per installare il plugin. Aggiungi le skill Capgo al tuo strumento di IA usando il seguente comando:

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

Poi usa il seguente prompt:

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

Se preferisci la configurazione manuale, installa il plugin eseguendo questi comandi e segui le istruzioni specifiche per piattaforma qui sotto:

npm install @capgo/capacitor-mqtt
npx cap sync

Importa

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

Avvio rapido

Connettiti via TLS, abilita il riconnetti automatico e iscriviti al topic di telemetria pubblicato dal tuo backend.

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

await MqttBridge.connect({
  serverURI: 'ssl://broker.example.com',
  port: 8883,
  clientId: 'cap-app-1',
  username: 'device-user',
  password: 'device-secret',
  setCleanSession: true,
  connectionTimeout: 30,
  keepAliveInterval: 60,
  setAutomaticReconnect: true,
});
await MqttBridge.subscribe({ topic: 'devices/telemetry', qos: 1 });

Errori comuni

• TLS: corrisponde a serverURI lo scheme richiesto dal broker.
• Background: riconnessione dopo la sospensione della WebView su Android.
• QoS: un QoS più elevato consuma più batteria su connessioni cellulari.

Panoramica API

connect

Consulta le definizioni sorgente 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

Consulta le definizioni sorgente per il contratto corrente.

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

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

subscribe

Consulta le definizioni sorgente per il contratto corrente.

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

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

publish

Consulta le definizioni sorgente 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 ai tipi

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 src/definitions.ts. Riesegui la sync quando il API pubblico cambia upstream.

Continua da Getting Started

Se stai usando Per iniziare per pianificare le operazioni della dashboard e di API, collegalo a Utilizzo di @capgo/capacitor-mqtt per la funzionalità nativa in Utilizzo di @capgo/capacitor-mqtt, Panoramica API per i dettagli di implementazione in Panoramica di API, Introduzione per i dettagli di implementazione in Introduzione, Chiavi API per i dettagli di implementazione in Chiavi API, e Dispositivi per i dettagli di implementazione in Dispositivi.