Professional Documents
Culture Documents
Example Software Engineering Paperwork
Example Software Engineering Paperwork
Members:
1. AFIQ AIMAN BIN ZAMRI
19071
19103
18856
19141
Page 0
Page 1
1.0
INTRODUCTION
1.1
Project Overview
1.2
Project Deliverables
2.0
3.0
PROJECT ORGANISATION
2.1
2.2
2.3
10
11
3.1 Tasks
3.1.1 Task
11
3.1.1.1 Description
11
11
12
12
13
Page 2
2.0
INDTRODUCTION
19
1.1.
Product overview
19
1.2
Scope
19
SPECIFIC REQUIREMENT
20
2.1.
20
2.2.
21
ADDITIONAL MATERIAL
24
30
1.0
INTRODUCTION
32
2.0
33
33
43
3.0
3.1
37
44
45
47
Page 3
4.0
2.0
INTRODUCTION
50
1.1.
System Overview
50
1.2.
Testing Approach
51
TEST PLAN
2.1
Features to be tested
52
2.2
52
2.3
53
3.0
TEST CASES
65
4.0
67
VI REFERENCES
69
Page 4
Page 5
2 PROJECT ORGANISATIONS
2.1 Software Process Model
10
11
11
12
12
13
3.2 Assignments
14
3.3 Timetable
15
Page 6
This idea came up when we notice that there are quite some time it happened that the
laboratory door is not open and the students have to wait until the lecturer came because only
the lecturer or security department (control room) have the access to the door. This project is
to create a system for laboratory door as well light which can control the behavior of those
particular appliances. The system can be controlled from a distance and the controller will be
included in the system as well. The controller is a web that will be associated with the
system and use Wi-Fi as connection medium. The concept that we are going to implement is
Internet of Things (IOT), which allow the specific user to have control over the appliances
from far, as long as the connection to the internet is accessible. When you access the
webserver from your browser of choice, you will have a big button that triggers the
laboratory door via a relay. We will wire a very basic circuit to the Pi's GPIO pins and upload
a website that triggers the circuit. When the relay is triggered, it closes the circuit hooked up
to the laboratory door motor and opens the door.
This project will be used for our targeted group that is our security department, for them to
easily open the door and lighting from far. We must buy the breadboard, relay, raspberry pi,
wire and laboratory motor. Then, we will combine the apparatus and we will use HTML, CSS
and JavaScript for the. While for the raspberry pi will use Webiopi application in the
Raspberry pi to control the GPIO pin inside the pi. Lastly, to connect the pi and the web using
HTML and REST API. The cost for this project is less than RM 50.00 for small scale project.
This project will be tested using prototype. The due for this project is the end of this August
Page 7
2 PROJECT ORGANISATIONS
Our project will follow an incremental and an iterative development model for its
deliverables. The development will be done in several phases and each phase will represent a
complete development cycle, with certain functionality of the system delivered at the end of
each phase. Additionally, the project phases with start, finish dated and goals for each phase
are outlined in table below.
Phase
Project startup
Phase goals
-
Strategy planning
regarding
automation system
Requirement
Phase 1
Component characterization
format
Phase 2
Constraint checker
Page 8
Final touch up
Each of the team members will create a list of tasks to be completed for the upcoming phase
of the project. Then the time for each task will be allocated, followed by the workload
balancing of the tasks. At the completion of each phase a postmortem analysis will be done to
analyze the previous phase. All tasks that we not completed during a phase will be recorded
and scheduled for completion in the upcoming phase.
List of responsibilities
-
Development manager
Planning manager
Page 9
Process manager
Support manager
Additional tools that will be used are: breadboard, relay, raspberry pi , wire and laboratory
motor. Then, we will combine the apparatus and we will used HTML , CSS and JavaScript
for the. While for the raspberry pi will use Webiopi application in the Raspberry pi to control
the GPIO pin inside the pi. Lastly, to connect the pi and the web using HTML and REST
API.
Page 10
3.1 Task
3.1.1 Task -1
3.1.1.1 Description
The aim of this project is to help the Security department to create a system for
laboratory which can control the behavior of those particular appliances. The system can be
controlled from a distance and the controller will be included in the system as well. There are
a lot of risks and constraints that need to overview about the production so that it is inclined
with what we want to achieve.
Milestone
Complete
Date
gathering 15/ 06/ 2015
Description
All requirement for the security to
requirements
prototype
its functionality
prototype
software prototype
debugging
the
prototype
Complete production
Complete
the
prototype
and
Page 11
documentation
operations
transitioned
group
to
to
begin
production
There are constraints that may arise along the way of our project because of resources needed
for the project that cannot be obtained and maintained.
Firstly, time constraints. The time given from end of May until early August 2015.
Actually we only given 2 months to complete this project with our 18 credit hour this sem.
We also rarely manage to meet the client because of time constraints and unavailability of
both parties. So this will make there possibilities for us to not meet clients requirement or
misunderstanding from the clients requirement.
Next, the limitation of UI or design on the web itself. It is because the CSS code
hardly or cannot overwrite and need to built it in CSS application of Webiopi that was the
software for the pi. Webiopi is a component that will interact the pi with the HTML code
from the web. So we need to have Webiopi application.
Page 12
There are a lot of risks need to be taken note when seeing the clients or any stakeholder.
Firstly, when we use an electrical apparatus, we have to take note the voltage used. If
the voltage used or output voltage is higher from input voltage, the raspberry pi will crash or
broken and not working. So to prevent our hardware easily crash, we must take care all about
that. This also one way how we want to make our project more productive and prevent for
wastage in term of buying extra things because of the experiment was not going well.
Then, project management process. We have to well plan our project so that
everything within the time frame given and will not delay. This is the important of team
leader to make sure everything is in the right places to prevent from delay of the project. We
also can make a Gantt chart to make our schedule more visible and revisable for everyone.
We also must make a correct budget and allocate correctly within our budget as a student.
Page 13
Nazmi Asri is assigned as the Project Manager who will do the technical part of
preparing materials for the prototype. The rest of the team acts as System Analysts, as
required at the current level of development of the system. Under Nazmis
supervision, Khalida Adeeba leads the estimation of project size, effort and schedule
in the project management area. Amelia designed the work plan and developed the
Gantt chart which is approved by the project manager and the team members. Afiq
gathers the requirements mostly via the observations of the current system. From the
substances gathered, Suhaili leads the process of preparing the requirement definition
document. The review of the system is finally prepared by Afiq based on the
planning, analysis and design of the system that has been made and approved by
Nazmi Asri.
Page 14
Name
Job scopes
Time
Nazmi
1 Week
Afiq
4 Days
Adeeba
1 Week
Suhaili
1 Week
Amelia
1 Week
Nazmi
2 Weeks
Nazmi
ALL
1 Month
Afiq
Page 15
Table of Contents
LABORATORY AUTOMATION SYSTEM
Page 16
2.
3.
INTRODUCTION
19
1.1
Overview
19
1.2
Scope
19
SPECIFIC REQUIREMENTS
20
2.1
20
2.1.1
User Interfaces
20
2.1.2
Hardware Interfaces
20
2.1.3
Software Interfaces
21
2.1.4
Communications Protocols
21
2.2
21
2.3
21
2.3.1
Reliability
22
2.3.2
Availability
22
2.3.3
Security
22
2.3.4
Maintainability
22
2.3.5
Portability
23
2.3.6
Performance
23
ADDITIONAL MATERIAL
24
Page 17
24
25
Page 18
INTRODUCTION
1.1
Purpose
The purpose of this SRS is to provide details about the workings of the Laboratory
Automation System. The details are to be sufficient enough that the system (including the
components) to be built. It is intended to be readable by the developer team involved. This
document provides the description of the system, laying out the functional and non-functional
requirements and use cases that describe the interactions the users will have with the
software.
1.2
Scope
The product to be produced is a Laboratory Automation System. This system will basically
allow the behavior of particular appliances to be controlled from a distance. Basic properties
and features will be described, which include the concept, medium of connection and
controller as well as the components, the actions it is suggested to, and shall perform. The
system is aimed to help security department to easily control the particular appliances
behavior and reduce time consumption in order to move from one to another laboratory in
comparison to a conventional manual door.
Page 19
This section shall describe the interface requirement for the laboratory automation
system. They specify the way the user shall interact with the system as well as define
the necessary hardware interfaces and communication interfaces required by the
software to support the main function.
2.1.1
User Interfaces
The user interface shall follow basic Window style and functionality
conventions. The interface has two buttons on the screen with necessary
description to be provided on how to use the system. User need to login using
the given username and password before making any command. One button
will represent light and another one for door. The color of the button means;
green for on and red for off. Each click of the button will trigger the behavior
of the appliances thus perform the desired action. For example, when the user
click on the button light (in color of red), the button will trigger the light in the
laboratory room to be turned on. Thus the color of the button will change to
green, means the light is on.
2.1.2
Hardware Interfaces
The system will be using a controller which can control the appliances from a
distance. This controller will be connected through Wi-Fi connection and
perform action received by webserver using basic networking protocols.
Page 20
2.1.3
Software Interfaces
The system is using the concept of Internet of Thing (IoT) which control the
behavior of things using the medium of Internet connection. The webserver
shall be able to be accessed from any type of operating system as long as there
is web browser. The web should be able to be accessed from anywhere and
anytime. The webserver can be open using mobile android or web.
2.1.4
Communications Protocols
The button feature in the webserver shall perform it function based on the
desired outcome. The green button shall only be able to be activated when the
door is locked and vice versa. The security system must be ensured by
providing the security department with a proper login username and password
to prohibit ant unauthorized access.
2.2
Contact detail
Description on usage
Page 21
2.3
Reliability
The system is expected to be reliable to use over time and not sensitive that
prone to cause failure. 2.3.2
Availability
2.3.3
Security
Only authorized people especially from security department can access
the webserver and gain the login information
Fail authentication login more than 3 times should be blocked and alert
notification will be sent to main control room
2.3.4
Maintainability
The system uses a single page webpage which is not complex and
eases the maintenance.
Page 22
Portability
The webpage can be opened in any operating system available along as
there is web browser.
2.3.6
Performance
The system should respond to action made by user with no delay more
than 20 seconds
Page 23
ADDITIONAL MATERIAL
Page 24
Page 25
Page 26
Page 27
Page 28
Page 29
Page 30
2.
3.
INTRODUCTION
32
1.1
32
Design Overview
33
2.1
33
43
3.1 Component
43
4.
44
4.1
44
45
47
Page 31
Page 32
This system works anywhere as long as there is internet access, it is a web based so it
is applicable for mobile phones as well as personal computer. This idea came up when we
notice that there are quite some time it happened that the laboratory door is not open and the
students have to wait until the lecturer came because only the lecturer have the access to the
door. This project is to create a system for laboratory door which can control the behaviour
of those particular appliances. The system can be controlled from a distance and the
controller will be included in the system as well. The controller is a web or a mobile
application that will be associated with the system and use Wi-Fi as connection medium. The
concept that we are going to implement is Internet of Things (IOT), which allow the specific
user to have control over the appliances from far, as long as the connection to the internet is
accessible. The platform that we are using is web, the code is written in html and JavaScript
and using mobile using Android for the security easily access everywhere and anytime. We
also used Raspberry Pi as the controller which is easy for us access that is connect through
Wi-Fi. When you access the webserver from your browser of choice, you will have a big
button that triggers the laboratory door via a relay. We will wire a very basic circuit to the
Pi's GPIO pins and upload a website that triggers the circuit. When the relay is triggered, it
closes the circuit hooked up to the laboratory door motor and opens the door.
Page 33
Page 34
Activity Diagram
Page 35
Page 36
Page 37
Page 38
Page 39
Page 40
Page 41
Page 42
Raspberry Pi
-
The Raspberry Pi is a low cost, credit-card sized computer that plugs into a
computer monitor or TV, and uses a standard keyboard and mouse. It is a capable
little device that enables people of all ages to explore computing, and to learn how
to program in languages like Scratch and Python.
Page 43
Page 44
Page 45
Page 46
* Contact detail
* Description on usage
Page 47
Page 48
50
51
2 TEST PLAN
2.1 Features to be Tested
52
52
53
2.3.1
54
2.3.2
54
2.3.3
55
2.3.4
56
2.3.5
57
2.3.6
58
2.3.7
59
2.3.8
60
62
3 TEST CASES
3.1 Case 1
65
3.1.1 Purpose
3.1.2 Inputs
3.1.3 Expected Outputs & Pass/Fail criteria
3.1.4 Test Procedure
Page 49
66
3.2.1 Purpose
3.2.2 Inputs
3.2.3 Expected Outputs & Pass/Fail Criteria
3.2.4 Test Procedue
4 ADDITIONAL MATERIAL (including appendix A)
APPENDIX A. TEST LOGS
4.1 Log for test case 1
67
68
Page 50
To demonstrate on how to use the system to the authorities like in this case is the
security department.
Page 51
Document Identifier
Document Title
[Ref1] ID
Authorities ID
[Ref2] Password
Authorities Password
[Ref3] Light
[Ref4] Door
Document Identifier
[STD1] Password
Document Title
This password for guards are important for them to unlock
the door and switch on the lights
Page 52
TEST PLAN
2.1 Features to be tested
For Lab Auto System, the guards will need their ID number and password in
order for them to have the accessibility to the system. Only one computer can operates
the system at one time. This is to avoid from misuse from any party that trying to play
around with the system and to maintain the level of security at the lab. Whenever the
guards are login, they will proceed to a webpage that consist a simple buttons of lights
and doors. That buttons have 2 different colors; red and green. Red color indicates the
switch is OFF while green in color indicate the switch is ON.
2.2 Features not to be tested
As our concern, due to time constraint and limited funding, the face
recognition is unable to be tested as we cant get the right time to meet the guards for
a proper photograph session as it will be used for the face recognizing. Moreover, due
to limited time we also unable to find a cheap IP camera and suitable for our project.
Page 53
2.3.2
Page 54
that
have
been
showed
in
the
development
documentation.
2.3.3.3.1
2.3.3.3.1.1
Outgoing links
2.3.3.3.1.2
Internal links
2.3.3.3.1.3
Anchor links
2.3.3.3.2
2.3.3.3.2.1
2.3.3.3.2.2
2.3.3.3.2.3
2.3.3.3.2.4
Page 55
2.3.4.1.2
2.3.4.1.3
Test the system should not display the error message for
optional fields.
2.3.4.2.2
2.3.4.2.3
2.3.4.2.4
2.3.4.2.5
Page 56
2.3.5.1.2
2.3.5.1.3.2
Test
the
HTML
version
being
used
is
2.3.5.1.4
Page 57
2.3.6.1.2
2.3.6.1.3
2.3.6.1.4
system
or
component
with
specified
performance
requirements.
2.3.6.2.1
2.3.6.2.2
To
evaluate
product
and/or
hardware
to
Page 58
Usability testing has now become a vital part of any web based
project. It can be carried out by testers by our team or a small
focus group of authorities of the web application.
2.3.7.1.1
2.3.7.1.1.1
2.3.7.1.2
2.3.7.1.2.1
2.3.7.1.2.2
2.3.7.2.2
2.3.7.2.3
2.3.7.2.4
Page 59
2.3.7.2.6
2.3.8
Figure 1: Username and password are needed to login into the page
Page 60
Page 61
2.3.9.2 White box testing are involves the testing of the software/system code
for the following:
2.3.9.2.1
2.3.9.2.2
2.3.9.2.3
2.3.9.2.4
Expected output
Page 62
2.3.9.2.6
2.3.9.3
2.3.9.3.1.1
2.8.3.1.1.2
2.3.9.3.2
2.3.9.3.2.1
2.3.9.3.2.2
2.3.9.3.2.3
Page 63
2.3.9.3.5
Page 64
3.1.2 Inputs
Securitys username
Securitys password.
Security should be able to login successfully and the system will display the
home screen back.
The process failed if the security are not able login (not because of wrong
username or password)
Press enter
Page 65
3.2.2 Inputs
Securitys Username
Securitys password.
Security should be able to login successfully and the system will display the
home page back.
The process failed if the Security are not able to login (not because of wrong
username or password)
Press enter
Page 66
Expected Result
Actual
Comment
Result
Username= webiopi
Successfully
Password=rahimi432
Passed
system
Username= webiopi
Unsuccessfully
Password=tingtang143
system
Page 67
Expected Result
Actual
Comment
Result
FAILED Couldnt
log
in
Username=webiopi
Unsuccessfully
Password=rahimi432
because
system
functions at control
it
only
Page 68
Page 69