IoT Platform:Connect to IoT Platform using MQTT.fx

Configure the MQTT.fx connection

1. Download and install MQTT.fx.
   This topic uses mqttfx-5.2.0-windows-x64 as an example. The actual UI may differ from the screenshots.

   Note Request a license for the MQTT.fx tool as required.
2. Open MQTT.fx. In the menu bar, click Extras and select Edit Connection Profiles.
3. On the Edit Connection Profiles page, configure the following parameters.
   1. Configure the basic information.

      Parameter	Description
      Profile Name	Enter a custom name, such as iot connection.
      Profile Type	For the ApsaraMQ for MQTT client connection, select MQTT Broker.
      Broker Address	MQTT connection domain. Use the value from the Prerequisites section: a1***.iot-as-mqtt.cn-shanghai.aliyuncs.com. a1*** is the ProductKey of the product in this example. cn-shanghai is the region in this example. Do not include the port number.
      Broker Port	Set this to 1883.
      Client ID	A protocol field of MQTT. Fixed format: ${ClientId}|securemode=${Mode},signmethod=${SignMethod}|timestamp=${timestamp}|. Enter the clientId value that you obtained in the Prerequisites section: a1***.device1|securemode=2,signmethod=hmacsha256,timestamp=2524608000000|. Parameter description: ${ClientId}: The client ID of the device, app, or web client. Important This value must be custom and within 64 characters in length. For a device, use its MAC address or serial number (SN). This helps you identify different devices. ${Mode}: The security mode. Valid values are 2 (TLS direct connection mode, which requires you to configure SSL/TLS settings) and 3 (TCP direct connection mode, which does not require you to configure SSL/TLS settings). ${SignMethod}: The algorithm type. Supported values are hmacsha256, hmacmd5, and hmacsha1. ${timestamp}: The current time in milliseconds. You can leave timestamp empty. In the connection parameters that are provided by IoT Platform, ${ClientId} defaults to a string that consists of ${ProductKey} + '.' + ${DeviceName}, ${Mode} defaults to 2, and ${SignMethod} defaults to hmacsha256. You can modify them as needed. Important Do not confuse the Client ID in MQTT.fx with the ${ClientId} of the device. Do not omit the vertical bars (|) between parameters or at the end of the string. When you set the parameters, make sure that no spaces exist in or around the parameter values. After you enter the Client ID, do not click Generate.
      General	Uses the default value. Adjust based on your requirements.

   2. Click User Credentials, select the Use Username/Password check box, and set User Name and Password.

      Parameter	Description
      User Name	Format: ${DeviceName}&${ProductKey}. Enter the username value that you obtained in the Prerequisites section: device1&a1***. device1 is the DeviceName of the device. a1*** is the ProductKey of the device.
      Password	Generated by encrypting concatenated parameters using the DeviceSecret and the selected signing method. Enter the passwd value that you obtained in the Prerequisites section: 86761***21d. Important In some MQTT.fx versions, the password string is not displayed after you paste it. If the cursor moves to the end of the text box, the paste was successful. Do not paste the password again. The parameters and their values are case-sensitive. Client IDIf you modify the ${ClientId} or ${SignMethod}Client ID settings in the Client ID, you must recalculate the password. Ensure that the new password uses values that match the updated parameters. For information about parameter settings and calculation methods, see Calculate a password using a Node.js script.

   3. For TLS direct connection mode (securemode=2), click SSL/TLS, select the Enable SSL/TLS check box, and set Protocol to TLSv1.2.
      Important For TCP direct connection mode (securemode=3), you do not need to configure SSL/TLS settings. Proceed to the next step.
4. After you finish the configuration, click OK in the lower-right corner.
5. Click Connect.
   A green light on the right indicates a successful connection.

   In the IoT Platform console, under the corresponding instance, choose Device Management > Devices. Select the product to view the status of the device. The device status should be Online.

The following sections describe how to test uplink and downlink communication using custom topics and TSL model topics. If your results differ from this example, the connection has failed. Correct the configuration based on the log information.

Communicate using custom topics

Uplink communication

1. In MQTT.fx, click Publish. In the Publish text box, enter a topic that has Publish permissions: /a1***/device1/user/update/error.
2. In the text editor pane, enter the message content, and then click Publish.

   In the Topic text box, enter a custom topic path, for example /${productKey}/${deviceName}/user/update/error. Set QoS to QoS 0. In the message editor pane, enter the test content, for example This is a publish test..

3. Log on to the IoT Platform console. On the Simple Log Service page of the instance, view the Device-to-Cloud Messages logs. Query IoT Platform logs.

   In the log list, click View Details for the target log entry to view the message Topic (such as /productKey/deviceName/user/update/error) and Content (such as This is a publish test.). A log status of 200 indicates that the message was sent successfully.

Downlink communication

1. In MQTT.fx, click Subscribe. In the Subscribe text box, enter a topic that has Subscribe permissions: /a1***/device1/user/get.
2. Click Subscribe.

   After the subscription is successful, the topic appears in the list.

3. Log on to the IoT Platform console. Under the instance, choose Device Management > Devices.
4. In the Actions column of the device, click View to go to the Device Details page.
5. Click the Topic List tab. In the Actions column of the subscribed topic, click Publish Message.
6. Enter the message content, for example, This is a test., and click OK.
7. Return to MQTT.fx to view the received message.

   In the Subscribe tab, the subscribed custom topic /${productKey}/device1/user/get has received 1 message. The message content is This is a test, QoS is 0, and Content Type is text/plain, indicating that the device message was successfully delivered via the custom topic and received by the client.

Communicate using TSL model topics

Device reports properties

1. In MQTT.fx, click Subscribe. In the Subscribe text box, enter a topic that has Subscribe permissions: /sys/a1****/device1/thing/event/property/post_reply.
2. In MQTT.fx, click Publish. In the Publish text box, enter a topic that has Publish permissions: /sys/a1****/device1/thing/event/property/post.
3. In the text editor pane, enter the property data that you want to report, and then click Publish.
   The reported property data must use standard Alink JSON format, as described in Device reports properties. This example reports data for the LightCurrent and LightSwitch properties.

   The Alink JSON message body includes method (set to thing.event.property.post), id, params (containing the property values of LightSwitch and LightCurrent), and version.

4. In MQTT.fx, click Subscribe to view the response message that IoT Platform returns to the device.
   The device successfully reported the properties.

   /sys/axxxxx/device1/thing/event/property/post_reply
   
   {"code":200,"data":{},"id":"162277852","message":"success","method":"thing.event.property.post","version":"1.0"}

5. Log on to the IoT Platform console. Under the instance, choose Device Management > Devices.
6. In the Actions column of the device, click View. On the Device Details page, click TSL Model Data to view the device data.

Set device properties

1. In MQTT.fx, click Subscribe. In the Subscribe text box, enter a topic that has Subscribe permissions: /sys/a1****/device1/thing/service/property/set.
2. Log on to the IoT Platform console. Under the instance, choose O&M > Online Debug.
3. Select the device to debug. On the Property Debugging tab, set Main Light Switch to Off-0.
4. Click Set to send the instruction.
5. In MQTT.fx, on the Subscribe tab, view the message that is received by the device.

   The following is an example of the received message:

   /sys/axxxxx/device1/thing/service/property/set
   
   {"method":"thing.service.property.set","id":"2016306076","params":{"LightSwitch":0},"version":"1.0.0"}

View logs

• Log on to the IoT Platform console. On the Simple Log Service page of the instance, view operational logs including time, TraceID, and business type. Query IoT Platform logs.
• In MQTT.fx, click Log to view operation logs and error logs. The following is an example of the log output:

  INFO --- MqttFX ClientModel           : messageArrived() with topic: /ext/error/axxx0/device1
  INFO --- PublishController             : publish
  INFO --- MqttFX ClientModel           : attempt to add PublishTopic
  INFO --- MqttFX ClientModel           : addPublishTopic : /a1xxx/device1/user/get
  INFO --- MqttFX ClientModel           : sucessfully published message test to topic /axxx/device1/user/g
  INFO --- PublishController             : publish
  INFO --- MqttFX ClientModel           : attempt to add PublishTopic
  INFO --- MqttFX ClientModel           : sucessfully published message test to topic /axxx/device1/user/g
  INFO --- PublishController             : publish
  INFO --- MqttFX ClientModel           : attempt to add PublishTopic
  INFO --- MqttFX ClientModel           : sucessfully published message test to topic /axxx/device1/user/g
  INFO --- BrokerConnectorController    : onDisconnect
  INFO --- ScriptsController            : Clear console.
  INFO --- MqttFX ClientModel           : Cancel script excution.
  INFO --- ScriptsController            : Clear console.
  INFO --- MqttFX ClientModel           : Cancel script excution.
  INFO --- ScriptsController            : Clear console.
  INFO --- ScriptsController            : Clear console.
  INFO --- BrokerConnectorController    : onConnect
  INFO --- ScriptsController            : Clear console.
  INFO --- MqttFX ClientModel           : MqttClient with ID a1xxx0.device1|securemode=2,signmethod=hmacsha
  INFO --- MqttFX ClientModel           : session present: false
  INFO --- SubscribeController          : onSubscribe
  INFO --- MqttFX ClientModel           : rebuildMessagesList()
  INFO --- MqttFX ClientModel           : attempt to addRecentSubscriptionTopic
  INFO --- MqttFX ClientModel           : addRecentSubscriptionTopic : de.jensd.mqttfx.entities.Topixxx1
  INFO --- MqttFX ClientModel           : attempt to add PublishTopic
  INFO --- MqttFX ClientModel           : addPublishTopic : /axxx/device1/user/get
  INFO --- MqttFX ClientModel           : sucessfully subscribed to topic /a1xxxSp0/device1/user/get (QoS 0)
  INFO --- MqttFX ClientModel           : messageArrived() with topic: /a1Kucxxx/device1/user/get
  INFO --- MqttFX ClientModel           : messageArrived() added: message #1 to topic '/axxx/device1/user/
  INFO --- PublishController             : publish
  INFO --- MqttFX ClientModel           : attempt to add PublishTopic
  INFO --- MqttFX ClientModel           : addPublishTopic : /a1xxx/device1/user/update/error
  INFO --- MqttFX ClientModel           : sucessfully published message This is a publish test. to topic /a1Kuc5