Getting Started

Instalar

Puede utilizar nuestra configuración asistida por IA para instalar el plugin. Agregue las Capgo habilidades a su herramienta de IA utilizando el siguiente comando:

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

Luego utilice el siguiente prompt:

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

Si prefiere la configuración manual, instale el plugin ejecutando los siguientes comandos y siguiendo las instrucciones específicas de la plataforma a continuación:

bun add @capgo/capacitor-mqtt
bunx cap sync

Importar

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

API Introducción

connect

Consulte las definiciones de origen para el contrato actual.

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

Consulte las definiciones de origen para el contrato actual.

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

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

subscribe

Consulte las definiciones de origen para el contrato actual.

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

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

publish

Consulte las definiciones de origen para el contrato actual.

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

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

Referencia de 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;

Fuente de Verdad

Esta página se genera a partir de la extensión del plugin src/definitions.tsRe-ejecuta la sincronización cuando los cambios públicos API cambian en la fuente

Sigue adelante desde Inicio

Si estás utilizando Getting Started para planificar la consola y API operaciones, conecta con Usando @capgo/capacitor-mqtt para la capacidad nativa en Usando @capgo/capacitor-mqtt, API Resumen para el detalle de implementación en API Resumen, Introducción para el detalle de implementación en Introducción, API Claves para el detalle de implementación en API Claves, y Dispositivos para el detalle de implementación en Dispositivos.