OIZOM Terminal | User Guide

RAD19UG05

Oizom Instruments Pvt. Ltd.

306, Indraprasth Corporate, Anand Nagar, Ahmedabad - 380015 - India
[email protected] | +91-8866660083/25
ABOUT THIS DOCUMENT
This document is a step by step guide to get familiar with the interface of Oizom Data
Terminal and explains in detail how to use the Oizom Web Terminal with all the
modules. This will help you get familiarized with every little feature of the Terminal Web
Application as well as how to interpret the data.

REVISION HISTORY

Revision Date Created Checked Approved Comments

Number

V1 14/12/2017 PP NM SP Created

V2 29/06/2019 YG NM SP New Features

V3 12/08/2019 NV YG SP New Features

V4 05/01/2021 NV New Features

V5 15/09/2021 NV New Features

1
Table Of Contents

1.0 User Login

4

2.0 Overview 4
2.1 Specifications of the Overview Module 4
2.2 Download 6
2.3 Support 7

3.0 Dashboard 8
3.1 Features of Dashboard 9

4.0 Cluster 10
4.1 Features of Cluster 10

5.0 Reports 13
5.1 Features of Reports 13

6.0 Analytics 15
6.1 Features of the Analytics module 16
6.1.1 Parameter Comparison 16
6.1.2 Device Comparison 16
6.1.2 Pollution Rose 17
6.2 Typical Comparison View 18

7.0 Alerts 19

8.0 Display 21

9.0 Heat Map 23

10.0 Devices 23

11.0 Integration 24

12.0 Automation 25
12.1 Adding a new configuration 25

13.0 User 26
13.1 Adding a new user 28

14.0 Mobile Application 29

14.1 Android 29
14.2 iOS 30

2
1.0 User Login
1. Oizom Terminal is a Web-application to
visualize and analyze the data from the
device. It can be accessed from any
browser. To go to Oizom Terminal,
type in your browser:
https://terminal.oizom.com and hit
Enter.

2. You will see a sign-in screen. Enter

your assigned email ID and password, which will be given to you by one of
the Oizom representatives. Then click on SIGN IN.

Note: This document has all the modules of Terminal, but when you see a lock

beside the Module in your terminal it means that it is

currently out of scope of the project. You can get it by contacting the
information provided in it.

3
2.0 Overview
After successfully logging into the Terminal with your account, the Overview
screen is displayed. Overview Module provides you with a Birds’ Eye View of the
Oizom devices as well as the Real-time Air Quality Index along with data of
various parameters. The Oizom devices are Geo-mapped on the Device Location
Map with Device Info for a quick look.

2.1 Specifications of the Overview Module

1. Device: To filter the devices by name, use this filter. Select Device Name
from the Drop Down Menu. The data will change accordingly. You can also
see the Device type if more than one type of device is registered like
Dustroid, Polludrone ,Weathercom etc. From this dropdown you may toggle
between different device types.
2. Pins: There are various types of pin indications for different devices. These
pins indicate Oizom devices. By clicking on the pin you can view quick
information of that device like Device ID , Name , Location , Photo and device
status. These are 3rd party data pins. Data from 3rd party platforms can be
integrated in Oizom platform , once that is done user you can visualize and
analyse the 3rd party device data on Oizom platform. Also these pins show
complains of that location. With the help of Oizom complain collecting APIs ,
data from other platforms can be integrated here and the complains can be
showcased on Terminal. You will see more about complains in the complain
module. Also you can show and hide complains from the top right corner of
the map. A traffic layer is added to the mpa view to correlate the data of
traffic and environmental pollution. It can be toggled on and off from top
right corner.

4
3. Real-time Parameters’ data: On clicking the pin, the user can also see the
real-time data of each parameter of the device right below the map. The
parameters are colour coded for better understanding of the data.

4. Table view button: Clicking on this button brings you to the table view of
the devices. The parameters are colour-coded in table view also for better
understanding.
a. Table view shows device name, last updated time,date, data of all
the parameters in tabular form. This view helps you access
multiple devices’ data in a single view.

5. Index Button: Clicking on this button brings you to the table view of the
devices with last 24 hour average data. The dropdown is used to toggle
between different device types. Table view shows the 24 hour average of
all the parameters and it helps to view 24 hour average data of multiple
devices in a single table. Also Date and Time selection is provided to check
the past data.

5
2.2 Download
From the download button on the top-right corner users can download data
directly and SLA report.

1. Data download :
1. Select Device: Users can select the device from all lists of devices.
2. Select Hourly Average: User can select from 1-hour avg, 8-hour avg
and 24-hour avg.

3. Start Date: Select start date

4. End Date : Select end date.
Then click on the Download button. A csv file of the selected date range
and device will be downloaded.

2. SLA Report Download:

Here SLA report is a representation of up time and efficiency of all
devices. It is displayed in percentage format. SLA report is available in
Daily, Monthly and Weekly timelines.

6
 1. Select Type : User can select from the Daily, Weekly and Monthly
report types.

2. Start Date : Select start date.

Click on the download button to download the SLA report in pdf
format.

2.3 Support
From the support icon user will be redirected to our Customer Support portal.
Users can easily raise tickets related to their queries. Click on the support icon
from the top right corner.

Now the user will be redirected to the Customer Support portal. Following are
the fields of the ticket form.
1. Email ID : Mention your email address.
2. Subject : Mention the actual issue in short, if any specific Device or
location is known mention it here.

7
 3. Issue/Query : Provide the description of your issue.

After filling in the complete details click on the submit button. Your ticket
will be generated and email of the same will be generated along with
ticket ID for future reference.

If you don't see this Submit ticket form make sure you are registered with
your email ID or you may contact us.

3.0 Dashboard
Dashboard is a complete visualization module for you to analyse the
environmental data from the device. Dashboard allows users to visualize the
environmental data with interactive charts. Average Air Quality Index (AQI) and
other parameters are displayed in hourly average and in real-time.

8
3.1 Features of Dashboard

1. Device (Drop down menu): User can select the device using the Devices
drop-down menu and access real-time data for the same in a graphical
manner. Both bar and line graphs can be seen side by side.
2. Select a parameter: Users can change the parameters and view a graph of
the real-time data for the selected parameter. The graph is depicted as a
selected parameter against Time.
3. Refresh Dashboard: By clicking the Refresh button the whole page gets
refreshed to sync the latest data.
4. Change Chart Type: User can toggle between chart types for each individual
chart.
5. Table View: On clicking of the Table Button user can see data in a list.
Average AQI, time and parameters are shown in a list with its colour code.
a. By default, list view shows an hourly average of the last 24 hours.
b. Device: Select a Device for which you wish to see the data from the
Device drop-down menu.
c. Select date range: To access the data of a specific period of days, you can
select the range of the date by entering a Start date and End date in
Select Data Range option.
d. Select Average type: You can view the data in our predefined hourly
averages by selecting the Average Type ie, hourly, 8 hourly or 24 hourly
(daily).
e. Download Data: The data for the selected range can be downloaded by
clicking the download button. The .CSV file will automatically start
downloading on your PC.
f. Refresh button: Refresh the button every time you want the latest
updated data.

9
4.0 Cluster
Cluster module lets you group specific devices and can display an average of
your selected devices data and shows in eye catching map view and tabular
view.This feature makes it easy to analyze the overall environmental status.
Cluster is completely customizable at the user level. Also Cluster data can be
downloaded.

4.1 Features of Cluster

1. Cluster Drop-down: User can select cluster from the dropdown menu
and view all average data in map and table view.
2. Add a new Cluster: User can add multiple cluster on the basis of their
requirement.
There are two ways to add a new cluster.
(i) Select Devices

10
 a. Cluster Label: Give an appropriate cluster label.
b. Select Devices: User can select multiple devices for any cluster.
c. Select AQI Index: Select relevant AQI index.
d. Description: User can provide a description for the created Cluster.

Then submit to create a new cluster. Relevant data will be updated in the
main cluster screen. Cluster created using this option will be shaped as a
circle covering all the selected devices. In order to create a customized
shape for the cluster, use the following option.
(ii) Select Area
1. Select Area: Choose option Select Area
2. Cluster Label:Give an appropriate cluster label.
3. Draw Area: In order to draw an area, put the cursor on the map, a
small + icon will be shown. Click once to select the starting point of
the area on the map. Draw the complete shape covering all the
required devices and at last connect the shape at the starting
point of the cluster.The devices which will be included inside the
drawing area will be added automatically.
4. Select AQI Index: Select required AQI index.

11
 Provide a description for the same and then submit it to create the
cluster.
3. Pin: This is the pin for the selected cluster which shows HAQI of that
particular cluster.
4. Table: This shows real-time data of your cluster in tabular format. If there
are multiple clusters then all the clusters will be shown.

5. Data: This tab is to see cluster data in detailed view.

a. By default, list view shows an hourly average of the last 24 hours.

b. Cluster: Select the cluster label for which you wish to see the data
from the drop-down menu.
c. Select date range: To access the data of a specific period of days,
you can select the range of the date by entering a Start date and
End date in Select Data Range option.
d. Select Average type: You can view the data in our predefined
hourly averages by selecting the Average Type ie, hourly, 8 hourly
or 24 hourly (daily).
e. Download Data: The data for the selected range can be
downloaded by clicking the download button. The .CSV file will
automatically start downloading on your PC.

12
5.0 Reports
Reports module lets you control the automated report generation for each
device. Users can choose to receive automated environmental data reports Daily,
Weekly or Monthly. These are the print-ready reports with interactive charts and
analysis. You can set the frequency of the reports i.e. Daily, Monthly and/or

Weekly by clicking the turn on/off button. The button will turn Green to depict it
is in ON state. Reports will be automatically sent to the defined Email IDs in the
selected frequency only.

5.1 Features of Reports

1. Allow report access: Click the icon below the Report Access, to add all the
email IDs you wish to receive the automated reports.
2. Add email IDs: Enter the Email ID in the Blank space and click Add. You can
add maximum 5 email IDs to send automated reports, daily or weekly or
monthly. You can also remove the receiving email IDs by clicking on Delete
(Trash icon).

13
3. Quick Report: You can also generate the report manually for a specific date
using the Quick Report option.

First select the type of report: Daily, Weekly or Monthly. After selecting the type
of report, you can select the start date and click on the Generate button to create
a report for the specific time period as required.

14
 The report can either be Downloaded by clicking on the Download button or
emailed to the desired email address directly from the Terminal.

6.0 Analytics
Each environmental gas reacts differently to a particular set of gases. Looking at
the emission inventories from different sources, it is concluded that the
environmental parameters are interdependent. For example, Ozone (O3) is
produced in the troposphere as a result of a complex set of reactions that
involve volatile organic compounds (VOCs) and oxides of nitrogen (NOx). Thus, O3
and NOx emissions are proportional.

15
6.1 Features of the Analytics module
Analytics module enables you to review comprehensive analysis of
environmental data. It empowers the user to compare data in three different
methods:
1. Parameter comparison
2. Device comparison
3. Pollution rose

6.1.1 Parameter Comparison

User is able to compare multiple parameters of one device for the selected time
period. Steps to follow for the comparison of parameters:

1. In Select Analytics type,select Parameter

Comparison.

2. Select the device and parameters which

are to be compared. Maximum of 10 parameters can be compared at a
time.

3. Select the range of date during which you want to analyse the data.

6.1.2 Device Comparison

User can select multiple devices to compare a single parameter for the selected
time period. Steps to follow for the comparison of multiple devices:

16
 1. In Select Analytics type,select Device Comparison.

2. Select the Device Type and devices which are to be compared. Maximum
of 10 devices can be compared, select the parameter which is to be
compared.

3. Select the date range.

6.1.2 Pollution Rose

User will be able to compare multiple devices for a single parameter for a
particular time period. User can also check hourly, daily and weekly phenomena.

1. In Select Analytics
type,select Pollution Rose.

2. Select device and parameter which are to be compared.

17
 3. Select Date Range.

6.2 Typical Comparison View

1. Selected Device(s): Displays the selected device for analysis

2. Selected Parameter: Display the selected parameter or parameters.
3. Time: Display of selected time duration.
4. Edit: User can edit the analytics specifications like change or removal of
parameter(s), change of date range, change or removal of device(s).
5. Save and Rename: User can save and rename the analytics chart.
6. Chart Type: User can change chart type from the available option line,
area, column and area spline.
7. Time: User can change time between 1 hour avg, 8 hour avg and 24 hour
avg.

18
7.0 Alerts
Alerts Module provides alerts to the user for added specific conditions.

1. Devices: Select devices from a list of devices to view that device’s alert.
2. Notification Type: Filter using 1 hour, 8 hours or 24 hour alerts.
3. Start Date: Filter to check past alerts of any device, select the start date.
4. End Date: Select the end date then click on the Submit button this will
give alert notifications according to the provided input.
5. Alert Configuration: Contains saved configuration for alerts.

a. Add Alert: Set threshold values for selected parameters.Each

parameter can be set to different values in 3 variations 1 hour avg, 8
hour avg and 24 hour avg. Alerts will be generated if the device data
goes above the threshold values entered by the user. For e.g. if the
threshold values are entered as per the given below image, users will
get alerts whenever the hourly avg value of AQI, UVI and Temp goes
above 300, 6 and 35 respectively.

19
6. Alert Setting: Settings for Alerts (ex: Enable/Disable, Email, SMS)

20
8.0 Display

1. Display Name: On clicking on display name, the user will be able to see the
list of added screens & get the option to preview it.
a. Preview: It shows a preview of all the screens added for that display in full
screen view.
b. Add New Screen: Opens form for adding a new screen in that display.

2. Embedded Link: Embedded link

provides Iframe code for display
configuration.
a. COPY Iframe Code: It will copy the
HTML code for a display to the clipboard.
b. Open In New Tab: This will redirect to the display in a new tab.

3. Delete Screen: Used to delete entire display screen.

4. Add Screen or Display: Used to add new display & also used for add screen
in existing display.

21
a. Select Display Label: Select Display or Add new Display from selection.

b. Select Screen Type: Select screen type for display from given options
(Average AQI screen, Parameter Screen, AQI Comparison Screen).

c. Screen Information: Fill

screen’s information like
screen title, list of devices
etc.

22
9.0 Heat Map
Heat Map shows the pollution level of any city using Artificial Intelligence &
Machine Learning.

10.0 Devices
Devices shows all your registered devices in a single screen.

1. Device Id: Device Id of the device.

2. Label: Device label.
3. Location: Device location.
4. Edit Device Info: Used to edit devices information like device name, position
or other info. The user also set device location by clicking on the map.

23
 5. Data Interval : User can select and update the data interval rate of each
device as per the requirement. Users can select from 2mins, 5 mins , 10 mins
etc options provided in the dropdown.

6. Enable/ Disable: This feature will be available only for the admin user, They
can enable or disable the device as required. Disable device option will hide
that device from the device list in the whole terminal. No other user will be
able to see that particular device.This option does not remove the device
from the terminal.It can not be turned off.

11.0 Integration
Here API Integration is used for seamless communication with third party tools.
API enables interaction between data, applications, and devices.
1. Credentials: In this credential section Client ID and secret for your
organization is provided.
a. Download Postman collection: Here downloadable postman
collection of API’s is provided and can be implemented at the
user's end.
b. Download Swagger Collection: Similarly swagger collection of API’s
is given.
c. Try it on Cloud: Similar cloud version is provided.

24
12.0 Automation
Automation module can be used to toggle a relay-based switch, of an external
equipment. On the basis of the threshold value, provided in the configuration,
the oizom device can switch on/off the assigned equipment. For example, a Dust
Suppression Cannon can be toggled On or Off, if the values of the parameter
PM2.5/PM10 goes beyond a configured parameter threshold value set in this
module. Users can create their desired configuration, as per parameters
available in oizom devices.

12.1 Adding a new configuration

The first step is to add a configuration for the device. Users can add multiple
configurations on the selected device.

25
 1. Select the device from the dropdown from the left top corner for which
you wish to add configuration.
2. Click on plus sign to add a new configuration.

Output : Choose the Output type from the dropdown.

Based on : Choose the relevant parameter on the basis you want to

automate the device. All the device parameters are provided in the
dropdown.

Default : Choose the default to be ON or OFF.

Value (greater than) : Enter the desired value and then from the
dropdown choose ON or OFF.

Value (less than) : Enter the desired value and then from the dropdown
choose ON or OFF.

Click on Submit this will add this configuration to your device.

3. Users can edit and delete the saved configurations anytime.

The device will now start to function on the basis of the configuration provided
by the user.

Note : The device has to be restarted after setting the configuration. This module
works with relay supported devices only.

13.0 User
In the User screen, all details related to the logged in user is shown along with
AQI and parameter.User module details the profile information of the user
including Email ID, Company name, Contact info, Profile picture and Address.

26
Admin users can add a new user by clicking the ADD NEW USER button.
1. User details: Shows the details like username, contact, email ID, location
coordinates, city, state, country.
2. Users List: This feature will be available only for the admin user, it shows
the list of assigned users who have been given access to use some or all
modules, some or all devices.
3. AQI Management: Gives option to select AQI types.

4. Units: Used to change the unit of any parameter.

27
13.1 Adding a new user
Admin users can add new (sub) users, provide access to some specific device(s)
and can also allow access to some specific module(s) only. To add a new user,
admin users have to click on the add sign below the all users list.

1. Admin needs to provide

Username, email ID and
password.

2. Select the device(s) you want to provide access to the user.

3. Admin user can also

provide access to the
specific modules of the
oizom terminal.

User module also contains the User list in which the admin can choose to
remove access or update user details.

28
14.0 Mobile Application
This terminal portal is mobile compatible also. Users can open link in mobile’s
browser, it will provide the same look and feel. It can also be added as an app
directly from the browser.

14.1 Android
In your phone open Chrome browser go to the link https://terminal.oizom.com.

Mobile app:
a. In the first sign in screen user will see an option “Add OIZOM to Home
Screen”. Click on that, this will automatically add the Oizom App to your
home screen.

29
 b. Also it can be added from options menu, in option go to “Add to home
screen”. Give Add in pop up menu. This will add oizom app on your

phone. Oizom app icon will be seen on the home screen.

Sign in with your credentials. Now users can explore through all the features of
the terminal portal on mobile.

14.2 iOS
In your iPhone open Safari browser go to the link https://terminal.oizom.com.

30
Mobile app:
After opening the terminal link in Safari browser click on the share icon and
select “Add to Homescreen”, this will add the oizom app to your iPhone.
Sign in with your credentails.Now users can explore through all the features of
terminal portal in mobile.

31