Configuring PODS‑MQTT interface - BWS500

BWS500 Upgrade Guide

Document code
M213032EN
Revision
B
Language
English
Product
BWS500
Document type
User guide
These steps are only needed if you want to send observations and status information to a customer data collection system.

You can configure the BWS500 PODS‑MQTT (Point Observations and Device State over Message Queuing Telemetry Transport) interface for data reporting. Enable the interface in the configuration and configure the certificate, username and password, and the MQTT broker address for the interface.

The interface has 2 MQTT clients:

  • mqtt_client_1: Sends the observations and device (station) information.
  • mqtt_client_2: Sends the measurements, device (station) information, and device status. To receive the measurements, enable MQTT_MEASUREMENTS for MQTT_1. Device status is always sent when mqtt_client_2 is configured.
  1. In the Web UI, go to Settings > Station parameters.
  2. Under the parameter group features, set the Active value to on for the parameter MQTT_1, if not already done.
  3. Enable the kind of observations that you want.
    • MQTT_OBSERVATIONS: Send observations that have been derived from the measurements given by the sensors
    • MQTT_MEASUREMENTS: Send measurements that are given directly by the sensors
    • STATION_STATUS: Send device (station) status information
  4. To save the changes and take them into use, select Save and restart script.
    When the script has restarted, refresh the browser to get the changes visible.
  5. Under the parameter group mqtt_client_1, configure the connection to the data collection system.
    brokerURL
    The URL of the MQTT broker in the format mqtt(s)://<URL>:<port>. Using mqtts:// enables encryption. If the port is not specified, the default port is used (1883 for MQTT, 8883 for MQTTS).
    customCA
    Custom PEM-encoded Certificate Authority (CA) web server certificate for validating the server. Paste the certificate text in the field. If the field is empty, the system default CAs are used.
    username
    The username for basic MQTT authentication. If the field is empty, credentials-based authentication is disabled.
    password
    The password for basic MQTT authentication.

    You can also change the quality of service (QoS) level, publishing interval, and other settings for the interface in the station parameters.

  6. Configure mqtt_client_2.

    Always configure both MQTT clients. If you have only one MQTT broker, configure both with exactly the same values.

  7. To save the changes and take them into use, select Save and restart script.
    When the script has restarted, refresh the browser to get the changes visible.
  8. Go to Configuration > Debug console, and check that there are no errors.