Getting Started

GitHub

Copie una línea de comando de configuración con los pasos de instalación y la guía de markdown completa para este 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.

Instalar

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

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

Luego utilice la siguiente solicitud:

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 Resumen

`connect`

Consulte 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 });

Tipo de Referencia

`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 del plugin’s src/definitions.ts. Re-rerun the sync when the public API changes upstream.

Sigue adelante desde Getting Started

Si estás utilizando Getting Started para planificar la consola de dashboard 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 los detalles de implementación en API Claves, y Dispositivos para los detalles de implementación en Dispositivos.