跳过主要内容

MQTT Capacitor插件

MQTT支持实时消息传递

安装

bun add @capgo/capacitor-mqtt bunx cap sync
npm、pnpm或yarn
  • npm install @capgo/capacitor-mqtt
  • pnpm add @capgo/capacitor-mqtt
  • yarn add @capgo/capacitor-mqtt

指南

如何在Capacitor中使用MQTT

在设备上测试

下载Capgo应用,扫描QR code

MQTT插件预览QR code

使用@capgo/capacitor-mqtt

Capacitor MQTT插件,支持Android和iOS设备的MQTT连接

安装

bun add @capgo/capacitor-mqtt
bunx cap sync

bunx cap sync 将插件的本地code复制到您的本地项目中。每次升级插件后,请再次运行它。

导入

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

API概览

方法 描述
connect 查看源定义以了解当前行为。
disconnect 查看源定义以了解当前行为。
subscribe 查看源定义以了解当前行为。
publish 查看源定义以了解当前行为。

示例

connect()

查看API参考以了解当前约束。

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

const result = await MqttBridge.connect({
  serverURI: 'https://example.com',
  port: 8080,
  clientId: 'client-id-123',
  username: 'username',
  password: 'password',
  setCleanSession: true,
  connectionTimeout: 1000,
  keepAliveInterval: 1000,
  setAutomaticReconnect: true,
});
console.log(result);

disconnect()

查看API参考以了解当前约束。

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

const result = await MqttBridge.disconnect();
console.log(result);

subscribe()

查看 API 的参考文档以获取当前合同。

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

const result = await MqttBridge.subscribe({
  topic: 'topic',
  qos: 1,
});
console.log(result);

publish()

查看 API 的参考文档以获取当前合同。

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

const result = await MqttBridge.publish({
  topic: 'topic',
  payload: 'payload',
  qos: 1,
  retained: true,
});
console.log(result);

监听事件

addListener 返回一个句柄。调用 handle.remove() 当屏幕卸载时

完整参考

继续使用 @capgo/capacitor-mqtt

如果您正在使用 @capgo/capacitor-mqtt 为了规划原生插件的工作,连接它与 @capgo/capacitor-mqtt 在 @capgo/capacitor-mqtt 中了解实现细节 开始使用 在开始使用中了解实现细节 @Capgo 插件目录 了解 @Capgo 插件目录中的产品工作流程 @Capacitor 由 @Capgo 提供的插件 了解 @Capacitor 由 @Capgo 提供的插件的实现细节,并 添加或更新插件 在添加或更新插件中了解实现细节。

常见问题

MQTT插件常见问题

如何在Capacitor应用中安装MQTT插件?

Run "bun add @capgo/capacitor-mqtt" (or "npm install @capgo/capacitor-mqtt"), then run "bunx cap sync" so the iOS and Android projects pick up the native code. Import it from "@capgo/capacitor-mqtt" in your app code.

是否支持 @capgo/capacitor-mqtt 与 React、Vue 和 Angular 一起使用?

是。MQTT 是一个 Capacitor 包,因此它可以与任何在 Capacitor 内部运行的 Web 框架一起使用,包括 Ionic、React、Vue、Angular、Svelte 和普通 JavaScript。

哪个 Capacitor 版本支持 @capgo/capacitor-mqtt?

Capgo 插件遵循 Capacitor 的主要版本:使用与您的 Capacitor 主要版本匹配的插件主要版本(例如插件 v8 与 Capacitor 8)。在 GitHub README 中的兼容性表格中列出了维护的版本。

是否支持 @capgo/capacitor-mqtt 免费和开源?

Yes. The source code is public on GitHub at https://github.com/Cap-go/capacitor-mqtt/ and the package is free to install from npm. Bug reports and pull requests are welcome.

是否可以在不经过 App Store 审核的情况下更新使用 MQTT 的 code?

安装或升级插件会更改本地 code,因此需要一个新的商店构建。之后,JavaScript、HTML 和 CSS 的更改可以立即通过 Capgo 的实时更新发布。

无需等待应用程序审查即可将 MQTT 更改推送到生产环境

一旦插件在您的商店构建中,Capgo 即刻将您的 JavaScript、HTML 和 CSS 更改推送给用户

从 Capgo 开始