SORACOM Developers

SORACOM Lagoon Getting Started

Create a dashboard using SORACOM Lagoon

This document explains the way to visualize SORACOM Lagoon (hereinafter referred to as Lagoon) data using user consoles.

Below are procedures to obtain, using an API, data visualized through integration of Lagoon and Harvest and dash device data saved in the cloud. The way to visualize data on user consoles will also be explained.

There are 3 steps between setup operation check and cleanup.

Below are the preconditions required for the steps explained in this guide.

Step 1: Start using Lagoon

Lagoon can be started immediately after being enabled in the settings. On the SORACOM user console, login using the root account and click “SORACOM Lagoon” on the side menu.

Note
You cannot start Lagoon as a SAM user. Make sure to use the root account.

Lagoon-dashboard

Enable Lagoon

Click “Start SORACOM Lagoon”.

Lagoon-dashboard

Set password. This password is the password required when logging into Lagoon using the root account email address on the SORACOM console.

Lagoon-dashboard

Login to Lagoon

Login to Lagoon using the root account and choose dashboard settings. Click the “Access SORACOM Lagoon” button.

Lagoon-dashboard

Login using the operator account email address and the password set previously.

Lagoon-dashboard

After completing these steps, you will be able to start Lagoon and login.

Step 2: Create dashboard on Lagoon

Create dashboard

Create dashboard. Firstly, click the + button create a dashboard.

Lagoon-dashboard

A dashboard is created under the name “New dashboard” and the panel selection screen will be displayed. Select Graph from the panel to create.

Lagoon-dashboard

An empty graph panel will be created. Click “Edit” from the pull down menu on the top of the panel.

Lagoon-dashboard

Lagoon-dashboard

In the “Metrics” tab, enter information of the line/device that you want to visualize in a graph. In this example, we will store the JSON information like room temperatures, humidities, and discomfort indices in Harvest.

{"temp":27.2,"humi":43.0,"heat":73.8}

The graph will be displayed after entering the type of resource used, the line/device, and the data.

Lagoon-dashboard

You can see 2 types of lines. Let’s set the title and label the axes to make it easy-to-read.

Firstly, set the title on the “General” tab.

Lagoon-dashboard

Set the axes labels on the “Axes” tab. Make the left axis temperature (℃) and the left axis humidity (%).

Lagoon-dashboard

On the “Display” tab, set the display settings of the two axes. Select “Series override” on the left and this time, select “Y-axis:2” using the key of the humidity data you want to display and the + button.

Lagoon-dashboard

This may be just a small detail but the legend for temp and humi are too far away from each other. In the “Legend” tab, you can tick the checkbox to display the table to move the legend to the bottom left and create a table. By clicking on the legend on the dashboard, you can switch the graph drawing on/off. With this, it will still be easy-to-read even if the number of data types increases.

Lagoon-dashboard

The graph panel is completed after completing the steps above. Return to dashboard by clicking the Return button on the top right corner. Save the dashboard with the desired name using the Save button on the top right corner.

Lagoon-dashboard

After completing the steps above, the dashboard will be created and saved on Lagoon.

Publish dashboard

Next, let’s publish the dashboard. Click the “Publish dashboard” button on the top right corner to obtain an URL.

Lagoon-dashboard

Return to SORACOM console screen and create a dashboard user. Set Lagoon user access, email addresses, and passwords using the “+Add User” button.

Lagoon-dashboard

Lagoon-dashboard

The login page will be displayed again if you access the URL obtained previously. *You may remain logged in if you use the same browser. In this case, please clear cache or try logging in using a different browser.

Lagoon-dashboard

You will be able to see the dashboard created earlier by entering the Lagoon user email address and password added previously.

After completing the steps above, the dashboard will be created and saved on Lagoon.

This time, we only created and published a simple graph. You can also create panels with maps and tables as Lagoon has been developing these based on OSS Grafana. Make sure to try different ones and find your preferred dashboard.

Lagoon-dashboard

Getting Started

SORACOM Air for Cellular

SORACOM Air for Sigfox

SORACOM Beam

SORACOM Canal/Direct/Door

SORACOM Endorse

SORACOM Funnel

SORACOM Gate

SORACOM Harvest

SORACOM Inventory

SORACOM Junction

SORACOM Krypton

SORACOM Lagoon

Service Detail

Developer Tools

pagetop