Pular al contenido principal
@capgo/capacitor-mqtt Comunicación Fuente abierta

MQTT plugin de Capacitor

Soporte de MQTT para mensajería en tiempo real en iOS, Android y Web.

Instalar

bun add @capgo/capacitor-mqtt bunx cap sync
npm, pnpm o yarn
  • npm install @capgo/capacitor-mqtt
  • pnpm add @capgo/capacitor-mqtt
  • yarn add @capgo/capacitor-mqtt

Guía

Cómo usar MQTT en Capacitor

Probar en dispositivo

Descargue la aplicación Capgo, luego escane el código QR code.

Vista previa del plugin MQTT QR code

Usando @capgo/capacitor-mqtt

Capacitor plugin para conectividad MQTT en Android e iOS.

Instalar

bun add @capgo/capacitor-mqtt
bunx cap sync

bunx cap sync Copia el plugin nativo code en tus proyectos nativos. Correlo nuevamente después de cada actualización del plugin.

Importar

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

Vista general de API

Método Descripción
connect Consulte las definiciones de origen para el comportamiento actual.
disconnect Consulte las definiciones de origen para el comportamiento actual.
subscribe Consulte las definiciones de origen para el comportamiento actual.
publish Consulte las definiciones de origen para el comportamiento actual.

Ejemplos

connect()

Consulte la referencia de API 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 la referencia de API para el contrato actual.

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

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

subscribe()

Consulte la referencia de API para el contrato actual.

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

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

publish()

Consulte la referencia de API 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);

Escuchar eventos

addListener devuelve un manejador. Llamar handle.remove() cuando la pantalla se desmonta.

Referencia completa

Sigue adelante desde Usando @capgo/capacitor-mqtt

Si estás utilizando Usando @capgo/capacitor-mqtt para planificar el trabajo de plugin nativo, conecta con @capgo/capacitor-mqtt para obtener detalles de implementación en @capgo/capacitor-mqtt Inicio rápido para los detalles de implementación en Getting Started, Directorio de Plugins Capgo para el flujo de trabajo del producto en Directorio de Plugins Capgo, Plugins de Capacitor por Capgo para los detalles de implementación en Plugins de Capacitor por Capgo, y Agregar o Actualizar Plugins para los detalles de implementación en Agregar o Actualizar Plugins.

FAQ

Preguntas frecuentes del plugin MQTT

¿Cómo instalo el plugin MQTT en una aplicación Capacitor?

Ejecuta "bun add @capgo/capacitor-mqtt" (o "npm install @capgo/capacitor-mqtt"), luego ejecuta "bunx cap sync" para que los proyectos iOS y Android capturen el proyecto nativo code. Importa desde "@capgo/capacitor-mqtt" en tu aplicación code.

¿Funciona @capgo/capacitor-mqtt con React, Vue y Angular?

Sí. MQTT es un paquete Capacitor, por lo que funciona con cualquier framework web que se ejecute dentro de Capacitor, incluyendo Ionic, React, Vue, Angular, Svelte y JavaScript puro.

¿Qué versión de Capacitor admite @capgo/capacitor-mqtt?

Los plugins Capgo siguen la versión mayor de Capacitor: utilice la versión mayor del plugin que coincida con la versión mayor de su Capacitor (por ejemplo, el plugin v8 con Capacitor 8). La tabla de compatibilidad en el README del GitHub lista las versiones mantenidas.

¿Es capgo/capacitor-mqtt gratuito y de código abierto?

Sí. El código fuente de code está disponible en GitHub en https://github.com/Cap-go/capacitor-mqtt/ y el paquete es gratuito para instalar desde npm. Se aceptan informes de errores y solicitudes de cambios.

Puedo actualizar code que utiliza MQTT sin una revisión de la Tienda?

Instalar o actualizar el plugin cambia el code nativo, por lo que necesita una nueva compilación de la tienda. Después de eso, los cambios de JavaScript, HTML y CSS que llaman al plugin pueden enviar con Capgo actualizaciones en vivo.

Envía cambios MQTT sin esperar a la revisión de la aplicación

Una vez que el plugin esté en su tienda de construcción, Capgo actualiza en vivo tus cambios de JavaScript, HTML y CSS a los usuarios en minutos.

Comienza con Capgo