Report title

weaverchurchSoftware and s/w Development

Aug 15, 2012 (5 years and 3 months ago)

303 views

15
-
03
-
2013


Report title

Department of Electrical
Engineering and Information
Technology


Copenhagen University College
of E
ngineering

Lautrupvang 15, 2750 Ballerup



Report title

Subtitle

Team and Class


Report title and subtitle is defined by writing in the fields ”Title” and ”Subject” in
Document Properties. (Choose
F
ile > Propert
i
es > Summary).
Right click and
choose
Update Field
, to update the actual

field (on all subsequent pages).













Student name

Student number

Signature













Supervisor(s):


15
-
03
-
2013


Report title



1



Table of Contents

1.

INTRODUCTION

................................
................................
................................
...............................

3

1.1

S
YSTEM DESCRIPTION

................................
................................
................................
................

3

1.2

R
ISK MANAGEMENT

................................
................................
................................
..................

3

1.2.1

Microcontroller part

................................
................................
................................
.........

3

1.2.2

PC part

................................
................................
................................
...............................

3

1.3

M
ILESTONE PL
AN

................................
................................
................................
......................

4

1.3.1

Microcontroller part

................................
................................
................................
.........

4

1.3.2

PC part

................................
................................
................................
...............................

4

2.

USER MANUAL

................................
................................
................................
................................
..

5

2.1.1

Microcontroller part

................................
................................
................................
.........

5

2.1.2

PC part

................................
................................
................................
...............................

5

3.

REQUIREMENTS SPECIFI
CATION

................................
................................
..............................

5

3.1

M
ICROCONTROLLER PART

................................
................................
................................
........

5

3.2

PC

PART
S
YSTEM REQUIREMENTS S
PECIFICATION
(SRS)

................................
.........................

5

3.2.1

Functional requirements

................................
................................
................................
.

5

3.2.2

Use case model

................................
................................
................................
.................

7

3.2.3

Non functional requirements

................................
................................
.......................

12

4.

PROBLEM SOLUTION, MI
CROCONTROLLER PART

................................
...........................

13

4.1

H
ARDWARE

................................
................................
................................
.............................

12

4.2

S
OFTWARE

................................
................................
................................
...............................

13

5.

PROBLEM SOLUT
ION, PC PART

................................
................................
...............................

13

5.1

D
OMAIN MODEL

................................
................................
................................
......................

13

5.1.1

Class responsibilities

................................
................................
................................
.....

13

5.2

D
ESIGN MODEL

................................
................................
................................
........................

13

5.2.1

Solution classes/Interfaces

................................
................................
............................

14

5.2.2

State chart and activity diagrams
................................
................................
.................

14

5.2.3

Use case realization

................................
................................
................................
........

14

6.

PROBLEM SOLUTION, CO
MMUNICATION PROTOCOL

................................
...................

14

7.

TESTING

................................
................................
................................
................................
............

14

7.1

M
ICROCONTROLLER PART

................................
................................
................................
......

14

7.2

PC

PART

................................
................................
................................
................................
...

14

7.2.1

Acceptance Tests

................................
................................
................................
............

14

7.2.2

Unit Tests

................................
................................
................................
........................

14

8.

CONCLUSIO
N

................................
................................
................................
................................
..

14

8.1

P
RODUCT ORIENTED CONC
LUSION

................................
................................
.........................

15

8.1.1

Microcontroller part

................................
................................
................................
.......

15

8.
1.2

PC part

................................
................................
................................
.............................

15

15
-
03
-
2013


Report title



2


8.2

P
ROCESS ORIENTED CONC
LUSION

................................
................................
..........................

15

9.

LITERATURE

................................
................................
................................
................................
.....

15

10.

APPENDICES

................................
................................
................................
................................

15

10.1

G
LOSSARY
................................
................................
................................
................................

15

10.1.1

Microcontroller part

................................
................................
................................
.......

15

10
.1.2

PC part

................................
................................
................................
.............................

15

10.2

T
IME SCHEDULE
................................
................................
................................
.......................

16

10.2.1

Microcontroller part

................................
................................
................................
.......

16

10
.2.2

PC part

................................
................................
................................
.............................

16

10.3

A
CTION ITEM LIST

................................
................................
................................
...................

16

10.3.1

Microcontroller part

................................
................................
................................
.......

16

10
.3.2

PC part

................................
................................
................................
.............................

16

10.4

H
ARDWARE DIAGRAMS
................................
................................
................................
...........

16

10.5

S
OURCE CODE
VHDL

................................
................................
................................
.............

16

10.6

S
OU
RCE CODE
C/C++/
ASM

................................
................................
................................
......

16

10.7

T
EST RESULTS
,

MICROCONTROLLER PART

................................
................................
...............

16

10.8

T
EST RESULTS
,

PC

PART

................................
................................
................................
..........

16

10.8.1

Acceptance

Tests

................................
................................
................................
............

16

10.8.2

Unit Tests

................................
................................
................................
........................

17

10.9

S
OURCE CODE
J
AVA

................................
................................
................................
................

17


Note: The
Table of Contents
above

is automatically updated. So, do not change
anything on this page. The changes you make on the following pages are updated
when you right click on Table
of Contents and choose Update field. Remember to
format Heading 1, Heading 2 etc. (Choose format and Style)


15
-
03
-
2013


Report title



3


1.

Introduction

1.1

System description

(Describe briefly the complete system, what it consists of and how it works.)

1.2

Risk management

1.2.1

Microcontroller part

1.2.2

PC part


Risk

Probability

Impact

How to relieve the risk


Lack of knowledge among software
developers


High

Medium

Low


High

Medium

Low




Education, courses



Get help from the teacher.


Serial communication between to the AVR
Reader and APT server



High

Medium

Low


High

Medium

Low




Use library classes given by the teacher



Build a prototype


Within the Team the following issues are
present:



Team contract not present or
not operational.



The individual Team member
doesn’t know hers/his role.



Power
struggles among Team
members.



Bad communication


High

Medium

Low


High

Medium

Low




Set a clear
Team contract

from the
beginning



Ask the teacher for help



Open up with each other




Loss of data


High

Medium

Low


High

Medium

Low




Do systematic backups on
several
medias.



Use version control on local/
remote
server








15
-
03
-
2013


Report title



4


1.3

Milestone plan

1.3.1

Microcontroller part

1.3.2

PC part

… The table below shows the different UP phases and iterations in which the
complete PROG2
-
project has been divided into.

UP Phases

Inception

Elaboration

Construction

Iteration 1

Iteration 2

Iteration 3

Iteration 4

Iterations


For each iteration the table below shows, what tasks, deliverables and/or
achievements the individual iteration consists of.


Iteration

Tasks

Deliverables

Iteration 1


Start: 26/02/10

End: 09/03/10


Establish project objectives (Vision)

Identify critical project risks

Capture primary System Requirements

Includes:



Define primary SRS


Define Use Cases


Analyze Risks


Prioritize Use Cases


Project Report issue 1 including
:



Risk analysis



Primary SRS



Use Case Diagram and UC

specifications



Requirements Traceability Matrix.

Iteration 2


Start: 12/03/10

End: 13/04/10



Realize the basic core use case(s), e.g. receiving
requests generated by an AVR Reader simulator and
transmitting responses.

Includes:



Define Analysis Model



Define Preliminary Design Model



Run Unit Tests


Project Report issue 2 including:



Analysis Model



Class responsibilities



Use Case realizations



Design model



Test cases

Iteration 3


Start: 16/04/10

Ends: 07/05/10


Realize use cases relating to e.g. database access,
event logging.

Update/make:



Analysis Model



Class responsibilities



Design Model



Run Unit Tests


Project Report issue 3 including updated:



Analysis Model



Class responsibilities



Use Case
realizations



Design model



Test cases

15
-
03
-
2013


Report title



5


Iteration

Tasks

Deliverables

Iteration 4


Start: 11/05/10

Ends: 31/05/10


Complete use case realizations including GUI.

Update:



Analysis Model



Class responsibilities



Design Model

Run Test cases.

Perform acceptance testing



Project Report issue 4 finalization of
documentation and NetBeans project


Four copies of the project report with CD
containing NetBeans project should be
delivered by
12.00pm 31/05/10.


Conclusion on milestones plan
:

2.

User manual

2.1.1

Microcontroller part

2.1.2

PC
part

3.

Requirements specification

3.1

Microcontroller part

3.2

PC part System requirements specification (SRS)

3.2.1

Functional requirements

The table below defines the primary set of requirements.


Functional requirements

R1

The APT server shall identify the RFID tags
received from the AVR
reader as a personal, asset or unknown ID.

R2

The APT server shall respond on a personal ID tag by sending the
employee name and access authorization obtained from the database.

R3

The APT server shall respond on an asset ID tag by
sending the asset
description and authorized owner obtained from the database.

15
-
03
-
2013


Report title



6


Functional requirements

R4

The APT server shall receive a personal ID request within 1 second of
receiving an asset ID request, otherwise an asset RFID alarm event
response shall be sent.

R5

The APT
server shall respond whether the authorized owner of the
requested asset ID corresponds to a personal ID requested within 1
second prior to the asset ID request.

R6

The APT server shall respond with an unidentified RFID tag in case the
RDIF tag request is

not found in the database.

R7

The APT server shall log all requests and responses to a text file.

R8

The APT server shall include a timestamp on all the request and
response log details.

R9

The APT server shall be able to display the RFID
identification requests
and responses in real time.

R10

The APT server shall provide the functionality of creating, updating,

retreiving

and deleting database entries.




15
-
03
-
2013


Report title



7


3.2.2

Use case model


3.2.2.1

Use case specificatio
n

UC1:

ReceiveRequest

Brief description:

The APT Server receives an ID request from the RFID Reader.

Actors:

RFID Reader

Preconditions:

Connection to the database has been established.

15
-
03
-
2013


Report title



8


Main flow:

1.

Get the data from the serial connection.

2.

Identify and verify the ID tag against the database
.

3.

If
personal ID:

4.

Response contains employee name and access authorization.

5.

If receive asset ID within 1 second:

6.

If personal ID is authorized owner:

7.

Response contains employee name and access authorization

8.

Else:

9.

Send alarm response.

10.

If asset ID:

11.

Response contains asset description and authorized owner.

12.

If personal ID request with 1 second:

13.

If personal ID is authorized owner:

14.

Response contains employee name and access authorization.

15.

Else:

16.

Send alarm response.

17.

Else:

18.

Send alarm response.

19.

If unknown
ID:

20.

Response is unknown ID.

Postconditions:

Send response

data

to the
RFID Reader

Log request to log file with timestamp

Alternative flows:

Write any errors to a log text file

with a timestamp
.






UC2: SendResponse


Brief description:

The APT Server
sends a response to the RFID Reader.

Actors:

15
-
03
-
2013


Report title



9


RFID Reader

Preconditions:

Correctly received response data from the APT Server.

Main flow:

1.

Forward the response data to the RFID Reader.

Postconditions:

The response is correctly received by the RFID
Reader.

Log the response to a text file.

Alternative flows:

Write any errors to a log text file.



UC3:

CreateDatabaseEntry

Brief description:


The APT server creates a database entry at the request of the user.

Actors:

User

Preconditions:

The
database has been established correctly

There has to be a request for a new entry from the user

Main flow:

1.

Connect to the database

2.

Request of data from the user

3.

Add new entry to

the database

4.

Close database

5.

Handling error occurrence

Postconditions:

The
new entry has been added in the database system

Alternative flows:

The user should be able to cancel the user entry at any time

The user will be informed of the entry cancellation in case of an error occurrence
and close the connection



15
-
03
-
2013


Report title



10


UC4:
DeleteDatabaseEntry

Brief description:

The APT server deletes a database entry at the request of the user.

Actors:

User

Preconditions:

The database has been established correctly

There has to be a request for deleting a new entry from the user

Main
flow:

1.

Connect to the database

2.

Request of data from the user

3.

Delete new entry to the database

4.

Close database

5.

Handling error occurrence

Postconditions:

The new entry has been deleted in the database system

Alternative flows:

The user should be able to
cancel the entry deletion at any time

The user will be informed of the entry delete cancellation in case of an error
occurrence and close the connection


UC5: UpdateDatabaseEntry

Brief description:

The APT Server edits a database entry at the request of
the user.

Actors:

User

Preconditions:

Connection to the database correctly established.

There has to be an update data entry request from the user.

Main flow:

1. Get data from user.

2. Update data to database.

21.

Close database connection.

Postconditions:

15
-
03
-
2013


Report title



11



Alternative flows:

Inform user of error.

Close database connection.



UC6:

ShowDatabase

Brief description:

The APT server shows the database entries fort the user and asset ID’s at the
r敱ues琠潦⁴he⁵s敲.

Actors:

User

Preconditions:

The database has been established correctly

There has to be a request for viewing the entries from the user

1.

Connect to the database

2.

Show the entries of the database

3.

Close database

4.

Handling error occurrence

Postconditions:

The user can view the database

entries

Alternative flows:

The user should be able to cancel the database view at any time

The user will be informed of the database view cancellation in case of an error
occurrence and close the connection


UC7:

ShowServerActivity

Brief description:

The APT server will show the request and response activity in real time to the users.

Actors:

User

Preconditions:

No server errors

Main flow:

15
-
03
-
2013


Report title



12


1.

Show real time activity of requests and responses occurring on the APT
server

Postconditions:

User can view
the server activity in real time.

Alternative flows:




3.2.2.2

Requirements tracing

...(Table showing the correspondence between the functional requirements and
the
use

case model)




UC1

UC2

UC3

UC4

UC5

UC6

UC7

R1

x







R2

x

x






R3

x

x






R4

x







R5

x







R6

x







R7

x







R8

x







R9







x

R10



x

x

x

x



3.2.3

Non functional requirements

Non functional requirements

NR1

The APT server module shall interface with a JavaDB database.

NR2

All functionality of the APT server shall be
provided with a Graphical
User Interface.



15
-
03
-
2013


Report title



13


Non functional requirements









4.

Problem Solution, Microcontroller part

Hardware

4.1

Software

5.

Problem Solution, PC part

5.1

Domain model

... (Explain what the domain model is and how the classes were found in the
model)

5.1.1

Class
responsibilities

Class name: xx


Responsibility:

xxx

Collaboration:

xxxx


5.2

Design model

... (Describe the design model and how it was determined i.e. consideration of
inheritance, interfaces and design patterns in order to achieve a design having a
low c
oupling and a high cohesion.

Only the most important classes, interfaces, attributes and methods are shown in
the diagram)

15
-
03
-
2013


Report title



14


5.2.1

Solution classe
s/Interfaces

… (List and explain the solution classes and interfaces)

5.2.2

State chart and activity diagrams

...(
Show and
describe the state machines used using state transition diagrams etc
)

5.2.3

Use case realization

... (
S
how and describe a sequence diagram for each use case)

6.

Problem solution, Communication protocol

…(
Describe the communication protocol used to send data betwee
n the AVR
Reader and the APT server system)

7.

Testing

7.1

Microcontroller part

... (Describe test strategies. Refer to detailed test results in appendix)

7.2

PC part

7.2.1

Acceptance Tests

…(
Define the acceptance tests. Include and refer to
detailed test results in

the

appendix)

7.2.2

Unit Tests

... (Describe
the
test strategies
.

Include and r
efer to detailed test results in
the
appendix)

8.

Conclusion

15
-
03
-
2013


Report title



15


8.1

Product oriented conclusion

8.1.1

Microcontroller part

8.1.2

PC part

...
(Remember:



List all future improvements



List all know errors)

8.2

Proce
ss oriented conclusion

9.

Literature

10.

Appendices

10.1

Glossary

10.1.1

Microcontroller part

10.1.2

PC part

PC Glossary

APT

Asset and Person Tracking system

GUI

Graphical User Interface
















15
-
03
-
2013


Report title



16


10.2

Time schedule

10.2.1

Microcontroller part

10.2.2

PC part

10.3

Action item list

10.3.1

Microcontroller part

10.3.2

PC part

10.4

Hardware diagrams

10.5

Source code VHDL

... (May be included on a CD)

10.6

Source code C/C++/asm

... (May be included on a CD)

10.7

Test results, microcontroller part





10.8

Test results, PC part

10.8.1

Acceptance

Tests


TC1: Testing R10

Tested by
:


Purpose
:


15
-
03
-
2013


Report title



17


Test
sequence:


Description of the
expected result:



Result of the test.


Testers comments:

.



10.8.2

Unit Tests

…( Documentation data from Unit Tests)

10.9

Source code Java

(On CD only)