/Smart-Dormitory

Information System for monitoring and analysis of conditions for life in living areas

Primary LanguageC#

<<<<<<< HEAD #Smart Dormitory

##User Guide

Smart Dormitory

User Guide

3562041db26607dbec81750667fb0092006b5c56

Курсов проект изготвен от:

  1. Кристиан Кирилов, ФМИ, Информационни системи, ф.н.71818
  2. Николай Захаров, ФМИ, Софтуерно инженерство, ф.н. 62149

<<<<<<< HEAD

##Introduction

Introduction

3562041db26607dbec81750667fb0092006b5c56

Smart Dormitory is an information system that collects data from various sensors located in college dormitories all over the world. Data will be analyzed by independent research organization to evaluate the living conditions and map them to the performance of the students.

The Smart Dormitory application lets you create and conveniently visualize data from sensors for it to be further analyzed. With the Smart Dormitory app you can also: • Create sensors • Edit sensors • Visualize the sensors on the world map using Bing Maps • Track the current value of every sensor and observe all the sensors at once from the dashboard • Observe a lot of sensors at once and be informed if some of them have data out of the bounds of the sensor values.

<<<<<<< HEAD ##Getting Started ##System Requirements

Using the application

System Requirements

3562041db26607dbec81750667fb0092006b5c56

OS: Windows XP SP3 or newer with .NET 4.0 or newer installed Stable Internet Connection

<<<<<<< HEAD ##Launching the Application

Launching the Application

3562041db26607dbec81750667fb0092006b5c56

On application startup the user will be greeted by the Smart Dormitory logo:

After fully loading, the logo will disappear presenting the user with the Dashboard. This is where all sensors along with their data is visualized. Each sensor type is portrayed with a different gauge which displays the current value of the sensor and alerts the user with a contrasting color shift on abnormal values.

<<<<<<< HEAD

##Using the Menu

Using the Menu

3562041db26607dbec81750667fb0092006b5c56

Navigation between views of the application is contained within a drawer which can be opened by the hamburger icon located in the top left corner of the screen.

Its contents:

  1. Dashboard – this is the main page of the app where you can view all the followed sensors via animated gauges.
  2. Sensors – in this page you can add or edit sensors. Also, you can follow/unfollow them (toggle their visibility on the dashboard) or view a chosen sensor on the world map.
  3. Map – a world map made which shows the location of all sensors.
  4. About – a page about the creators and the people who helped throughout the development of this project.

<<<<<<< HEAD ##Application functionalities

Application functionalities

3562041db26607dbec81750667fb0092006b5c56

Creating new sensors can be achieved from the Sensors page. Upon pressing the circular green button in this view an input form will pop up.

<<<<<<< HEAD ##Creating a Sensor

Creating a Sensor

3562041db26607dbec81750667fb0092006b5c56

To add a new sensor, all fields in the form need to be filled out:

  1. Choose a proper Name for the sensor. Name must be at least 3 symbols.
  2. Choose a sensor Type from the Combo Box.
  3. Set Min and Max acceptable values for the sensor.
  4. Set Latitude and Longitude geocoordinates in decimal format for the sensor for its location to be displayed on the map.
  5. Link the sensor with a sensor from the Smart Dormitory API.
  6. Choose whether you want to track the sensor by tapping on the green button between the “Link with sensor” and “Description” fields.
  7. Add an informative and succinct Description of the sensor.

Once your desired and valid sensor information has been entered, choose Submit. If you wish to abort the creation of the sensor, press Cancel and all information entered will be discarded.

<<<<<<< HEAD ##Edit a Sensor

Edit a Sensor

3562041db26607dbec81750667fb0092006b5c56

You can choose to edit any sensor from the list you have provided in the Sensors page. Each sensor has a pop-up box menu where you can choose the command “Edit”.

Once your desired sensor information has been edited, choose Confirm. Or Cancel to discard changes.

<<<<<<< HEAD ##Using the Map

Using the Map

3562041db26607dbec81750667fb0092006b5c56

If you choose “Map” from the menu you will be navigated to the page which shows the locations of the sensors.

Each marker on the map has a tooltip providing brief information and current value of its assigned sensor.

<<<<<<< HEAD

##View on Map

View on Map

3562041db26607dbec81750667fb0092006b5c56

You can access the View on Map command from the pop-up box menu of every Sensor from the Sensors page.

<<<<<<< HEAD ##Deleting a Sensor

=======

Deleting a Sensor

3562041db26607dbec81750667fb0092006b5c56

You can choose to Remove a Sensor from the pop-up box menu of the sensor you wish to delete from the Sensors page. That will remove it from the Dashboard, Sensors and Map Page. This action cannot be undone.

<<<<<<< HEAD

##Software and resources used during development

Software and resources used during development

3562041db26607dbec81750667fb0092006b5c56

  1. Visual Studio 2017
  2. Telerik UI for WPF
  3. MaterialDesignThemes.2.5.0.1205
  4. MaterialDesignColors.1.1.3
  5. Bing Maps control for WPF
  6. GitHub

<<<<<<< HEAD

3562041db26607dbec81750667fb0092006b5c56