Inicio

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 prefieres la configuración manual, instala el complemento ejecutando los siguientes comandos y sigue 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 Resumen

connect

Ver las definiciones de origen para el contrato actual.

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

Consulte las definiciones de origen para el contrato actual.

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

await MqttBridge.disconnect();

subscribe

Consulte las definiciones de origen para el contrato actual.

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

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

publish

Consulte las definiciones de origen para el contrato actual.

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

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

Referencia de tipos

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 desde el plugin’s src/definitions.tsRe-ruta la sincronización cuando el público API cambia en la fuente

Sigue adelante desde Getting Started

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