开始

安装

您可以使用我们的AI辅助设置来安装插件。将Capgo技能添加到您的AI工具中，使用以下命令:

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

然后使用以下提示:

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

如果您更喜欢手动设置，请运行以下命令并遵循以下平台特定的说明:

bun add @capgo/capacitor-mqtt
bunx cap sync

导入

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

API Overview

connect

查看当前协议的源定义

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

查看当前协议的源定义

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

await MqttBridge.disconnect();

subscribe

查看当前协议的源定义

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

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

publish

查看当前协议的源定义。

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

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

类型参考

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;

复制到剪贴板

本页面由插件生成 src/definitions.ts重新同步时，公共API上游发生变化。

继续从Getting Started

如果您正在使用 Getting Started 来规划仪表板和API操作，连接它到 使用@capgo/capacitor-mqtt 为native能力在使用@capgo/capacitor-mqtt中 为API概述 在API概述中实现详细信息 介绍 为《介绍》中实现细节 API Keys 为《API Keys》中实现细节,并 设备 为《设备》中实现细节。