Getting Started

1. Install the package

   npm

   npm i @capgo/capacitor-mqtt

   pnpm

   pnpm add @capgo/capacitor-mqtt

   yarn

   yarn add @capgo/capacitor-mqtt

   bun

   bun add @capgo/capacitor-mqtt

2. Sync with native projects

   npm

   npx cap sync

   pnpm

   pnpm cap sync

   yarn

   yarn cap sync

   bun

   bunx cap sync

Usage

Import the plugin and connect to an MQTT broker:

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

await CapacitorMqtt.connect({
  brokerUrl: 'wss://broker.hivemq.com:8884/mqtt',
  clientId: `device-${Date.now()}`,
});

await CapacitorMqtt.subscribe({ topic: 'myapp/events', qos: 1 });

await CapacitorMqtt.publish({
  topic: 'myapp/events',
  message: 'hello from app',
  qos: 1,
});

API Reference

connect(options)

Connect to an MQTT broker.

interface ConnectOptions {
  brokerUrl: string;
  clientId: string;
  username?: string;
  password?: string;
  cleanSession?: boolean;
  keepAliveInterval?: number;
}

await CapacitorMqtt.connect({
  brokerUrl: 'wss://broker.hivemq.com:8884/mqtt',
  clientId: 'my-client-id',
});

subscribe(options)

Subscribe to a topic.

await CapacitorMqtt.subscribe({
  topic: 'myapp/events',
  qos: 1,
});

publish(options)

Publish to a topic.

await CapacitorMqtt.publish({
  topic: 'myapp/commands',
  message: JSON.stringify({ command: 'ping' }),
  qos: 1,
});

addListener()

Listen for incoming messages.

const listener = await CapacitorMqtt.addListener('onMessage', (payload) => {
  console.log(payload.topic, payload.message);
});

disconnect()

Disconnect from the broker.

await CapacitorMqtt.disconnect();