开始使用

安装

您可以使用我们的 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上游发生变化时，请重新运行同步。

从开始入门继续

开始入门 规划仪表板和__CAPGO_KEEP_0__操作，请将其与 使用@API/__CAPGO_KEEP_1__-mqtt Using @capgo/capacitor-mqtt 为使用 @capgo/capacitor-mqtt 的原生能力, API 概述 为 API 概述 的实现细节, 介绍 为介绍 的实现细节, API 密钥 为 API 密钥 的实现细节, 和 设备 为设备 的实现细节。