Scribd
Upload
255 views

Getting Started Guide Create A Freeboard - Io Dashboard With Live Objects

This document provides instructions for creating a dashboard using Freeboard.io to visualize data from Live Objects. It explains how to create a Freeboard account, add Live Objects data sources for MQTT and LoRa devices by generating URLs, and build widgets to display and visualize the device data on the dashboard.

Uploaded by

iskandar saleh
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
255 views

Getting Started Guide Create A Freeboard - Io Dashboard With Live Objects

This document provides instructions for creating a dashboard using Freeboard.io to visualize data from Live Objects. It explains how to create a Freeboard account, add Live Objects data sources for MQTT and LoRa devices by generating URLs, and build widgets to display and visualize the device data on the dashboard.

Uploaded by

iskandar saleh
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
You are on page 1/ 8

Getting Started Guide

Create a Freeboard.io dashboard with Live Objects

Freeboard.io is an open source dashboard project with optional hosted


subscriptions, easy to integrate with various data sources, ready for
production and very well designed.

Freeboard being a dashboard, then Live Objects can serve as an API


for data sources.

Let's move on to practice.

1
1- Go to www.freeboard.io

2- Create a free account


Freeboard has two types of account, paying and 30-days free
accounts. The free version is enough for test and POCs (but note that
your dashboard will be public in read only mode)

A small form appears to succeed this step. After login we can create
our Dashboard.

2
3- Create data source
This is where Live Objects comes in. We draw our data via the Live
Objects API.

a) b- How to add a source for MQTT devices


In Datasources, we click on ADD to add a new data source.
We can have a form you will have to fill in as the following:

Fig. Adding a datasource

• In type, choose JSON.

• In name, enter the name you want.

• In method, choose GET.

• In Headers, enter name ="X-API-KEY"' ; in Value enter an API


key on your account with the accurate rights.

• In URL, enter the URL generated as follow:

3
In Live Objects, go to "Data" section
If your MQTT device was already connected to Live Objects you can
see a line as this in "Data" section.

Copy the stream value (here android359775656557129) and paste it


to replace ZZZZZ in the following URL
https://liveobjects.orange-
business.com/api/v0/data/streams/ZZZZZ?limit=1
You will have a URL like this one
https://liveobjects.orange-
business.com/api/v0/data/streams/android359775656557129?limit=1
and copy paste it in the URL field.

4
b- How to add a source for LoRa® devices
In Datasource, we click on ADD to add a new data source. We can
have a form you will have to fill in as the following:

• In type, choose JSON.

• In name, enter the name you want.

• In method, choose GET.

• In Headers, enter name ="X-API-KEY"' ; in Value enter an API


key on your account with the accurate rights.

• In URL, enter the URL generated as follow:


In Live Objects, go to "Data" section
If your LoRa device was already connected to Live Objects you can
see a line as this in "Data" section.

5
Copy the stream value (here urn:lora:0018B200000021F5!uplink)
and paste it to replace ZZZZZ in the following URL
https://liveobjects.orange-
business.com/api/v0/data/streams/ZZZZZ?limit=1
You will have a URL like this one
https://liveobjects.orange-
business.com/api/v0/data/streams/urn:lora:0018B200000021F5!uplin
k?limit=1
and copy paste it in the URL field.

6
4- Create widgets
To add widgets, you need first add a pane

Then in a pane, you could add one or several widgets clicking on the
+

You can use for instance: Google Map, Text, Gauge, Sparkline,
Indicator Light.

In the widget you will have several fields. You will have to select the
source you have just created and which contains the data you want to
display.

Click on datasource and explore the structure of the json


to get a value as this one.

First select the "datasource" with the wished data, then "[0]" to get the
last data known by Live Objects, then "value" field in which you find
the device payload, finally select the field you want to display.

7
Add several widgets from several sources and you can get a
dashboard as this one :

This dashboard can be shared with the SHARE button at the bottom
right.

You might also like