User Guide - 18.12.2

Introduction

WolkSensor User Guide is designed for users of the WolkSensor device and its supporting software applications.

This document briefly explains the setup of WolkSensor and its data monitoring process.

Table of Contents

Introduction

Chapter 1: General Information

1.1. WolkSensor Technical Details

1.2. WolkAbout IoT Tool Application

1.3. WolkSensor Assistant Application

Chapter 2: Getting Started

2.1. WolkAbout IoT Tool Account Creation

2.2. Adding WolkSensor to Your Account

Chapter 3: Using WolkSensor Assistant - Additional Features

Chapter 4: Using WolkAbout IoT Tool - Features

4.1. Dashboards Tab

4.2. Messages Tab

4.3. Reports Tab

4.4. Rules Tab

4.5. Devices Tab

4.6. Data semantics Tab

4.6. Settings

Chapter 5: Support Information

Chapter 1: General Information

This chapter provides an overview of general WolkSensor hardware information and an overview of two software applications needed for device configuration and data monitoring: WolkSensor Assistant and WolkAbout IoT Tool.

1.1. WolkSensor Technical Details

WolkSensor is an industrial grade WiFi and battery powered sensor which detects physical movement of the device and measures temperature, humidity and pressure.

It is not water resistant.

WolkSensor is connected to Wi-Fi network and sends gathered environmental data via the Internet.

You can access these data through WolkAbout IoT Tool software application.

1.2. WolkAbout IoT Tool Application

WolkAbout IoT Tool app is a software application which allows the access to your WolkSensor data from any Internet-enabled device. It is free and available on web and as a smartphone application on Apple iTunes Store and Google Play Store.

For more information on WolkAbout features, go to Chapter 4.

1.3. WolkSensor Assistant - Desktop Application

WolkSensor Assistant is a desktop application needed for WolkSensor activation and configuration. It enables:

  • Wi-Fi parameters configuration
  • Wi-Fi parameters update
  • Test connection
  • Checking login errors
  • Checking sensor’s readings
  • Calibrating sensor manually, i.e. adjusting measured values

WolkSensor Assistant can be downloaded by going to wolkabout.com/wolksensor.
It is available for OS X and Windows operating systems.
While downloading, the application will automatically choose your operating system.

For more information on WolkSensor Assistant features, please go to Chapter 3.

Chapter 2: Getting Started

This chapter provides the instructions on how to create your WolkAbout IoT Tool account and start using your WolkSensor.

2.1. Create WolkAbout IoT Tool Account

As a new user, you must create WolkAbout IoT Platform account first (WolkSensor will not work without the cloud).

  • Click the Register button to create new account
  • Fill in the Create Account dialog

  • Click Next to continue
  • New Terms of Service dialog will appear
  • Read carefully through it and select I accept Privacy Policy and Terms of Service and I am 16 years and older boxes which are mandatory and Subscribe me to the newsletter which is optional
  • Click Register
  • Verification email will be sent to your email address
  • Your account will be active after verification

Upon successful verification of your email address, you will receive an account confirmation email with the following information:

  • Account details
  • Password change options
  • Software download links
  • Support details

In case you cannot remember your password, go to Forgot password? link.

  • Enter your email address in the next dialog

  • Click the Submit button
  • You will receive instructions on how to obtain your password

2.2. Adding WolkSensor to Your Account

WolkSensor Assistant is a desktop application needed for WolkSensor activation and configuration.

  • Download WolkSensor Assistant by going to wolkabout.com/wolksensor
  • Click the WolkSensor Assistant Download button which appears when you hover over the button at the bottom right corner

  • After the downloading process is completed, install the application
  • Connect your WolkSensor to the computer with any shielded micro USB cable from the box
  • Run the WolkSensor Assistant app

After WolkSensor Assistant application is launched, the following Sign-in dialog will appear (use your WolkAbout account credentials to sign in):

If you don’t have WolkAbout IoT Tool account, you can create one by clicking sign up at the bottom of the screen.

The first step in activating WolkSensor is to enter the name in the Give WolkSensor a name field. WolkSensor’s name can later be changed in the WolkAbout IoT Tool application.

Then, in the Configure WolkSensor wireless network dialog enter Wi-Fi parameters of the network you are connecting your WolkSensor to. Network name and Password refer to those Wi-Fi networks which your WolkSensor will be using (it is also possible to use a static IP address).

You have now successfully activated your WolkSensor. Allow up to 10 minutes for WolkSensor data to appear in the WolkAbout IoT Tool application.

If you are not able to activate the device, please check the parameters you have entered in the Wi-Fi Settings tab. Also make sure that your network is working properly.

WolkSensor info tab displays the name of your WolkSensor and allows you to configure the sensors you want to be active (whether you want to receive information about temperature, humidity, pressure or motion).

In case you are still not able to finish the activation process, please contact our technical support at support@wolkabout.com.

Advanced tab displays general details about the device (SERIAL NUMBER, FIRMWARE version and MAC ADDRESS). You can also test connection (COMMUNICATION TERMINAL button) and check readings (READINGS button), which can help you in troubleshooting.

Chapter 3: Using WolkSensor Assistant - Additional Features

Wi-Fi parameters update - This option is available under Wi-Fi settings tab. First, connect your WolkSensor to the computer, sign in and click the CHANGE button in this tab.

Test connection – Click the COMMUNICATION TERMINAL under Advanced tab to check if everything is ok with the connection. Click the CONNECTION TEST button to start the test. You can use communication terminal to see all communication between WolkSensor and WolkSensor Assistant.

Check readings – Check battery voltage level and other system readings within READINGS under Advanced tab. Here, you can also see measurements buffered in the device at the moment – date and time, air pressure values, air temperature values, air humidity values and if the movement was detected.

Calibration - Helps you manually adjust your WolkSensor’s measured values
Before calibration, you can either send readings to the Platform or delete them. You can adjust values to decimal number up to one decimal within limited values:

Humidity: +3.0 to -3.0 Pressure: +10.0 to -10.0 Temperature: +3.7 to -2.0

Chapter 4: Using WolkAbout IoT Tool - Features

As stated above, WolkAbout IoT Tool is a software application which enables the access to your WolkSensor readings from any Internet-enabled device.

4.1. Dashboards Tab

When signed into the application, the first tab to open is Dashboards, showing, by default, an overview of your activated WolkSensor data: motion, temperature, humidity, air pressure. Data are shown in a form of a Semantic groups widget.

Creating Dashboards

  • Click the button on the home dashboard screen
  • Enter dashboard name in a new dialog
Adding Widgets

WolkAbout IoT Tool Application allows you to create widgets to visually represent status of the data you receive from your device through feeds/actuators/alarms mapped in the semantic groups.

Here is how you can add a widget:

  • Click the button
  • New dialog will appear with different types of widgets: Actuators, Cards, Charts, Control, Gauges, Layout, Live messages, Maps, Semantic groups and Status
  • You can choose one of them except for Actuators, Maps and Semantic groups widgets
  • In a new dialog choose feed you would like to see on that widget (Temperature, Pressure or Humidity)

The widget and the data will appear on your dashboard.

Cards

Cards widget displays the latest reading of one feed.

To visualise data with Cards widget:

  • Choose the feed by selecting the radio button on the right side
  • Click Save

Charts

Charts widget displays live reading(s) in form of a chart.

To visualise data with charts widget:

  • Choose it and click the Select button
  • New dialog will appear with feeds listed (e.g. pressure, humidity, temperature)

You can choose feeds from multiple number of semantic groups (e.g. kitchen 1: temperature 1; living room 2: temperature 2...), but they need to belong to the same reading type (e.g. Temperature reading type).

  • Click Save

Control

Control widget is a mix of chart and card widget. It displays real-time data and updates on its label.

Control widget displays the following data:

  • Name of feed and its semantic group
  • Time/date of last update
  • Status (active/inactive)
  • Chart with real-time data

To visualise data with control widget:

  • Choose control widget in the Add widget dialog
  • Widget settings dialog will appear with the list of all the semantic groups and their feeds
  • Choose a feed
  • Click Save
  • Control widget with the selected feed data will appear on a dashboard
Gauges

Gauges widget is a visual representation of numeric feed values of user-defined quality ranges.

To visualise data with gauge widget:

  • Click the Gauges button in the Choose widget dialog
  • You will get the list of all the semantic group(s)
  • Choose the feed with value you would like to be displayed (e.g. Temperature)
  • New Widget settings dialog will display a range of default minimum and maximum values
  • Within a default range, set your own range of limit(s) by clicking +New limits
  • Define limit value(s) by using number input spinners or by directly entering the exact number

You can add multiple value ranges within the default one.

Layout

Layout widget is a monitoring-enabled widget which provides a background for specific feeds so that they can be organised according to your business logic.

To use a Layout widget:

  • Click the Layout widget button in the Choose widget dialog
  • Within new widget settings modal you are prompt to enter Layout Name
  • Click the SELECT BACKGROUND (PNG or JPEG format; size up to 15 MB) button
  • Choose your background
  • Click Save

When you create your background you are able to add feeds to it.

To add feed:

  • Click the feed icon
  • Place the feed placeholder on the background
  • Feed properties will be displayed on the right side of the window
  • Click the button to select a feed
  • Adjust your x and y feed properties to change the position of feeds
  • Select an appropriate data feed within search data feed drop-down menu
  • Enter label
  • Select Show label check box to make it visible on the widget
  • Adjust font size
  • Click Save

By clicking the Clear background option, you will delete the current one and will be able to choose a new one.

To resize layout widget, click one of the following buttons:

Live Messages

Live messages widget displays the latest notifications sent by the alarms or from the Platform rule engine if the parameters exceed their limit values. You can define parameters’ limit values and be notified if they are exceeded.

To use Live messages widget:

  • Click the Live messages button in the Choose widget dialog
  • Within New Widget settings dialog, set the number of notifications your widget will display (up to 4, 8 or 12 at once)
  • Click Save

Status

Status widget displays current status of a semantic group based on real-time data sent from any selected feed or hardware alarm within a selected semantic group.

To use Status widget:

  • Click the Status button in the Choose widget dialog
  • New dialog will appear with a list of semantic groups you have created on the Platform
  • Select semantic group
  • New Widget settings dialog will appear

It displays the name of the semantic group you have chosen along with different statuses a widget can have:

  • NORMAL - no thresholds crossed/alarms activated; green is default colour
  • WARNING - alert condition of selected feed or semantic (sub)group; yellow is default colour
  • ALARM - threshold crossed/alarm triggered on any feed in any semantic (sub)group; red is default colour

Default colours can be changed in a drop-down menu in the Widget settings dialog.

  • Click Save

Status widget will display a colour of a state its feeds/semantic (sub)groups are in.

If any feed in any semantic (sub)group crosses a defined threshold, status widget displaying its data will turn red and display the number of threshold alarms that have been triggered. If feed’s data goes back to normal state, the widget will turn green (or turn in any other colour you have selected to be your normal state colour).

4.2. Messages Tab

WolkAbout IoT Tool Messages module displays all the messages stored on the Platform, from device alarms to user-defined messages (e.g. if feed/reading measured at that moment is above the defined limits). As said, messages can be predefined, by default, or set up, by user, as a rule on the Platform.

Messages Home Screen

Initially, Messages home screen displays a list of messages along with their details. The list is paged with the unread ones displayed in bold and the latest one displayed on top by default.

Each message contains the following information:

  • Date: Time and date of the received messages
  • Source: Name of sensor/actuator/alarm that sent the message
  • Message Type: Type of the message (each type marked with the appropriate symbol)
  • Message: Message text
  • Description: Detailed description of a message (i.e. the condition under which the alarm activates)

To mark messages as read:

  • Check the box and go to MARK AS READ
  • The message text will be unbolded, and you will receive a notice Selected messages were marked as read at the bottom right corner of the screen

You can select up to 10 messages per page (maximum number of messages that can be displayed on one page), one by one, or use MARK ALL AS READ bulk mode. That option will mark all the unread messages, not just those displayed on the page you are currently on.

Filter

Filter dialog, located above the list, helps you filter out the messages according to read/all criteria (in Show text field), message type (Warning, Info and Alarm) and date.

Search Messages Text Field

Search bar helps you search through the messages by their sources/sensors (e.g. living room, elevator), message text and descriptions (e.g. high temperature, humidity…) if you start typing any part of these three components (e.g. high instead of humidity high).

If you want to clear filtering, and go back to default view, click the x button in the filter search bar.

Show Text Field

  • Choose messages you would like to be displayed by read/all criteria
  • Click on a drop-down arrow
  • Choose all or just unread messages to be displayed

Message Type Text Field

  • Choose messages you would like to be filtered and displayed in the main messages screen by their message type
  • Click on a drop-down arrow
  • List of message types (Warning, Info, Alarm) will open

  • Choose one by clicking on it

If you select:

  • Warning - all warnings you have received will be presented in the list, with the appropriate symbol displayed in the message type column
  • Info - all info you have received will be presented in the list, with the appropriate symbol displayed in the message type column
  • Alarm - all the alarms you have received will be presented in the list

An additional feature includes alarm severity levels (alert , critical , error ). When you filter out the alarms, Message type column will display symbols of the alarm severity levels.

From/To Text Field

From/To: Helps you filter out the messages received by date.

  • Click on a drop-down arrow
  • A calendar will open

  • Choose exact dates (from/to) of the messages you would like to be displayed
  • Messages will be displayed on the screen

Alarm Notifications

Alarm Notifications menu is located in header. It displays the number of notifications you have received, but haven’t read yet.

Manage alarm notifications:

  • Click the Alarm Notifications menu button

Each notification in the list contains notification text, name of the sensor which triggered the alarm, symbol for severity level and time and date when the alarm was triggered.

  • Hover over any notification label
  • MARK AS READ hyperlink will appear with the same function as the one for messages on the initial Messages screen
  • Click on it

Notification will be marked as read and will automatically be deleted from the list. The next one in line will come to its place.

If you read alarm notifications on the Messages screen, counter and list will be updated accordingly.

To directly jump to Messages from another module in the application:

  • Select Go to messages hyperlink at the bottom of Alarm Notifications drop-down menu and it takes you to Messages initial screen

4.3. Reports Tab

There are two different ways in which reports can be presented in WolkAbout IoT Web application:

Dashboard Chart Widget

  • Enables you to see live reading(s) in form of a chart (see WolkAbout IoT Tool, User Guide, Handle Widgets section for more information)

Reports Module

  • Displays the history of reading(s) along with other details and is located in the main menu under the Reports screen

Reports Home Screen

Reports initial screen displays all the reports created. They are displayed in form of tabs and can be edited or deleted.

Creating Reports

Note: Prior to the next step, make sure you have connected at least one semantic group/feed to the Platform!

To create a report:

  • Go to the Reports screen
  • Click the button

Create new report dialog will appear with the list of tabs representing different types of feeds (e.g. temperature, pressure, humidity, movement…) you have available on the Platform.

  • Click on the tab depending on the type of feed you would like to be displayed

You will get the list of all the semantic groups containing the type of feed in question.

  • Choose up to ten feeds from multiple semantic groups which need to belong to the same reading type (e.g. semantic group 1: temperature 1; semantic group 2: temperature 2…)

  • Click Save

New window will appear with the details of a report displayed and the readings of particular feed(s) represented in form of a chart.

Hover cursor over chart to see the exact reading of the feed at a particular time.
You can also set up a chart to display readings for today, yesterday, this week, last week and this month.
There is also Pick a date option which allows you to select a start and end date of the reading(s) you would like to be displayed.

  • Click the Download button to export and store these data in CSV file

Editing Reports

To edit reports:

  • Click the Settings button (appears when you hover the cursor over the report tab displayed on the screen)
  • Create new report dialog will appear with a name field and a drop-down list of all the semantic groups that contain the type of feed in question
  • Edit name and/or feed(s) displayed on a report card (e.g. Temperature on the first floor to Temperature on the second floor)
  • Click Save

Remember that report can display only one type of feed (e.g. only temperature), therefore you cannot change the type of data displayed on a card (e.g. temperature to pressure) only the semantic group(s) that contain the feeds in question (e.g. temperature in living room to temperature in bedroom).

Report Zoom

This is a zoom in/out functionality added to the Reports module. You are able to set custom zoom by choosing a range within the timeline you would like to zoom in/out of.

To use this functionality:

  • Click on your report
  • Select a particular period of time of the reading(s) to be displayed
  • Resize and move the zoom bar at the bottom of the screen to zoom in/out

Depending on the range you have chosen, you have the possibility to zoom in within that range as well, by scrolling the mouse wheel.

Possible range of time:

  • between 2h and 24h

If you move the wheel button on your mouse once/twice/three times, the range of time is resized to 10/5/1 minute (see the screenshot below)

  • between 1 and 7 days

If you move the wheel button on your mouse one time/two times, the range of time is resized to 30 minute/10 minute

  • between 1 and 5 weeks

If you move the wheel button on your mouse one time/two times/three times, the range of time is resized to 2h/6h/30 minute

  • 5 weeks and more

If you move the wheel button on your mouse once, the range of time can be resized up to 24h

Deleting Reports

To delete a report card:

  • Click the x button that appears when you hover your cursor over the card
  • Click Delete to confirm the action

4.4. Rules Tab

Rules WolkAbout IoT Tool module analyses the data in real time and performs actions based on that data (e.g. sets the rules which trigger the performance of various tasks and automate a variety of functions).

For more information on the Rules module, go to WolkAbout IoT Tool User Guide.

4.5. Devices Tab

Device Management WolkAbout module enables you to connect and manage your IP-enabled devices.

Please note that you can add a maximum of three devices and an infinite number of WolkSensor devices.

As shown in the screenshot below, the initial screen of WolkAbout Device Management contains a device list which includes:

  • Name
  • Last report
  • Status key
  • Device type
  • Connectivity type

Within the Devices screen, you are able to:

  • Create/Update/Delete Device Template
  • Create/Delete Devices
  • Add/Edit/Delete Gateway
  • List/Search Connected Devices

A search box on the left enables you to search any device by device name and device key (serial number of a certain device) by its name.

In filter box, you can filter the device list by:

  • Status

  • Device type

  • Connectivity type

In the top right corner you can find a Grid view option. Within grid view you are able to see the information such as: Device type and Key.

There is an option Sort by Name where you can sort your devices by alphabetical order or by Newest/Oldest report.

Device Details

After your device has been created, it will be displayed on the initial Devices screen with the details previously mentioned (status, last report, device name…).

If selected, device details will be displayed: Info, Connectivity (Firmware update - if previously selected), Data and Configuration.

Connectivity

Go to WolkAbout IoT Tool User Guide to read the details.

Data

Within Device Details Data tab, you are able to see Name, Reading Type, Last update and the Last value of the data sent from the selected device.

Configuration

Once the parameters are added, as described in Create/Update/Delete Device Template part (for more information go to Create/Update/Delete Device Template section in WolkAbout IoT Tool User Guide), they can be seen in Device Details Configuration tab. This screen displays the last used set of values.

These configuration values can be set here and applied by clicking the button in the right corner, as seen below.

For more information on the Devices module, go to Device Management section of WolkAbout IoT Tool User Guide.

4.5 Data Semantics Management

For more information on the Data Semantics module, go to Data Semantics section of WolkAbout IoT Tool User Guide.

4.6 Settings

It is located on the right in the application’s title bar. It enables you to further manage your account and provides some additional information about the account and the application itself.

Account

  • Click the button

New dialog will display a drop-down menu with the Account and Log out option

  • Click Account in drop-down menu

New Account settings dialog will appear with Info and Password tabs.
It enables you to modify your account by changing your credentials

  • Change first and last name in Info tab

Change password in Password tab

  • Click Save

Help

Enables you to get detailed instructions on how to use the Platform.

  • Hover over the button
  • A drop-down will appear with:
    1. Start Tutorial - enables you to access and restart the tutorial at any time
    2. User Guides - enables you to access user guide for web and mobile application
    3. About - enables you to quickly access your account on Platform’s mobile application by scanning a QR code

Log Out

Log out of the application.

  • Click Log Out
  • New dialog will appear asking you to confirm the action

  • Click Log out to confirm the action

Chapter 5: Support Information

In case you are experiencing problems with using WolkSensor or WolkAbout software applications, please take a look at our FAQ section.

If this doesn’t solve your problems, simply send us an email at support@wolkabout.com. We will send you the response as soon as possible.
Thank you for using WolkAbout’s products & services.

Trademark Information

WolkSensor, WolkAbout IoT Tool and WolkSensor Assistant are trademarks of WolkAbout Technology s.r.o.
All other trademarks are the property of their respective owners.