Assignment5

Design Document for Monitoring and Controlling systems of environment project

!Group#09

Azamat Anuarbekov (AA): %marks

Zhassar Daulet (ZD): %marks

Mukhtassyrov Aktlek (MA): %marks

Vassilaki Sergey (VS): % marks

Nurym Abay (NA): % marks

!To all our nieces and nephews, who we hope will make a more understandable world. )) (AA)

!

!!!!

Version Date Author Change

0.1 04/04/15 SM Initial Document

Table of Contents 1. Introduction 3 ................................................................................................................................................1.1. Purpose 3 1.2. Scope 3 1.3. Definitions, Acronyms, Abbreviations 3 ......................................................................................................................1.4. Design Goals 4 ..............................................................................................................................................................

2. References 5 ...................................................................................................................................................3. Decomposition Description 6 .......................................................................................................................3.1. Module Decomposition 6 .............................................................................................................................................3.2. Concurrent Process 7 ....................................................................................................................................................3.3. Data Decomposition (AA) 9 .........................................................................................................................................3.4. STATES 9

4. Dependency Description 10 ..........................................................................................................................4.1. Intermodule Dependencies 10 ......................................................................................................................................4.2. InterProcess Dependencies 10 ......................................................................................................................................4.3. Data Dependencies 10 ..................................................................................................................................................

5. Interface Description 11 ...............................................................................................................................5.1. Module Interface 11 ......................................................................................................................................................5.2. Process Interface 11 ......................................................................................................................................................

6. Detailed Design 12 .........................................................................................................................................7. Design Rationale 13 ......................................................................................................................................7.1. Design Issues 13 ...........................................................................................................................................................7.2. WEb Application (AA) 13 ............................................................................................................................................

8. Traceability(AA) 14......................................................................................................................................

Project Traceability Page ! of !2 14

1. Introduction

1.1. PURPOSE

The purpose of this document is to explain the design and architecture of the «Monitoring and

controlling systems of environment» application.

1.2. SCOPE

This document covers system decomposition, interfaces, and dependencies, as well as design

rationale.

1.3. DEFINITIONS, ACRONYMS, ABBREVIATIONS

!

Term Description

Code libraries A library is a chunk of code that is specifically written to do a common task. Sensor code libraries give makers the means to access the functions of a sensor (as well as other electronic components) fairly confidently, because the code has been tested by the author and updated by people who use it.

User A person who uses monitoring and controlling systems of environment.

Database A database is a collection of data for one or more multiple uses, where

database tables are stored

GUI Graphical User Interface – graphical interaction between system and

user

Table Table is a set of data elements (values) that is organized using a model

of vertical columns (which are identified by their name) and horizontal

rows

Server Computer where database is located


1.4. DESIGN GOALS

!1. Reliability: The systems processes should work uniformly, the loss of users information

through network must be preventedUsability: The system should give easiness to use, even

inexperienced users won’t feel discomfort

2. Maintainability: Our code must be well organized with consistent syntax and relevant

naming techniques.

3. Extensibility: All parts in the application must assist in extension and adding new properties

4. Response Time: All Web pages must load less than 30 seconds.Short response time, users

page update time must be very short including database processing time

5. User Privacy: There’s no privacy. Everyone can see the data.

6. Maintainability - Applications code should be well organized, so that it will be easy to

change, provide bug fixes


2. References

[NONE]


3. Decomposition Description

3.1. MODULE DECOMPOSITION

The project has an inherent client-server architecture, but there will be little or no client code.

Therefore, the architecture of the server is the most important aspect of architecture. We turned

down a repository architectual design (centralized around the database) and decided upon a layered

(though not clear in the diagram) architecture allowing better interchangability of our database.

This design has three layers. The first contains the PHP Code. The second contains only the

Libraries module, which provides services to the PHP Code in the layer above. The third layer

contains the Database, which provide services to the layer above through the database libraries.

(AA)

3.1.1. PHP Code Description (AA) It uses libraries to get/send information from/to database.

1.Listening for database changes

2. Send message to update sub-system if database was changed

3. To find out which panel should be changed


3.1.2. Libraries Description(AA)

A library is a chunk of code that is specifically written to do a common task. Sensor code libraries give makers the means to access the functions of a sensor (as well as other electronic components) fairly confidently, because the code has been tested by the author and updated by people who use it.The libraries modules contains the classes and functions needed by the PHP Code.

1. Provide PHP to connect to server

2. Provide PHP to connect to server 3.1.3. Database Description(AA) Database (MySQL) is used to store all the data.

1. Storing all the data

2. On request it will return corresponding data

3.2. CONCURRENT PROCESS

3.2.1. Web page description (AA) My web is the main page (index.php) of the application. It displays the data , and has an «Save/

Share it" form below it. In this form, the user can either share and save data.

1) Share data

Share data allows users to share all their information with other users .

2) My web application shows to user information about environment parameters . And it includes

this characteristics:

1) temperature monitoring;

2) humidity monitoring;

3) water(rain,level of water) monitoring;

4) radiation monitoring;

5) vibration monitoring;


6) noise, sound monitoring;

!!!!!!


3.2.2. Database description (AA) The database is a single process run on a remote server.

3.3. DATA DECOMPOSITION (AA)

[NA]

3.4. STATES

3.4.1. PHP Pages State See Screen Flow from Screen Shots Document


4. Dependency Description

!4.1. INTERMODULE DEPENDENCIES

!4.2. INTERPROCESS DEPENDENCIES

4.3. DATA DEPENDENCIES


5. Interface Description

5.1. MODULE INTERFACE

5.1.1. PHP Code Interface(AA) 5.1.1.1 The PHP Code interfaces with the Database through the libraries [see 5.1.2.1]

5.1.1.2 The PHP Code interfaces with PHP super global variable sets

$_POST and $_GET

5.1.1.3 Data passed using $_POST

5.1.1.4 Data passed using $_GET

5.1.2. Libraries Interface (AA)

5.1.2.1 Interfaces between PHP Code <...Library...> Database :

5.1.2.1.1 public function createTables($temperature,$humidity,$sound,$water,$noise, $radiation, $vibration);

Creates tables in the database.

5.2. PROCESS INTERFACE

5.2.2.1. PHP Code Process

Description: This process shows all graphical interface of the system

5.2.2.1.1. Process is created when the application started

5.2.2.1.2. Terminated when applications close button is pressed

5.2.2.1.3. All other threads will be killed if this main thread stops

5.2.2.2. Database Listener Process

5.2.2.1 This thread is created after Main process acquires all information from Database

5.2.2.2 Database listener process interacts with panel Updater process

5.2.2.3 This process will be terminated automatically if Main thread of process is


6. Detailed Design

!NOT REQUIRED

!


7. Design Rationale

!7.1. DESIGN ISSUES

!!7.2. WEB APPLICATION (AA)

7.2.1. Description

Our Application depends on being able to visually display data to the user. !7.2.2. Factors affecting Issue

7.2.2.1 Difficulty of programming in selected medium

7.2.2.2 Compatability with PHP

7.2.2.4 Potential for interactivity

7.2.2.5 File Size

7.2.3. Alternatives and their pros and cons\

[NA]

7.2.4. Resolution of Issue

[NA]

!


8. Traceability(AA)

!

!!FEEL FREE TO ADD APPENDICES AS NEEDED. UPDATE TOC BEFORE SUBMITTING

No Use Case/ Non-functional Description Subsystem/Module/classes that handles it

1 Notification PHP Code - WEP page & Libraries- Database Libraries

2 Share data PHP Code - WEP page & Libraries- Database Libraries

Save data PHP Code - WEP page & Libraries- Database Libraries

Monitor data PHP Code - WEP page & Libraries- Database Libraries

Setup device User


Assignment5

Documents

Transcript of Assignment5