WolkAbout IoT Tool Mobile Application v2.4. User Manual

Transcription

1 WolkAbout IoT Tool Mobile Application v2.4 User Manual

2 Table of Contents: Introduction 2 Account Registration 2 Web Registration 2 Mobile Registration 4 Mobile Application Installation and Configuration 6 Logging In 7 Forgot Password 8 Dashboard Screen 9 Reports Screen 13 Messages Screen 15 Options Screen 16 1

3 Introduction WolkAbout IoT Platform modules are accessible through the suite of Web and Mobile applications named WolkAbout IoT Tool. This user manual explains in detail the usage of WolkAbout IoT Tool Mobile Application and covers the modules characteristic for the published version 2.4. Mobile Application is a subset of Web Application, which enables monitoring real-time data collected by WolkAbout IoT Platform. Web Application is thoroughly described in a separate user manual ( Web Application User Manual ). Account Registration Prior to downloading and activating Mobile Application, you need to register as a WolkAbout IoT Platform user. There are two ways of registration: Web registration Mobile registration (registration via mobile app is available only in specific cases) Web Registration There are two ways in which you can register your account via WolkAbout IoT Tool web application. Which mode will be enabled depends on the business case. 1. by invitation You will receive an invitation to join the Platform containing the account activation link Click on the link Registration form will be displayed Enter: first name, last name and password Check Terms of Service and Privacy Policy boxes Click Create The password should be at least eight characters long including at least one upper-case and one lower-case letter and one digit. Note: Invitation link is valid for 24h. 2

4 2. directly via link Fig. 1 Go directly to the provided WolkAbout IoT Web Tool address The link will lead you to the login screen Click the REGISTER button in case you do not have a registered account (Fig. 3) Registration form will be displayed Enter: first name, last name, address and password Check Terms of Service and Privacy Policy boxes Click Create Password should meet the requirements described above. Once the account is created, you will receive a verification with a link to verify your address. After verification is done, your account will be verified and activated. The account is inactive until verified. Fig. 2 3

5 After the verification you are able to log in. Fig. 3 Note: After you click on the mobile button at the bottom left of the login screen, you will be informed about server URL address. You will also be able to see the QR code which can be used only after the account registration. For further details, please refer to Mobile Application and Configuration section of this manual. Mobile Registration You should download WolkAbout IoT Mobile Application from the App Store for ios platform or from the Google Play Store for Android platform. Open the application Configuration page will be displayed (Fig. 6) Connect to the server of your choice You can do that either by entering a provided server address manually or by scanning a QR code. Proper server address will be given to you by your WolkAbout IoT provider. After configuration process has been finished, a login screen will appear (Fig. 4) Enter your address and password Click LOG IN Note: Register button will be displayed if enabled by your business case. 4

6 Fig. 4 A new screen will then appear and you will be prompted to enter: First name Last name Password Confirm password (Fig. 5) Password should be at least eight characters long including at least one upper-case and one lower-case letter and one digit. You have successfully registered your account! Fig. 5 5

7 Mobile Application Installation and Configuration After verifying your account, you will receive a welcome containing two links to download WolkAbout IoT Tool Mobile Application: App Store for ios platform Google Play Store for Android platform If you download the application from your mobile by clicking on one of these links, the configuration will start automatically, meaning that the link for the proper Platform will be set. If you go to download the application directly from the App Store or the Google Play Store without following one of the provided links, you will need to manually configure the application. You can connect to the server by using its address or scanning the QR code, as shown in the screenshot below. Fig. 6 To configure a proper server address navigate to your WolkAbout account: Click on Server info QR code will be displayed along with the server address 6

8 Fig. 7 Fig. 8 Logging In After configuration process: Enter your valid address and password After that, you will be able to log in 7

9 Fig. 9 Forgot Password If you forgot your password: Click on the FORGOT PASSWORD link You will be asked to enter the address (enter the same address you used for registration) Click SUBMIT and check your inbox Fig. 10 8

10 Dashboard Screen The initial screen that appears is the Dashboard screen. It displays mobile-enabled widgets, which are: Cards, Charts, Semantic groups, Actuators ( switch, slider and string ), Gauges, Status and Maps. As shown in the screenshot below, a green mobile glyph, visible in the Web Application, indicates that the widget is enabled for mobile phone. Fig. 11 Reading details are displayed in the images below. You can reorder widgets by drag and drop anywhere on the screen. Fig. 12 Layout in landscape orientation is also possible as in the case with Charts and Semantic groups widgets in the screenshot below. 9

11 Fig. 13 Actuators widget enables you to send an actuation value and displays the state and the value of: Device with a switch - by switching it on and off Fig. 14 Device with a slider - change the value of a parameter by moving an indicator or entering a specific value Fig. 15 Device with a string actuator widget - displays the name of the device and the string actuator you chose, as well as the time when the last change took place, i.e. when the last actuation command was sent 10

12 Fig. 16 To manage string actuator: Click on a string widget Text screen will pop up Type the command in the text field Click After the process has been finished, Last update (time) info will be displayed at the bottom of the screen. Fig

13 Note: Actuator displays readings of devices only after the previous operation process has been completed. Gauge widget is a visual representation of different value ranges. Each value range can be presented with a different color. Fig. 18 Status widget displays current status of your custom semantic group with a simple color widget. It will display real-time data sent from any selected feed from a selected semantic group made within Data semantics module. A widget can have three different statuses: NORMAL - no alarms activated; green is default color ALARM - alarm triggered on any feed in any semantic (sub)group; red is default color WARNING - alert condition of selected feeds or semantic (sub)group; yellow is default color Fig. 19 You will see detailed description of real-time data by clicking on it. Fig

14 Map widget is a visual representation of a last sent physical location/position of the specific GPS feeds. It enables real-time tracking of your device. There are colour coded location markers: green - there is no alarm red - there is at least one alarm in semantic group If you click on a location marker you will get the following information: name of the semantic group, coordinates (latitude, longitude) and the time of the last report. Fig

15 Reports Screen Reports display the history of reading/feed in a form of a chart. After selecting one of the tabs (e.g. Temperature) you will be presented with a list of readings/feeds for Temperature. This module enables you to see readings/feeds from one or more devices. Fig. 22 Screenshot below shows readings for a selected tab (in this example, Temperature). Select one of the readings to see more details. Click on a small calendar icon Fig. 23 Fig. 24 Choose one of the predefined periods of time to check a specific range of data 14

16 Note: Today has been initially predefined. To choose a specific period of time (e.g. to select specific week), select Custom Messages Screen Fig. 25 Live messages widget displays your devices latest notifications sent by the devices alarm or from the Platform rule engine if the parameters exceed their limit values. There are three types of messages: Info Warning Alarm Each message is persistent on the Platform whether it is read or not. The total number of unread messages will be displayed in the message icon. By tapping and holding one of the messages, you will be able to choose, within the menu button, one of the options: Select All, Unselect All and Mark as Read. The messages will remain unread until you select mark as read. The bolded text will automatically unbold, and the number on the messages icon will reduce. There is a search button at the top of the page as well, where you can filter the messages. 15

17 Fig. 25 The alarm notification icon (Fig. 25) displays all alarm messages including three severity levels of the alarm: critical, alert and error. By clicking on it, the list of unread alarms will be displayed. Fig. 26 Note: The alarm notification is visible on the dashboard screen only. 16

18 Options Screen In the Options you can view your username, change server address, and log out, as well. Changing server address will automatically log you out. To connect to the server again, you will have to enter its address or scan the QR code. Fig