IoT Platform:Spesifikasi protokol MQTT

Fitur yang didukung

Cara penggunaan

Session expiry

• Atur Clean Start dan Session Expiry Interval saat koneksi:

  MqttConnectionOptions options = new MqttConnectionOptions();
  options.setCleanStart(true);
  options.setSessionExpiryInterval(60L);// Satuan: detik.
  
  MqttClient mqttClient = new MqttClient(host, clientId, new MemoryPersistence());
  mqttClient.connect(options);

• Atur Session Expiry Interval saat disconnect:

  MqttProperties mqttProperties = new MqttProperties();
  mqttProperties.setSessionExpiryInterval(60L);// Satuan: detik.
  
  MqttAsyncClient mqttAsyncClient = new MqttAsyncClient(host, clientId, new MemoryPersistence());
  mqttAsyncClient.disconnect(30000, null, null, MqttReturnCode.RETURN_CODE_SUCCESS, mqttProperties);

Message expiry

Atur Message Expiry Interval saat memublikasikan:

IntervalString content = "Hello World";
byte[] payload = content.getBytes();

// Buat pesan.
MqttMessage message = new MqttMessage(payload);
// Atur QoS untuk pesan.
message.setQos(1);

MqttProperties mqttProperties = new MqttProperties();

// Atur waktu hidup (TTL) pesan.
mqttProperties.setMessageExpiryInterval(600L);

message.setProperties(mqttProperties);

// Publikasikan pesan.
MqttClient mqttClient = new MqttClient(host, clientId, new MemoryPersistence());
mqttClient.publish(topic, message);

Subscription options

Opsi langganan yang tersedia:

• QoS: Level QoS pesan MQTT. Anda dapat mengaturnya ke 0 (pesan QoS 0) atau 1 (pesan QoS 1).

• No Local: Menentukan apakah klien menerima pesan yang dipublikasikannya sendiri.

  Pada MQTT 3.1.1, klien menerima pesan yang dipublikasikannya sendiri pada topik yang dilanggani. Pada MQTT 5.0, atur opsi ini ke true untuk mencegah pengiriman ke diri sendiri.

  Nilai:

  • true: Tidak menerima.

  • false: Menerima.

• Retain As Publish: Menentukan apakah server mempertahankan flag RETAIN saat meneruskan pesan ke klien.

  Nilai:

  • true: Jika pesan memiliki flag RETAIN, flag tersebut dipertahankan. Jika pesan tidak memiliki flag RETAIN, opsi ini tidak berpengaruh.

  • false: Flag RETAIN tidak dipertahankan, terlepas dari apakah pesan asli memiliki flag tersebut atau tidak.

  Penting

  Pengaturan Retain As Publish tidak memengaruhi flag RETAIN pada retained message.

• Retain Handling: Menentukan apakah server mengirim retained message ke klien saat langganan dibuat.

  Nilai:

  • 0: Server mengirim retained message selama langganan klien berhasil.

  • 1: Server mengirim retained message hanya jika langganan klien berhasil dan langganan tersebut sebelumnya belum ada.

  • 2: Server tidak mengirim retained message meskipun langganan klien berhasil.

MqttSubscription mqttSubscription = new MqttSubscription("aaa/bbb");

// Atur opsi langganan QoS.
mqttSubscription.setQos(1);

// Atur opsi langganan No Local.
mqttSubscription.setNoLocal(true);

// Atur opsi langganan Retain As Published.
mqttSubscription.setRetainAsPublished(true);

// Atur opsi langganan Retain Handling.
mqttSubscription.setRetainHandling(1);

MqttClient mqttClient = new MqttClient(host, clientId, new MemoryPersistence());
mqttClient.subscribe(new MqttSubscription[]{mqttSubscription});

Retained message

// Buat retained message.
String content = "Hello World";
byte[] payload = content.getBytes();
MqttMessage message = new MqttMessage(payload);
// Tandai pesan sebagai retained message.
message.setRetained(true);

// Publikasikan pesan.
MqttClient mqttClient = new MqttClient(host, clientId, new MemoryPersistence());
mqttClient.publish(topic, message);

Will message

// Buat will message.
String content = "Will Message";
byte[] payload = content.getBytes();
MqttMessage message = new MqttMessage(payload);

MqttConnectionOptions options = new MqttConnectionOptions();
options.setUserName(USERNAME);
options.setPassword(PASSWORD.getBytes());

// Atur will message.
options.setWill(topic, message);

// Atur penundaan will.
MqttProperties willMessageProperties = new MqttProperties();
willMessageProperties.setWillDelayInterval(60L);
options.setWillMessageProperties(willMessageProperties);

// Lakukan koneksi.
MqttClient mqttClient = new MqttClient(host, clientId, new MemoryPersistence());
mqttClient.connect(options);

Connection negotiation

MqttConnectionOptions connOpts = new MqttConnectionOptions();
connOpts.setMaximumPacketSize(1024L);

User property

MqttProperties properties = new MqttProperties();
List<UserProperty> userPropertys = new ArrayList<>();
userPropertys.add(new UserProperty("key1","value1"));
properties.setUserProperties(userPropertys);

Setelah perangkat terhubung melalui MQTT 5.0, data UserProperty yang dilaporkan akan terlihat di log Platform IoT.

Request-response pattern

Jika peminta adalah perangkat dan penerima adalah server bisnis Anda, uraikan ResponseTopic dan CorrelationData dari properti pesan setelah langganan AMQP atau penerusan aturan. Kemudian panggil operasi API Pub untuk merespons perangkat.

MqttProperties properties = new MqttProperties();
properties.setCorrelationData("requestId12345".getBytes());
properties.setResponseTopic("/" + productKey + "/" + deviceName + "/user/get");

Enhanced error codes

Pemecahan masalah error.

Topic alias

Tidak berlaku.

Shared subscriptions

Format topik shared subscription: $share/${ShareName}/${filter}.

• $share: Bidang statis. Topik untuk shared subscription harus diawali dengan $share.

• ${ShareName}: String yang hanya berisi huruf, angka, dan garis bawah (_).

  Sesi dengan ${ShareName} yang sama berbagi satu langganan. Setiap pesan yang sesuai dikirimkan hanya ke satu sesi.

• ${filter}: Filter topik dalam langganan non-shared. Mendukung huruf, angka, dan garis bawah (_).

MqttConnectionOptions options = new MqttConnectionOptions();
options.setUserName(username);
options.setPassword(password);

MqttClient mqttClient = new MqttClient(host, clientId, new MemoryPersistence());
mqttClient.connect(options);

mqttClient.subscribe("$share/testGroup/user/post", 1);