Getting Started

复制一个包含安装步骤和完整 Markdown 指南的设置提示。

        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.

安装

您可以使用我们的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 介绍

`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 用于在使用 @capgo/capacitor-mqtt 中的本机功能 API Overview 用于在 API Overview 中的实现细节介绍为 "Introduction" 中的实现细节 API 键为 "API Keys" 中的实现细节, 和设备为 "Devices" 中的实现细节