This document is work in progress and can only be viwed by those at WSO2!
In this tutorial, you summarize the battery lelve data of the device and create the Battery_Level_Per_Hour
table by annalzing the data gathered from all the enrolled devices.
MobX created new mobile applications or send updated to corporate mobile applications. These applications need to be installed on the users devices. To ensure that the applciations are installed or updated on all the enrolled devices successfully, all the devices need to have a battery level of 50% or above. Using the steps given below, MobX administartors are able to identify the devices that had less battery power when an application installation request was pushed and confirm with those users if the application was installed successfully.
Let's get started!
Configurating WSO2 IoT Searver to publish device information
You need to configure WSO2 IoT Server to publish device information as it is disabled by default. Follow the steps given below.
- Open the
<IOTS_HOME>/conf/
file.cdm-config.xml
Configure the
PublishDeviceInfoResponse
parameter astrue
.<OperationAnalyticsConfiguration> <PublishLocationResponse>false</PublishLocationResponse> <PublishDeviceInfoResponse>true</PublishDeviceInfoResponse> <PublishOperationResponse> <Enabled>false</Enabled> <Operations> <Operation>*</Operation> </Operations> </PublishOperationResponse> </OperationAnalyticsConfiguration>
- Start WSO2 IoT Server:
Start the WSO2 IoT Server broker profile.
cd <IOTS_HOME>/bin sh broker.sh
Start the WSO2 IoT Server core profile.
cd <IOTS_HOME>/bin sh iot-server.sh
Next, start the WSO2 IoT Server analytics profile.
cd <IOTS_HOME>/bin sh analytics.sh
Creating a stream and persisting data
You need to create a stream to gather the device data. Follow the steps given below:
- Access the WSO2 IoT Server's analytics management console.
For access via secured HTTP:
https://<IOTS_HTTPS_HOST>:9445/carbon/
For example:
https://localhost:9445/carbon/
For access via HTTP:
For example:http://<IOTS_HTTP_HOST>:9765/carbon/
http://localhost:9765/carbon/
On the Main tab click Streams that is under Events.
Click + Add Events Streams.
Enter the following values:
Event Stream Name org.wso2.iot.BatteryStream
Event Stream Version 1.0.0
Meta Data Attributes Add a meta data attribute by entering the name, selecting the type from the drop-down list, and by clicking Add .
Attribute name Attribute type deviceId
String deviceType
String timestamp
Long Payload Data Attributes Add a payload data attribute by entering the name, selecting the type from the drop-down list, and by clicking Add .
Attribute name Attribute type level
Double year
Int month
Int day
Int hour
Int minute
Int - Click Perisist Events. What happens when you do this?
- Click Add Event Stream.
Creating an analytics script to summarize data
Follow the steps given below to create a script that summarizes the data:
- On the Main tab click Scripts that is under Batch Analytics.
- Click Add New Analytics Scripts.
- Give the script a name, such as battery_data_analytics.
Copy the script given below to the Spark SQL Queries text box.
CREATE TEMPORARY TABLE BatteryData USING CarbonAnalytics OPTIONS(tableName "ORG_WSO2_IOT_BATTERYSTREAM", incrementalParams "ORG_WSO2_IOT_BATTERYSTREAM, HOUR"); CREATE TEMPORARY TABLE Battery_Level_Per_Hour USING CarbonAnalytics OPTIONS (tableName "Battery_Level_Per_Hour", schema "deviceId STRING, type STRING, level DOUBLE -i, year INT -i, month INT -i, day INT -i, hour INT -i, timestamp LONG", primaryKeys "year, month, day, hour, deviceId, type", mergeSchema "false"); INSERT INTO TABLE Battery_Level_Per_Hour SELECT meta_deviceId as deviceId, meta_deviceType as type, avg(level) as level, year, month, day, hour, getHourStartingTime(year, month, day, hour) as timestamp FROM BatteryData GROUP BY meta_deviceId, meta_deviceType, year, month, day, hour; INCREMENTAL_TABLE_COMMIT ORG_WSO2_IOT_BATTERYSTREAM;
- Enter
0 0 0/1 1/1 * ? *
as the value for the Cron Expression.
This field is used to determine how often the analytics script needs to be executed. In this sample we have configured the script to run every hour. - Click Add.
Creating an execution plan to publish data
Create an execution plan to publish the data received to an output stream. Follow the steps given below:
- On the Main tab, click Execution Plans.
- Click Add Execution Plan.
Copy the execution plan that is given below and replace the sample content that is in the text box.
@Plan:name('analze_battery_level') @Import('org.wso2.iot.DeviceInfoStream:1.0.0') define stream inputStream (meta_deviceId string, meta_deviceType string, timeStamp long, imei string, imsi string, deviceModel string, vendor string, osVersion string, osBuildDate string, batteryLevel double, totalInternalMemory double, availableInternalMemory double, totalExternalMemory double, availableExternalMemory double, operator string, connectionType string, mobileSignalStrength double, ssid string, cpuUsage double, totalRAM double, availableRAM double, pluggedIn bool); @Export('org.wso2.iot.BatteryStream:1.0.0') define stream outputStream (meta_deviceId string, meta_deviceType string, meta_timestamp long, level double, year int, month int, day int, hour int, minute int); from inputStream select meta_deviceId, meta_deviceType, timeStamp as meta_timestamp, batteryLevel as level, time:extract(time:timestampInMilliseconds(), 'year') as year, time:extract(time:timestampInMilliseconds(), 'day') as day, time:extract(time:timestampInMilliseconds(), 'hour') as hour, time:extract(time:timestampInMilliseconds(), 'minute') as minute insert into outputStream;
- Click Add Execution Plan.
Try it out
What's next
- Want to know more on the WSO2 IoT Server Siddhi extensions? See WSO2 IoT Server Siddhi Extensions.
Try out the tutorials listed below and see how the extensions described above are put into use.