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

Situation

A data point of an INSYS Smart Device 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 Smart Device to DATABOOM in regular intervals.

DATABOOM configuration

It is prerequisite that you have a DATABOOM account.

  1. Open the DATABOOM website using a browser:

  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 Smart Device

    • 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 Smart Device as Description and click on Add OAuth. [1]

  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. [2]

  14. In the MQTT section, click on the copy symbol () behind ClientID to copy the client ID to the clipboard. [3]

  15. In the MQTT section, click on the copy symbol () behind Topics where publish data to copy the topic to the clipboard. [2]

  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. [2]

icom Data Suite configuration

It is prerequisite that you have access to the web interface of the icom Data Suite. The Smart Device 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 [5]

  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. [6]

    • Password: Paste your OAuth token from the clipboard here. [7]

    • Client ID : Paste your Client ID from the clipboard here. [8]

  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. [9]

    • Message: Enter the message in the following JSON format:
      {
      "type": "data",
      "message": {
      "device": "<device token>", [10]
      "date": "$TIMESTAMP ", [11]
      "signals" : [
      {
      "name": "<signal token>", [12]
      "value": "$timer2 " [13]
      }
      ]
      }
      }

    • Retain:

    • QoS: 0

  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. [14]

  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.

Back to the Configuration Guides for the icom Data Suite

Back to overview

1. This creates an OAuth token that will be used for credentials for accessing the MQTT broker later.
2. This will be used for creating the MQTT message later.
3. This will be used for credentials for accessing the MQTT broker later.
4. This IP address and host name only apply in case of a standard default installation.
5. A transmission interval below one minute does not make sense since DATABOOM accepts only one message per minute at the moment.
6. Your user name is displayed in your DATABOOM profile ().
7. Copy the OAuth token from DATABOOM as described under DATABOOM configuration above.
8. Copy the Client ID from DATABOOM as described under DATABOOM configuration above.
9. Copy the topic from DATABOOM as described under DATABOOM configuration above.
10. Copy the device token from DATABOOM as described under DATABOOM configuration above.
11. The blank behind the variable is essential.
12. Copy the signal token from DATABOOM as described under DATABOOM configuration above.
13. The blank behind the variable is essential.
14. Validation of a value ensures that the user does not use the value while being unaware that the value might need a correction.