시작하기

설치

AI-Assisted Setup으로 플러그인을 설치할 수 있습니다. 다음 명령어로 AI 도구에 Capgo 스킬을 추가하세요:

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.

수동 설정을 선호한다면, 다음 명령어를 실행하여 플러그인을 설치하고 아래의 플랫폼별 지침을 따르세요:

npm install @capgo/capacitor-mqtt
npx cap sync

가져오기

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

빠른 시작

TLS로 연결하고 자동 재연결을 활성화한 다음, 백엔드에서 발행하는 telemetry 토픽을 구독하세요.

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

await MqttBridge.connect({
  serverURI: 'ssl://broker.example.com',
  port: 8883,
  clientId: 'cap-app-1',
  username: 'device-user',
  password: 'device-secret',
  setCleanSession: true,
  connectionTimeout: 30,
  keepAliveInterval: 60,
  setAutomaticReconnect: true,
});
await MqttBridge.subscribe({ topic: 'devices/telemetry', qos: 1 });

자주 하는 실수

• TLS: 일치 serverURI 브로커 요구 사항에 맞는 스킴을 사용하세요.
• 백그라운드: Android가 WebView를 일시 중단한 후 재연결합니다.
• QoS: QoS가 높을수록 셀룰러 연결 시 배터리 소모가 커집니다.

API 개요

connect

현재 contract의 소스 정의를 확인하세요.

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

현재 contract의 소스 정의를 확인하세요.

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

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

subscribe

현재 contract의 소스 정의를 확인하세요.

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

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

publish

현재 contract의 소스 정의를 확인하세요.

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

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

타입 레퍼런스

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;

Source of Truth

이 페이지는 플러그인의 src/definitions.tsupstream에서 public API가 변경되면 sync를 다시 실행하세요.

시작하기 다음 단계

사용 중이라면 시작하기 대시보드 및 API 운영을 계획하려면, 이를 다음과 연결하세요 @capgo/capacitor-mqtt 사용하기 @capgo/capacitor-mqtt를 사용하여 네이티브 기능을 구현할 때, API 개요 구현 세부 사항은 API 개요에서 소개 구현 세부 사항은 소개에서 API 키 API Keys의 구현 세부 사항 및 기기 Devices의 구현 세부 사항을 확인하세요.