Welcome to the Labeeb IoT Portal space!
This page is dedicated to the Labeeb IoT Platform portal space.
Labeeb IoT portal is a web application which helps the users to manage their IoT devices, data and assets, as well as to facilitate the development and testing of new IoT applications and services.
In order to be able to start using the Labeeb IoT features, users should follow the below steps.
Step 1: Login on the enterprise space, using the authentication credentials which were sent to them by QMIC.
Step 2: Create new data models and data types to describe the data that will be sent by the IoT devices and applications.
Step 3: Create new device template and assign them to existing data models.
Step 4: Create new devices and assigning them to existing device templates.
Step 5: Once your IoT devices are switched ON and started to send data to Labeeb IoT, monitor the created devices through the dashboard and device pages.
Step 6: Analyze the received data from your IoT devices through the two data pages.
Step 7: Analyze the generated alerts in the activity log page.
Step 8: Create and manage external IoT applications and manage their data access control policies.
Step 9: Create rules for generating alerts and to receive email notifications.
Step 10: If needed, create and manage user accounts.
Refer to below sections for details on how to do each of these steps.
HOME PAGE
Use Labeeb IoT URL to access the home page as shown in Figure.
SIGN UP
Click on ‘Sign Up for Labeeb IoT’ link in Home page.
- Enter details in the fields. Fields marked with *(asterisk) are mandatory.
- Enter the verification code as displayed on the screen.
- Agree to ‘Terms & Condition’ by checking this option. Click on Terms & Condition to read the details.
- Click on sign up to complete the process
LOGIN
User can login to access the Labeeb IoT web applications using credentials created during sign up or provided by the administrator.
Use Forgot Username and Forgot Password links on Home page to retrieve these details.
MY ACCOUNT
After successful login user is taken to Account page. This page displays following:
- Account subscription details
- Overview
- Current status of devices, data types,
- Weekly status of data records and alerts
- Device locations on the map
- Graphs to display the usage details for stored records and API calls
- Available limits and actual usage for enterprises
The available limits and actual usage for enterprises based on currently availed plan are displayed under following categories
- Enterprise configurations related to number of devices, data types, data models, device templates, applications, rules and user accounts
- Data communications and Storage related to number and amount of received messages on an hourly basis and stored data records on hourly and monthly basis
- Users and API calls related to API calls on hourly and monthly basis, data analytics calls on monthly basis and number of Email/SMS sent per month.
The limits shown for the usage is based on the currently availed plan.
User can request for upgrading the enterprise account to avail higher usage limits by clicking on “Change plan” and choosing appropriate monthly subscription plans. Price, description and details for each plan is provided on this page as well as option to proceed with making online payment.
Click on 'select' to choose the plan and to proceed with making payment. The new plan will be effective from next day after making the payment.
You should be receiving an email soon after making payment. Monthly invoices for the subscribed plan will also be send to the registered email (admin).
Please refer to the billing policy on subscription review page for terms and conditions related to billing.
Masarak APIs feature is available for users subscribing to Bronze or a higher monthly plan. This feature gives access to some of the Masarak APIs related to real time traffic, routing and POIs. Click on "Read More" in the monthly plan section to view the usage and billing details related to this feature.
Details related to monthly usage will be obtained in the monthly invoice email from Labeeb IOT platform.
Refer to www.masarak.com to learn more about Masarak applications.
MY DASHBOARD
Dashboard is provided for user to perform analytics and visualization of data. This capability is provided through Grafana which is an open source metric analytics and visualization suite.
User can add panels which is the basic visualization building block. Each panel provides query editor that allows user to set the required visualization to display on the panel. Styling and formatting options are provided for the panel.
Panels can be grouped together into rows. Rows are logical dividers within the Dashboard.
Under Metrics, user can select one of the two data sources from
- "json": for sql data that you can find under the data retrieval
- "Kairos DB": for no-sql data you can find under the data analytics and grouped by tags
DATA TAB
This section enables the visualization of the data received by the system. The following modules are available:
- Data Retrieval: User can search for specific data using this option.
- Data Analytics: This tab helps users to analyze large sets of data to discover patterns and useful information.
SEARCH DATA
To search for data in the system, specify one or more values in the search fields and click on the Go button to display results in the table.
These values are displayed in tabular form and can be exported into different formats such as CSV, XLS, XML, and JSON.
DATA ANALYTICS
This tab helps the user to analyze the huge volume of data to understand the pattern and get useful information.
Steps:
- Specify time duration
- Select data type for which the data needs to be analyzed
- Set the advanced options if required for group by, aggregators or Tags
- Click on ‘Search’ button.
User should be now displayed with the data type values received during the mentioned duration, plotted as a graph.
DEVICES
This section provides following options to users:
- Add and manage Data Types
- Add and manage Data models
- Add and manage Device Templates
- Add and manage Devices
- Bulk device upload for registering devices using CSV file
- Firmware upload and manage for devices
- Remote Monitoring server
DATA TYPES
Data types can be created for parameters (eg: Temperature, CO2, Motion etc) that need to be monitored using the system.
ADD DATA TYPE
Use the "+" at the top right corner for adding new data types.
VIEW OR EDIT DATA TYPES
Use the "View Data Type" or Search option for viewing data types that are already existing.
Options under Actions column can be used for editing or deleting the data types. Note that Data types need to be unassigned from Data models before deleting them.
DATA MODELS
Data model defines a set of data types that can be used to enable diverse applications to communicate with different devices. User can do the following functions in this tab:
- Add new Data model
- Edit or delete a data model
- View existing data models or Search for a data model
ADD DATA MODEL
Steps to add new data model
- Select 'Basic Information' and enter the Data model name and description
- Next under "Data Accuracy Profile & Action" mention the accuracy level which is the percentage of good data that an online device should send per period of time.
- Mention the Action that needs to be taken if the device does not satisfy the mentioned Accuracy level. Refer Table 1.
Select an already existing Data type by selecting one from the Data Types drop down list and clicking ‘Add’
- Click on 'Save' to create the data model
Click on "Edit Data Type" using the options under Action column for the Data Type.
User can edit the values as shown under Table 2 and click on Save.
Table 1 - Actions to be taken
Blacklist Device | Blacklist the malfunctioning device: |
Blacklist Data Model | Blacklist the malfunctioning data model: |
Blacklist Data type | Blacklist the malfunctioning data type: |
Mark device as Malfunctioning | Mark the device as Malfunctioning. Received |
Mark Data Type as Malfunctioning | Mark the device Data Type as Malfunctioning. |
Mark Data Model as Malfunctioning | Mark the device Data Model as |
NONE | No action is applied |
Table 2 - Options under Edit data type
Fields | Options | Description |
Filter by | Value, Time Metadata, Location Metadata | User can define filters for Value, Time and location |
Filter Action | Store Value ,Discard Value, Discard Data Model, Discard Message, Adjust | The action that needs to be taken if the data satisfies the filter expression |
Storage option | No Storage , Periodic User can set the Frequency for storage and options for History | User can define the method of storing the data received |
EDIT OR DELETE DATA MODEL
Use the options under Action column of data model to edit or delete data models.
Please make sure that there are no dependencies (Devices/ Device Templates) on this Data model before deleting it.
DEVICE TEMPLATES
Device Templates defines a format which group of devices can inherit. Device template contains device heartbeat profile, data model associated.
Under this section user can create, edit, delete or search for the device templates.
ADD DEVICE TEMPLATE
To create a device template, follow the below steps:
- Click on "+" on top right corner to add New Device Template
- Specify basic information such as device Template name, description, location and the time zone
- In the Device Heartbeat profile & Action tab mention the Heartbeat profile which determines if the device is to be considered as online or offline. For the device to be considered as ONLINE, a device should send at least X Packets per Period of Time. Otherwise, the device will be considered as OFFLINE.
- Mention the device template password. This password will be used for authentication during communication from devices.
- Select one of the Data models
- Click on Save.
EDIT AND DELETE DEVICE TEMPLATE
Use the options under Action column of Device Template to edit or delete data models.
SEARCH DEVICE TEMPLATE
User can view all the device templates by clicking on "View device templates" option on the top right corner.
User can use search option to search for existing Device Templates.
Results are displayed in tabular form and can be exported into different formats such as CSV, XLS, XML, and JSON.
DEVICES MANAGEMENT
User can register and manage devices using options under this section.
ADD DEVICE
User can create a new device by clicking on the ‘Add New Device’ option.
- Click on the ‘Add new Device’ option
- Enter the details of the device like name, device model, firmware version, location, sim card details and description. The fields marked with *(asterisk) are mandatory fields. For details on the fields click on the help icon "?".
- Mention the parameters for heart beat profile which will determine the status of the device – offline or online. For the device to be considered as ONLINE, a device should send at least X Packets per Period of Time which is mentioned in the heartbeat profile. Otherwise, the device will be considered as OFFLINE.
- Mention the other parameters –Device type, Device Template.
- Click on save and the device will be created successfully.
SEARCH DEVICE
To search for any registered device in the system, use the search option at the top right corner as shown in the snapshot. Specify a device name in the search field and click on the search button, as shown in Figure, to display the requested device details in the table.
To list all registered devices, click on view devices option shown in the snapshot.
VIEW DEVICE DETAILS
Click on the drop down option for each device to view mode details including basic information, device status and device location on map.
MANAGE DEVICES
Use the options under actions column corresponding to devices for editing, deleting or changing device status.
Note that if users chooses to delete a device same day soon after creation and if the device has not send any data, then the device will be removed from system immediately.
Devices which has sent at least one message to the server or if it has been existing for more than one day then it will be removed only after one month (based on billing cycle) after user chooses delete option for the device.
The number of active devices shown under enterprise package of My account will include all these currently active devices till they are deleted from the system.
BULK DEVICE UPLOAD
This feature allows user to register multiple devices using CSV file.
Steps:
- Create CSV file containg details for each device to be added in the format specified: "device_name,device_model, firmwareVersion, latitude, longitude, sim_card_number, phone_number, pin, description, heart_beat_profile_algorithm, heart_beat_profile_number_of_packets, time_measure,time_period, device_type, device_template".
Refer to table for knowing the mandatory fields. - Upload the CSV file using 'Choose'
After successfully uploading the CSV file, all devices gets created.
User can check for all registered devices in Device Management page by searching or listing them.
| Field | Mandatory | Comment |
|---|---|---|
device_name | Yes | |
device_model | No | |
firmwareVersion | No | |
latitude | No | |
longitude | No | |
sim_card_number | Required if the device has a sim card | |
phone_number | ||
pin | ||
description | No | |
hear_beat_profile_algorithm | Yes | Value defines the type of algorithm you want to choose for the activity monitoring. You can set it to "PERIODIC", "EVENT_DRIVEN_AND_PERIODIC" or "SLIDING_WINDOW". |
heart_beat_profile_number_of_packets | Yes | |
time_measure | Yes | This is the monitoring cycle duration. You can set it to "SECOND", "MINUTE", "HOUR", "DAY", "WEEK", "MONTH" or "YEAR" |
time_period | Yes | The number of cycle (as defined on time_measure) over which you will monitor the number of packet defined on heart_beat_profile_number_of_packets. |
device_type | No | You must choose from the following types "FM_DEVICE", "RFID", "SENSOR", "GATEWAY" or "PHONE". |
device_template | Yes | Has to be created in advance |
FIRMWARE
User can upload Firmware file in this section which can be used for updating firmware of registered remote devices.
After uploading file and specifying fiirmware name, version etc click on Save. The corresponding URL for this uploaded file can be obtained under download file column on expanding the Firmware details as shown in snapshot. This link can be used to update Firmware of registered devices which supports downloading files from the specified URL.
REMOTE MONITORING
This feature enables device management and remote monitoring of LWM2M Devices.
Steps to follow:
- Register the LWM2M / COAP device using Devices Management option
- Connect the LWM2M device on port 5673
- Successfully connected client are listed on the LWM2M remote monitoring page, as shown in snapshot.
Click on the listed client to view its details and to perform operations like observe, read, write, update Firmware etc.
Security configuration for LWM2M client connections can be done on the security page as shown in snapshot.
HOSTED APPS
This section provides option for user to view and add rules in text format using Drools syntax related to devices data and status.
Steps:
- Add new rule by clicking on "+" on top right corner.
- Click on Compile option to verify and fix compilation errors.
- Use settings to access various connectors (for eg: Twitter, Dropbox, slack etc) for connecting and publishing results based on rules events. For testing the rules and connectors users can make use of "Publish Test data"
- Click on save to activate the rule and to start generating corresponding events and alerts.
Summary of features supported by rules engines is as follows:
- Publish data to external MQTT brokers
- Insert data records to external databases and data analytics engines (Postgres, MySQL, Oracle, Microsoft SQL, Hadoop, Cassandra)
- Call external REST web services
- Send SMS messages
- Email notifications
- Insert new data records in internal m2m DB
- Generate RSS feeds
- Publish data using connectors (For eg: Twitter, Dropbox, slack etc)
- Receive data from Open Weather, Open Cage based on rules trigger
PREDICTIVE DASHBOARD
The aim of predictive maintenance module is to predict when equipment failure might occur using the historical data collected through multiple sensors attached to that equipment.
Asset needs to be created in Labeeb IOT for any equipment which needs to be monitored under predictive maintenance. Sensors (devices) are then assigned to this asset for data collection and monitoring.
Two main pages available under this section are:
- Dashboard
- Assets Management
HOLDERS
This section is for users to create entities like vehicles, person, building etc. These entities can hold monitoring devices as well they can be associated with each other by creating relationships.
Eg: To monitor VehicleA driven by DriverA follow below steps:
- Create a holder 'Vehicle' and associate a registered GPS device if exists
- Create a holder 'Person' for the driver
- Create a relationship 'Driven by' and associate Vehicle with Person
The corresponding data for the holders can be viewed in Data tab by specifying the holder ID and associated date range.
Below sections provide details on how to add relationships and create holders.
RELATIONSHIP
To create a new relationship between holders click on "+" at top right corner of Relationship page.
Specify relationship name, select Holder A and Holder B and click on Save, as shown in screenshot.
Click on 'list' icon to view all existing relationships. Use the options under Action column to edit and delete relationships.
HOLDERS MANAGEMENT
Users can create new holders by following below steps.
- Click on "+" on top right corner to open 'Add new holder' page
- Select Holder Type from drop down menu. Available options are:
- Person
- Vehicle
- Building
- Area
- Generic
- Each holder type has certain mandatory fields which needs to be populated
- Click on Save
Now the holder is successfully created.
Click on list view to see all existing Holders. Use expand option, refer snapshot, to view more details of the holder.
Existing relationships can be used for associating different holders or new relationships can be created, as shown in snapshot.
To view data related to a holder, open "Data Retrieval" page, specify Holder ID and date range then click on Search.
SETTINGS
This tab helps administrators to manage following:
- Applications
- User Accounts
- Map Layers
APPLICATIONS
This section enables the management of external applications (discovery and subscription to platform / devices resources). Applications can subscribe to certain devices, device templates, data models, data types.
ADD APPLICATION
To create an Application, follow the below steps:
- Click on "+" on top right corner to Add New application
- Mention the basic information such as Application name, description and the password
- Define the Access Control List (ACL) for this application. An application can have access to a list of Device template, devices as mentioned in the ACL.To associate an ACL to the application, select the device template, device, access type (read or/and write), Data model and Data Type and click on the ‘Add ACL’ button.
To delete the already added AACL, click on the delete icon. - Click on ‘Save’ button to create the application
SEARCH APPLICATION
User can view all existing applications by clicking on "View Applications" on top right corner. Use Search option on the top right corner to search for a particular application.
EDIT AND DELETE APPLICATIONS
Use the edit or delete options for each application, as shown in snapshot.
USER ACCOUNTS
For accessing the portal, Administrator needs to create user Accounts and corresponding credentials can be used to log into Labeeb IoT system.
ADD USER ACCOUNT
Follow the below steps for adding a new person
- Click on "+" option on the top right corner to “Add New User Account”
- Fill in Personal and account details
- Add Roles for the user account. Refer below table for details on roles and corresponding access
- Click on Save
Once the account has been created successfully these credentials can be used to login to the portal.
Table below shows the permissions available for different roles:
Roles | Access to Application |
Administrator | All applications |
Accounts Manager | Platform Management / User Accounts |
Devices Manager | Dashboard,Devices,Platform Management (Data Models , Devices Template),Activity logs |
Applications Manager |
|
Data Analyst |
|
Devices Analyst |
|
SEARCH USER ACCOUNT
Use the "View User Accounts" option on top right corner to view existing user accounts. User can also search for specific user accounts by using the search option.
MANAGE USER ACCOUNTS
Use the edit or delete option available for the user account, as shown in snapshot.
MAP LAYERS
Users can now add interactive map layers to be displayed on the map under My Account page, refer snapshot.
To add new map layer:
- Open 'Map Layer' page from under Settings
- Click on 'Add Map layer' option on top right corner
- Upload the new file
- Click on create
These newly added layers can be viewed on the map in My account page under Device Locations section. Select the layer from the map display option to view it.
ACTIVITY LOGS
In this section, user can view all notification messages.These notification messages will be useful to track the status of devices and detect the presence of malfunctioning devices. Also, these messages can be used to generate useful alerts.
User can search for a notification by clicking on Search option at the top right corner, then mentioning the duration or notification id. User can also retrieve the logs for a particular severity by choosing from the severity dropdown option.
User is displayed with the details –Date & time, notification Id, Severity, notification message, device ID, device template, Data model, Data type and the status. These details are displayed in tabular form and can be exported into different formats such as CSV, XLS, XML, and JSON (refer Figure 50).
