Devices site - User guide Vincent HAVARD 16/06/2014 Aim of the - - PDF document

CREST project

Devices site - User guide

Vincent HAVARD 16/06/2014

Aim of the documentAim of the document Devices site - User guide 1/28

Content

Aim of the document .............................................................................................................................. 3 Glossary ................................................................................................................................................... 4 1 Architecture overview ..................................................................................................................... 4 2 General overview ............................................................................................................................ 5 2.1 Devices site access ................................................................................................................... 5 2.2 General overview .................................................................................................................... 6 3 All user guide ................................................................................................................................... 7 3.1 Home page .............................................................................................................................. 7 3.1.1 General statistics ............................................................................................................. 7 3.1.2 General link...................................................................................................................... 7 3.2 Map (Plan) ............................................................................................................................... 9 3.2.1 Select the floor ................................................................................................................ 9 3.2.2 Filter the devices type to display ................................................................................... 10 3.2.3 Pass over the mouse over a device ............................................................................... 10 3.2.4 Click on a specific device to get its data inside the Device Information Modal ............ 11 3.3 Chart page ............................................................................................................................. 12 3.3.1 How to build a chart ...................................................................................................... 13 3.3.2 Save a chart ................................................................................................................... 14 3.3.3 Load a chart ................................................................................................................... 14 3.3.4 Group by functionality ................................................................................................... 15 4 Admin user guide........................................................................................................................... 16 4.1 The Map page ........................................................................................................................ 16 4.1.1 Add a device to the map ................................................................................................ 16 4.1.2 Removing a device from the map ................................................................................. 18 4.2 The technician page............................................................................................................... 19 4.2.1 Sorting the maintenance table ...................................................................................... 20 4.2.2 Hiding data that are accessible ..................................................................................... 20 4.3 The admin section ................................................................................................................. 21 4.3.1 Admin > Living Lab ......................................................................................................... 22 4.3.2 Admin > map > Add ....................................................................................................... 23 4.3.3 Admin > map > Edit ....................................................................................................... 24 4.3.4 Admin > Device > Add or Edit ........................................................................................ 25 4.3.5 Admin > User Management > Add ................................................................................ 25 4.3.6 Admin > User Management > Edit ................................................................................ 27 4.3.7 Admin > User Management > Edit ................................................................................ 28

Aim of the documentAim of the document Devices site - User guide 2/28

Aim of the documentAim of the document Devices site - User guide 3/28

Aim of the document

This document describes how to use the Devices site of the CREST project. Relevant public: all the Devices site users. The Devices site administrator. All those persons must be comfortable with a web site usage.

Aim of the documentGlossary Devices site - User guide 4/28

Glossary

Those terms are used during the explanation of the Devices site. You can go back to those definition during the reading of the document. Coordinator: Central unit point of a ZigBee network. This device collect all data submitted by sensors and put them in the database. Router: Unit in charge of relaying the data from the end devices or sensors. End device or sensor: Device that measures a specific data (temperature, humidity, presence, door

• pening/closing…)

Device: Generic term for talking about end device or router. Cluster: Device communication format used to exchange data between coordinator, router and end devices. Ex: the Relative_Humidity_Measurement cluster allows an end device to submit the relative percentage of humidity in the air to the coordinator.

1 Architecture overview

There are 3 mains parts in the architecture of the Living Lab as shown below:

Figure 1 Living Lab architecture overview.

• 1. The devices installation

These are the physical devices that are installed in the Living Lab.

• 2. The database

All data submitted by the devices are stored in the database.

• 3. The Devices site

This site friendly displays the data (temperature, humidity, electric consumption) stored in the database. This current document focuses on this part: Devices site usage. 1 2 3

Aim of the documentGeneral overview Devices site - User guide 5/28

2 General overview

2.1 Devices site access

In order to access to the web site, you must use this kind of URL: http://80.120.80.211/CREST

• r

http://location.crest-project.eu/CREST (if exists) Text in bold depends on the Living Lab you want to access. Please ask CESI to know your specific URL If you succeed you must see this home page:

Figure 2 Devices site home page

Aim of the documentGeneral overview Devices site - User guide 6/28

2.2 General overview

The Devices site is composed of 2 parts:  Header part This contains the main navigation and the login button.

Figure 3 Devices site header part (navigation and login section)

 Content part This contextual zone depends on which page the user is.

Figure 4 Devices site content part (depends of context)

Aim of the documentAll user guide Devices site - User guide 7/28

3 All user guide

In this chapter, we describe the pages that are accessible by every user and the content associated.

3.1 Home page

This page contains the general information of the Living Lab.

Figure 5 Home page

3.1.1 General statistics

Figure 6 General statistics

The first table displays:  The mean temperature, relative humidity, electric consumption and luminosity, for:

• The current day compared to the day before.
• The current week compared to the previous week.
• The current month compared to the previous month.

3.1.2 General link Below you can click on the icon to go to the specific page:

Aim of the documentAll user guide Devices site - User guide 8/28  map link Go to the map of the Living Lab.  Instantaneous consumption  Global consumption

Aim of the documentAll user guide Devices site - User guide 9/28

3.2 Map (Plan)

This page shows where the devices are localized in the different rooms. Values displayed shows the last value registered for each specific device.

Figure 7 map page

3.2.1 Select the floor Select which floor you want to display (here “Rez de chaussée” or “Sous-sol”):

Figure 8 : Selecting the map floor to display.

Aim of the documentAll user guide Devices site - User guide 10/28 3.2.2 Filter the devices type to display Then, you can filter the type of devices to display by ticking the combo box: Below an example of the same map filtered:

Figure 9 : Filtering type of devices to display with combo box. All devices (on left), all devices but presence and door opening state (on right)

3.2.3 Pass over the mouse over a device Passing the mouse over a specific device point display the images associated to the device. Therefore you can see where the devices are placed inside the room (or which kind of instrument is connected too for the ZPlug).

Figure 10: Mouse over a device point to see where it is located.

Aim of the documentAll user guide Devices site - User guide 11/28 3.2.4 Click on a specific device to get its data inside the Device Information Modal Click on the device point to see data of the last 24 hours of a specific device. You will see this modal dialog:

Figure 11: Popup of the device information.

Top of the modal contains the device information (name, type, IEEE address)

Figure 12: Top of the Device Information Modal: Device information.

Bottom of the popup contains the data from the beginning of the day (midnight).

Figure 13: Bottom of the Device Information Modal: Data from beginning of the day.

Inside that popup you can click on the

• button. You will be sent to the Chart page. For more

information, see next paragraph.

Aim of the documentAll user guide Devices site - User guide 12/28

3.3 Chart page

This is the MAIN page of the devices site. Indeed, you can build every chart you need for the animation you want to perform. This page is composed of 3 parts:  Chart Zone The chart is displayed here. It depends of the chart configuration done.  Save/load zone You can save the chart configuration if needed, in order to reuse it later.  Chart configuration zone This zone allows you to build the chart you need (for example, the temperature and luminosity of the meeting room from Monday the 10th 10 am to Tuesday the 11th 10 pm).

Figure 14: Chart page zones.

Aim of the documentAll user guide Devices site - User guide 13/28 3.3.1 How to build a chart By default, there is nothing displayed in the Chart zone. We will build a chart that display the temperature and luminosity of the AEC room from the 3rd of August 8:00 to the 4th of August 20:00. Go in the Chart configuration zone. Select the date from which you want to display by clicking on the calendar icon: Select the date Then click on the clock icon and select the time Do the same things with the “end date”. Once you set the dates, you can add the devices you want to show on the charts at those specific dates. In the Add a devices zone, select the device you want to put

Aim of the documentAll user guide Devices site - User guide 14/28 Once selected, the chart is updated with the data. 3.3.2 Save a chart When you are satisfied of your chart, you can save the chart configuration by clicking the Save button. You must save a file that keeps the configuration of your chart (begin date, end date, data displayed,…). The file as the extension .req. You must keep that extension. Give a name to the file that is understandable. For example:

Room 1B – temperature and luminosity from Oct 1st to Oct 5th.req

Save the file to a location you can remember. You will be able to load the chart later. 3.3.3 Load a chart For loading a chart you saved earlier, go on the chart page. Click on the Load a file button Select the file you saved earlier The chart is loaded and displayed.

Aim of the documentAll user guide Devices site - User guide 15/28 3.3.4 Group by functionality When you watch the datas for 24 hours, you need to see the all point of the chart. It is not the case if you watch datas for the all month. Therefore, you can group datas by 1,2,4,8,12,16,24 hours. This functionality lets you see a smooth chart.

Aim of the documentAdmin user guide Devices site - User guide 16/28

4 Admin user guide

All the functionalities presented are for user that have administration rights. Each admin user must log into the web site before accessing those pages. When you are logged in, you must see this panel

• n upper rights

4.1 The Map page

When you are logged in, you have another menu that appears on the Map page. The Admin Panel This panel allows you to add/remove device to/from the map. 4.1.1 Add a device to the map If you want to add a device, click on the + icon Then choose the device to add:

Aim of the documentAdmin user guide Devices site - User guide 17/28 Then click on the map where to put the device A message tells you when the device is added. Notice: The process of adding a device is more completely described in the document 3_CREST - Site des capteurs - Ajout retrait maintenance de devices.docx.

Aim of the documentAdmin user guide Devices site - User guide 18/28 4.1.2 Removing a device from the map On the map, click on the device to remove. A modal dialog appears Click on the Remove button. The device is only removed from the map. To completely delete the device from the device web site, see next sections.

Aim of the documentAdmin user guide Devices site - User guide 19/28

4.2 The technician page

This page is dedicated to maintenance operation. This page display all the data (temperature, humidity, electric consumption, luminosity, movement, opening/closing doors) that must be

• submitted. If a data is not submitted for more than 65 minutes, it is displayed in yellow.

By default, we use 65 minutes as a threshold. However you can dynamically change this threshold by setting the value in the Change timeout field. In the data table, each row represent a specific data (temperature, humidity, luminosity,…) of a specific device. The columns represents respectively:  INF_ID The unique id of the last data measured.  DEV_ID The unique id of the device.  UNI_ID The unique id of the data (there is 1 id for each data type (temperature, humidity,…)  DEV_LABEL The type of device

Aim of the documentAdmin user guide Devices site - User guide 20/28  DEV_LOCATION The name of the device. The name give the information on where it is placed in the living lab.  INF_VAL The value of the last data record. For example 22.3 for the temperature.  UNI_LABEL The label of the last data record. For example °C.  INF_DATE The date of the last record. In bold, we put the information that helps the most for the maintenance. 4.2.1 Sorting the maintenance table The table can be sorted (ascending or descending) by clicking on the header. By default, the table is sorted on the DEV_LOCATION. 4.2.2 Hiding data that are accessible When maintaining, it is useful to hide the data that are correctly submitting. For that, you just need to tick the box Hide the accessible elements. Therefore only data that are considered as “in fault” (the yellow ones) are displayed.

Aim of the documentAdmin user guide Devices site - User guide 21/28

4.3 The admin section

The admin section allows the admin user to add or remove content inside the device web site.

Aim of the documentAdmin user guide Devices site - User guide 22/28 4.3.1 Admin > Living Lab This part allows to add a Living lab. You must declare the Living lab inside that section before adding any other content inside the device web site. For adding the living lab, click on Add and fill the field Label and Country. Those information will appear on the Map (Plan) page. Once created, the living lab can’t be removed, you can only change information about it with the Edit section.

Aim of the documentAdmin user guide Devices site - User guide 23/28 4.3.2 Admin > map > Add You must create the map before putting some devices on it. For that click on Map > Add Then:  Choose the Living Lab (the one you created in previous step).  Give a name to the map. This name will appear in the map and map admin page.  Choose the image file that contains the map. Click on Add. The map is added, you can now add devices.

Aim of the documentAdmin user guide Devices site - User guide 24/28 4.3.3 Admin > map > Edit You can change information of existing map, like the image file or the map name. For that click on Map > Edit Choose the map to edit and click on Edit Then, you can change information you need:  Choose the Living Lab (the one you created in previous step).  The name to the map. This name will appear in the map and map admin page.  The image file that contains the map. Click on Edit to set the change.

Aim of the documentAdmin user guide Devices site - User guide 25/28 4.3.4 Admin > Device > Add or Edit The process for adding a device is described in documentation 3_CREST - Site des capteurs - Ajout retrait maintenance de devices.docx Please refer to the documentation for more information. 4.3.5 Admin > User Management > Add In order to add user that can manage the device web site, click on User Management > Add Then fill the different fields for creating the administration user

Aim of the documentAdmin user guide Devices site - User guide 26/28 The 2 combo box  Receive the alert of the failing sensors  Receive the daily report of the failing sensors Allow to respectively receive an email when:  A device has not submitted more than 1 hour.  The daily report about device « in fault » Click on Add for creating the user.

Aim of the documentAdmin user guide Devices site - User guide 27/28 4.3.6 Admin > User Management > Edit In order to edit an existing user that can manage the device web site, click on User Management > Edit Choose the user to edit and click Edit. You must either change the user information or the password. You can’t do both at once operation.

Aim of the documentAdmin user guide Devices site - User guide 28/28 4.3.7 Admin > User Management > Edit In order to delete an existing user that can manage the device web site, click on User Management > Edit Choose the user to edit and click Delete. After confirmation dialog, the user is deleted.