Einstieg

Installieren

Sie können unsere AI-gestützte Einrichtung verwenden, um das Plugin zu installieren. Fügen Sie die Capgo-Fähigkeiten Ihrem AI-Tool hinzu, indem Sie die folgende Befehlszeile verwenden:

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

Dann verwenden Sie die folgende Anfrage:

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

Wenn Sie die manuelle Einrichtung bevorzugen, installieren Sie das Plugin, indem Sie die folgenden Befehle ausführen und die unten aufgeführten plattform-spezifischen Anweisungen befolgen:

bun add @capgo/capacitor-mqtt
bunx cap sync

Importieren

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

API Übersicht

connect

Siehe die Quelldefinitionen für den aktuellen Vertrag.

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

Siehe die Quelldefinitionen für den aktuellen Vertrag.

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

await MqttBridge.disconnect();

subscribe

Siehe die Quelldefinitionen für den aktuellen Vertrag.

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

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

publish

Siehe die Quellendefinitionen für den aktuellen Vertrag.

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

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

Typenreferenz

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;

Quelle der Wahrheit

Diese Seite wurde aus dem Plugin generiert. src/definitions.tsWiederholen Sie die Synchronisierung, wenn die öffentliche API upstream geändert wird.

Fortsetzen Sie mit dem Anfängerleitfaden

Wenn Sie das Plugin verwenden Anfängerleitfaden um einen Dashboard und API-Plan zu erstellen, verbinden Sie es mit Verwenden Sie @capgo/capacitor-mqtt zur nativen Fähigkeit in Verwenden Sie @capgo/capacitor-mqtt, API-Übersicht zur Implementierungsdetail in API-Übersicht, Einleitung zur Implementierungsdetail in Einleitung, API Schlüssel zur Implementierungsdetail in API Schlüssel, und Geräte zur Implementierungsdetail in Geräte.