IoT Platform:Especificaciones del protocolo MQTT

Funciones compatibles

Cómo utilizarlas

Session expiry

• Establezca Clean Start y Session Expiry Interval al conectarse:

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

• Establezca Session Expiry Interval al desconectarse:

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

Message expiry

Establezca Message Expiry Interval al publicar:

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

Subscription options

Opciones de suscripción disponibles:

• QoS: Nivel de QoS del mensaje MQTT. Establézcalo en 0 (mensaje QoS 0) o 1 (mensaje QoS 1).

• No Local: Especifica si el cliente recibe los mensajes que publica.

  En MQTT 3.1.1, un cliente recibe sus propios mensajes publicados en los temas suscritos. En MQTT 5.0, establezca esta opción en true para evitar la autoentrega.

  Valores:

  • true: No recibe.

  • false: Recibe.

• Retain As Publish: Especifica si el servidor conserva la marca RETAIN al reenviar un mensaje a un cliente.

  Valores:

  • true: Si el mensaje tiene una marca RETAIN, dicha marca se conserva. Si el mensaje no tiene una marca RETAIN, esta opción no surte efecto.

  • false: La marca RETAIN no se conserva, independientemente de si el mensaje original la incluye.

  Importante

  La configuración de Retain As Publish no afecta la marca RETAIN en los mensajes retenidos.

• Retain Handling: Especifica si el servidor envía mensajes retenidos al cliente cuando se establece una suscripción.

  Valores:

  • 0: El servidor envía mensajes retenidos siempre que la suscripción del cliente sea exitosa.

  • 1: El servidor envía mensajes retenidos solo si la suscripción del cliente es exitosa y la suscripción no existía previamente.

  • 2: El servidor no envía mensajes retenidos incluso si la suscripción del cliente es exitosa.

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

Retained message

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

Will message

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

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

Después de que un dispositivo se conecta mediante MQTT 5.0, los datos de UserProperty reportados son visibles en los registros de IoT Platform.

Request-response pattern

Si el solicitante es un dispositivo y el receptor es su servidor empresarial, analice sintácticamente ResponseTopic y CorrelationData de las propiedades del mensaje después de la suscripción AMQP o el reenvío por reglas. Luego, invoque la operación de API Pub para responder al dispositivo.

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

Enhanced error codes

Troubleshoot errors.

Topic alias

No aplica.

Shared subscriptions

Formato de tema de suscripción compartida: $share/${ShareName}/${filter}.

• $share: Campo estático. El tema para una suscripción compartida debe comenzar con $share.

• ${ShareName}: Cadena que contiene únicamente letras, dígitos y guiones bajos (_).

  Las sesiones con el mismo ${ShareName} comparten una sola suscripción. Cada mensaje coincidente se entrega a una única sesión.

• ${filter}: Filtro de tema en una suscripción no compartida. Admite letras, dígitos y guiones bajos (_).

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