IoT Platform:Spécifications du protocole MQTT

Fonctionnalités prises en charge

Utilisation

Expiration de session

• Définissez Clean Start et Session Expiry Interval lors de la connexion :

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

• Définissez Session Expiry Interval lors de la déconnexion :

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

Expiration de message

Définissez Message Expiry Interval lors de la publication :

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

// Create a message.
MqttMessage message = new MqttMessage(payload);
// Set the QoS for the message.
message.setQos(1);

MqttProperties mqttProperties = new MqttProperties();

// Set the message time-to-live (TTL).
mqttProperties.setMessageExpiryInterval(600L);

message.setProperties(mqttProperties);

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

Options d'abonnement

Options d'abonnement disponibles :

• QoS : Niveau de QoS du message MQTT. Définissez-le sur 0 (message QoS 0) ou 1 (message QoS 1).

• No Local : Indique si le client reçoit les messages qu'il publie lui-même.

  Dans MQTT 3.1.1, un client reçoit ses propres messages publiés sur les topics auxquels il est abonné. Dans MQTT 5.0, définissez cette option sur true pour empêcher la livraison à soi-même.

  Valeurs :

  • true : Ne reçoit pas.

  • false : Reçoit.

• Retain As Publish : Indique si le serveur conserve l'indicateur RETAIN lorsqu'il transfère un message à un client.

  Valeurs :

  • true : Si le message possède un indicateur RETAIN, celui-ci est conservé. Si le message ne possède pas d'indicateur RETAIN, cette option n'a aucun effet.

  • false : L'indicateur RETAIN n'est pas conservé, que le message original en possède un ou non.

  Important

  Le paramètre Retain As Publish n'affecte pas l'indicateur RETAIN dans les messages conservés.

• Retain Handling : Indique si le serveur envoie les messages conservés au client lors de l'établissement d'un abonnement.

  Valeurs :

  • 0 : Le serveur envoie les messages conservés tant que l'abonnement du client aboutit.

  • 1 : Le serveur envoie les messages conservés uniquement si l'abonnement du client aboutit et si l'abonnement n'existait pas auparavant.

  • 2 : Le serveur n'envoie pas les messages conservés, même si l'abonnement du client aboutit.

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

// Set the QoS subscription option.
mqttSubscription.setQos(1);

// Set the No Local subscription option.
mqttSubscription.setNoLocal(true);

// Set the Retain As Published subscription option.
mqttSubscription.setRetainAsPublished(true);

// Set the Retain Handling subscription option.
mqttSubscription.setRetainHandling(1);

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

Message conservé

// Create a retained message.
String content = "Hello World";
byte[] payload = content.getBytes();
MqttMessage message = new MqttMessage(payload);
// Set the message as a retained message.
message.setRetained(true);

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

Message testamentaire

// Create a 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());

// Set the will message.
options.setWill(topic, message);

// Set the will delay.
MqttProperties willMessageProperties = new MqttProperties();
willMessageProperties.setWillDelayInterval(60L);
options.setWillMessageProperties(willMessageProperties);

// Establish a connection.
MqttClient mqttClient = new MqttClient(host, clientId, new MemoryPersistence());
mqttClient.connect(options);

Négociation de connexion

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

Propriété utilisateur

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

Après la connexion d'un appareil via MQTT 5.0, les données UserProperty rapportées sont visibles dans les journaux d'IoT Platform.

Modèle requête-réponse

Si le demandeur est un appareil et le destinataire est votre serveur métier, analysez ResponseTopic et CorrelationData à partir des propriétés du message après l'abonnement AMQP ou le transfert de règle. Appelez ensuite l'opération API Pub pour répondre à l'appareil.

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

Codes d'erreur améliorés

Résolution des erreurs.

Alias de topic

Non applicable.

Abonnements partagés

Format du topic d'abonnement partagé : $share/${ShareName}/${filter}.

• $share : Champ statique. Le topic d'un abonnement partagé doit commencer par $share.

• ${ShareName} : Chaîne contenant uniquement des lettres, des chiffres et des traits de soulignement (_).

  Les sessions ayant le même ${ShareName} partagent un seul abonnement. Chaque message correspondant est remis à une seule session.

• ${filter} : Filtre de topic dans un abonnement non partagé. Il prend en charge les lettres, les chiffres et les traits de soulignement (_).

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