Contents x
    DATABOOM: Registering and Sending a Value
    • 12 Sep 2024
    • Print
    • PDF
    Contents

    DATABOOM: Registering and Sending a Value

    • Updated on 12 Sep 2024
    • Print
    • PDF
    Article summary

    The icom Data Suite allows to send data to the DATABOOM cloud service from an INSYS router.

    Situation

    A data point of an INSYS router is to be monitored by the icom Data Suite and its value is to be sent to DATABOOM cloud service.

    Solution

    The following simple exemplary application transmits the count of an timer of an INSYS router to DATABOOM in regular intervals.

    DATABOOM configuration

    It is prerequisite that you have a DATABOOM account.

    1. Open the DATABOOM website:

    2. Log in to your DATABOOM account.

    3. Click on the globe icon on the top and select your language.

    4. Click on DEVICES in the menu on the left and select Add device:

      • Device type: MQTT

      • Description: INSYS router

      • Complete the device definition as desired.

    5. Go down to the just opened MQTT section, enter databoom in the Projects field and specify the topic information:

      • Topic where publish data: data

      • Topic where it’s possible to receive information from Databoom: info

    6. Click on Save.

    7. Click on SIGNALS in the menu on the left and select Add signal:

      • Device: select above added device

      • Type: select an appropriate type, e.g. Other

      • Description: signal

    8. Click on Save.

    9. Click on SETTINGS in the menu on the left and select Credentials.

    10. In the OAuth keys section, enter INSYS router as Description and click on Add OAuth to create an OAuth token that will be used for credentials for accessing the MQTT broker later.

    11. Click on the copy symbol () to copy the OAuth token to the clipboard.

    12. Click on DEVICES in the menu on the left and click on the device added above.

    13. In the INFO section, click on the copy symbol () behind Token to copy the device token to the clipboard to create the MQTT message later.

    14. In the MQTT section, click on the copy symbol () behind ClientID to copy the client ID to the clipboard for the credentials for accessing the MQTT broker later.

    15. In the MQTT section, click on the copy symbol () behind Topics where publish data to copy the topic to the clipboard to create the MQTT message later.

    16. Click on SIGNALS in the menu on the left and click on the signal added above.

    17. In the Signal info section, click on the copy symbol () behind Token to copy the signal token to the clipboard to create the MQTT message later.

    icom Data Suite configuration

    It is prerequisite that you have access to the web interface of the icom Data Suite. The router must have Internet connection.

    1. Open another browser tab or window and start the web interface of the icom Data Suite:

    2. In the Data points → Timer menu, add a new timer () and edit it ():

      • Description: Message timer

      • Type: Interval, triggered every 1 minute

        Please note!

        A transmission interval below one minute does not make sense since DATABOOM accepts only one message per minute at the moment.

    3. Click on Save settings.

    4. In the Data points → Timer menu, add a new timer () and edit it ():

      • Description: Count sample timer

      • Type: Interval, triggered every 13 seconds

    5. Click on Save settings.

    6. In the Messages → MQTT menu, add a new broker () and edit it ():

      • Description: DATABOOM

      • Server: mqtt.databoom.com

      • Port: 1883

      • Version: v3.1

      • User name: enter your DATABOOM user name (displayed in your DATABOOM profile )

      • Password: paste your OAuth token from the clipboard here (copy as described above)

      • Client ID : paste your Client ID from the clipboard here (copy as described above)

    7. Click on Save settings.

    8. In the Messages → MQTT menu, add a new message () and edit it ():

      • Description: Signal message

      • Topic: paste your topic from the clipboard here (copy as described above)

      • Message: enter the message in the following JSON format:

        {
 "type": "data",
 "message": {
    "device": "<device token>", 
    "date": "$TIMESTAMP ", 
    "signals" : [
      {
        "name": "<signal token>", 
        "value": "$timer2 " 
      }
    ]
  }
 }

      • Retain:

      • QoS: 0

        Please note!

        Copy the device and signal token as described above.

        The blank behind the variables "$TIMESTAMP " and "$timer2 " is essential.

    9. Click on Save settings.

    10. In the Events menu, add a new event () and edit it ():

      • Description: Send signal message to DATABOOM

      • Event: Timer expired

      • Timer: select above added timer1 - Message timer

      • Action: Send message

      • Send message: select above added signal message

    11. Click on Save settings.

    12. Activate the profile ().

    13. Change back to the DATABOOM browser tab or window.

    14. Click on SIGNALS in the menu on the left and select the signal added before.

    15. Click on Edit.

    16. Click on Validate in the validation message appearing now and confirm the validation.

      Please note!

      Validation of a value ensures that the user does not use the value while being unaware that the value might need a correction.

    17. Click on Save.

    You’ll now see the count of the data point timer2 as a curve over time.

    Troubleshooting

    • If the icom Data Suite cannot connect to the DATABOOM MQTT broker, check the configuration of the MQTT broker.

    • If the icom Data Suite can connect to the DATABOOM MQTT broker, but DATABOOM does not receive signal data, check the following:

      • The topic of the message must be in the form databoom/<device token>/data as described above. Replace <device token> by the token string without the angular brackets.

      • The blank behind the variables (like behind $TIMESTAMP) and before the comma is important. A missing blank causes that the message will not be valid.

    Was this article helpful?
    What's Next