Aller au contenu principal
@capgo/capacitor-mqtt Communication Open source

MQTT Plugin Capacitor

Support MQTT pour la messagerie en temps réel sur iOS, Android et Web.

Installer

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

Guide

Comment utiliser MQTT dans Capacitor

Tester sur l'appareil

Téléchargez l'application Capgo, puis scannez le QR code.

QR d'aperçu du plugin MQTT code

Utilisation de @capgo/capacitor-mqtt

Plugin Capacitor pour la connectivité MQTT sur Android et iOS.

Installer

bun add @capgo/capacitor-mqtt
bunx cap sync

bunx cap sync copie le code natif du plugin dans vos projets natifs. Relancez-l’après chaque mise à jour du plugin.

Importer

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

Aperçu de API

Méthode Description
connect Consultez les définitions source pour le comportement actuel.
disconnect Consultez les définitions source pour le comportement actuel.
subscribe Consultez les définitions source pour le comportement actuel.
publish Consultez les définitions source pour le comportement actuel.

Exemples

connect()

Consultez la référence API pour le contrat actuel.

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()

Consultez la référence API pour le contrat actuel.

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

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

subscribe()

Consultez la référence API pour le contrat actuel.

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

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

publish()

Consultez la référence API pour le contrat actuel.

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

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

Écouter les événements

addListener renvoie un handle. Appelez handle.remove() lorsque l'écran est démonté.

Référence complète

Continuer avec l'utilisation de @capgo/capacitor-mqtt

Si vous utilisez Utilisation de @capgo/capacitor-mqtt pour planifier le travail sur les plugins natifs, connectez-l’à @capgo/capacitor-mqtt pour les détails d'implémentation dans @capgo/capacitor-mqtt, Prise en main pour les détails d'implémentation dans Getting Started Capgo Répertoire des plugins pour le workflow produit dans Capgo Plugin Directory, Plugins Capacitor par Capgo pour les détails d'implémentation dans les plugins Capacitor par Capgo, et Ajouter ou mettre à jour des plugins pour les détails d'implémentation dans Adding or Updating Plugins.

FAQ

FAQ du plugin MQTT

Comment installer le plugin MQTT dans une application Capacitor ?

Exécutez "bun add @capgo/capacitor-mqtt" (ou "npm install @capgo/capacitor-mqtt"), puis lancez "bunx cap sync" pour que les projets iOS et Android prennent en compte le code natif. Importez-le depuis "@capgo/capacitor-mqtt" dans votre code.

Est-ce que @capgo/capacitor-mqtt fonctionne avec React, Vue et Angular ?

Oui. MQTT est un package Capacitor, il fonctionne donc avec n'importe quel framework web tournant sous Capacitor, y compris Ionic, React, Vue, Angular, Svelte et le JavaScript pur.

Quelle version de Capacitor est supportée par @capgo/capacitor-mqtt ?

Les plugins Capgo suivent la version majeure de Capacitor : utilisez la version majeure du plugin qui correspond à la version majeure de votre Capacitor (par exemple le plugin v8 avec Capacitor 8). Le tableau de compatibilité du README de GitHub recense les versions maintenues.

Est-ce que @capgo/capacitor-mqtt est gratuit et open source ?

Oui. Le code source de code est public sur GitHub à l'adresse https://github.com/Cap-go/capacitor-mqtt/ et le package est gratuit à installer via npm. Les rapports de bugs et les pull requests sont les bienvenus.

Puis-je mettre à jour code utilisant MQTT sans passer par une revue de l'App Store ?

L'installation ou la mise à jour du plugin modifie le code natif, ce qui impose un nouveau build pour les stores. Ensuite, les changements JavaScript, HTML et CSS qui appellent le plugin peuvent être livrés instantanément via les live updates de Capgo.

Déployez vos changements MQTT sans attendre la validation de l'app

Une fois le plugin intégré à votre build de store, Capgo live updates déploie vos changements JavaScript, HTML et CSS aux utilisateurs en quelques minutes.

Commencez avec Capgo