SCIENCE AND TECHNOLOGY

EDUCATION

Arduino Based Keycard Scanner

with Sound Detector (A.K.S.S.D)
Guideline on the Structure of the Report
Cassandra Jazmine Fuentes

Angel Dione Bleeh S. Laga-ac

Justin P. Vale

Theresa Jade P. Bastillada

Format for Documentation of Robot Development Page 2

Table of Contents
INTRODUCTION..................................................................................................................................3
2.0 REPORT FORMAT.....................................................................................................................3
2.1 FRONT PAGES......................................................................................................................3
2.1.1 Cover Page...................................................................................................................4
2.1.2 Table of Contents........................................................................................................4
2.1.3 List of Figures...............................................................................................................4
2.1.4 List of Tables................................................................................................................4
2.2 MAJOR SECTIONS................................................................................................................5
1.0 Introduction.....................................................................................................................5
2.0 Robot Construction..........................................................................................................5
3.0 Design Specification.........................................................................................................6
4.0 Design Process.................................................................................................................6
Performance Results and ‘Discussion......................................................................................6
6.0 Conclusion........................................................................................................................7
7.0 Recommendations...........................................................................................................7
2.3 END PAGES...........................................................................................................................7
2.3.1 Reference.........................................................................................................................7
2.3.2 Appendices.......................................................................................................................7

Format for Documentation of Robot Development Page 3

 INTRODUCTION

Arduino based Keycard Scanner with Sound Detector (AKSSD) is a keycard scanner for
home security that provides convenient and secure access control, offering features such
as a sound detector to alert homeowners of suspicious activity, providing a comprehensive
security solution. Thus, homeowners can now have a more safe and reliable security
system than the old lock and key. The sound detector activates when a user approaches,
and a green light signals a successful keycard scan. If the card is invalid, a buzzer sounds,
and the light turns red.

The two main purposes for writing this report are to:
1. Document your robot design and
2. Demonstrate improved report writing skills.

2.0 REPORT FORMAT

The technical report should be a professional document with graphs, tables, and
drawings used to clarify the text. The three main parts of a technical report are shown
below in Figure 1:

I. Front Pages II. Major Sections III. End Pages

9, 10, 11…..
(References)
A1, A2, B1, B2……
(Appendixes)

ii, iii, iv…… 1, 2, 3, 4……..

Figure 1. Three Main Sections of a Final Report

2.1 FRONT PAGES

The front pages include (i) the Cover Page; (ii) Table of Contents; (iii) List of Figures;
and (iv) List of Tables. The page numbers are Roman (e.g., i, ii, iii, etc.) and there are no

Format for Documentation of Robot Development Page 4

numbers on the cover page (although it is considered the first page). The following is a
sample of the front pages (Figure 2):

Cover Page Table of Contents List of Figures List of Tables

List of Figures Fig. 1. Graph…3 Table 1. Wt.......2
…iv Fig. 2 Proto…..6 Table 2. Memb…5
List of Tables Fig. 3. Final…..7 Table 3. Cost......8
….v
Executive Su…1
Introduction….2
(list other
sections)

Figure 2: Sample Front Pages

2.1.1 Cover Page

The first page of the technical report should be unnumbered and should include:
 Design to Specification Report (name of the report)
 Group Number:
 Names of all your group members:
 Date:
Each item should be centered and separated by enough space to fill the whole page and
give the cover page a good appearance. The group number is to discriminate the groups
from the same institution or organization that present robots for the competition.

2.1.2 Table of Contents

This is a listing of the major sections in the report and the page numbers on which they
begin. The table of contents should not list itself but should include the page numbers
of the major sections and appendixes in the report,

2.1.3 List of Figures

This is a list of all of the figures in your report and the page numbers on which they are
found. This section should be omitted if the report has less than three figures.

2.1.4 List of Tables

This is a list of all of the tables in your report and the page numbers on which they are
found. Do not include this section unless you have at least three tables in your report.

Format for Documentation of Robot Development Page 5

 2.2 MAJOR SECTIONS

This is the main part of the technical report and the pages are numbered in Arabic (e.g.,
1, 2, 3, 4, etc.) beginning with one. This section should include the Executive Summary
that gives a summary of the details in the report. It can be taken as an abstract of the
entire robot development process. Figure 3 shows how this section should be organized

Executive Summary 1.0 Introd… 2.1 Comp

Xxxxxxxxxxxxxxxxxx Xxxxxxxxxxxxxxxxxx
xxxxxxxxxx xxxxxxxxxxxxxxxxxxx
2.0 Proto. xxxxx
Xxxxxxxxxxxxxxxxxx 2.2 Proto Analy..
xxxxxxxxxx Xxxxxxxxxxxxxxxxxx
xxxxxxxxxx
1 2 3

Figure 3: Sample Major Sections

The major subsections in the report include (i) Introduction; (ii) Robot Construction
(iii) Design Specification; (iv) Design Process; (v) Performance analysis and Discussion;
(vi) Conclusion and (vii) Recommendations.

1.0 Introduction:
Arduino based Keycard Scanner with Sound Detector (AKSSD) is a keycard scanner for
home security that provides convenient and secure access control, offering features such
as a sound detector to alert homeowners of suspicious activity, providing a comprehensive
security solution. Thus, homeowners can now have a more safe and reliable security
system than the old lock and key. The sound detector activates when a user approaches,
and a green light signals a successful keycard scan. If the card is invalid, a buzzer sounds,
and the light turns red.

2.0 Robot Construction

Top View

Side View Front View

Figure 4: Multi-view Layout

Format for Documentation of Robot Development Page 6

This section presents details on the robot body design. Start with an introductory
paragraph that describes the robot body in general. Use a multiview layout (pictures or
drawings), as shown in Figure 4, to illustrate the robot shape and size. Use subheadings
to describe the main features of the robot (for example, Gearing, Bumpers, Restraint
Device, (etc).

3.0 Design Specification

This section outlines the programs written for your robot. For example, the
subheadings could be
3.1 AKSSD program
The RFID Reader, is an important component in the AKSSD Program. This serves as
the reader for the keycard to opening up the door when placed on the RFID Reader.

3.2 LCD
The LCD turns on and displays a text displaying “Place your keycard on the
RFID Reader”.
3.3 Supply Robot.
Before each sample of the programming code, write several sentences explaining what
the program does and the logic. These initial comments will help the reader more easily
decipher the code. Then include a figure showing the program (include a print out of
the code in the appendix). You may include arrows and text boxes to further explain the
program. The code must be readable, so use multiple screenshots if necessary.

4.0 Design Process

Explain the process your team went through to come up with the final design. Most
likely you built and programmed multiple robots before you found a working solution.
Trace through the history of your design process by describing each robot you built,
what was wrong with it, and how you fixed the problems (either construction or
programming) with the redesign. Be careful to not repeat the same information in
section 2.0.

Performance Results and ‘Discussion

This section briefly presents the expectations of your robot in the competition (pts =

Format for Documentation of Robot Development Page 7

score). Enumerate the expected outcome from any competition as evidenced by trials.
Indicate if the machine failed and what caused the machine to fail or succeed? Also
indicate whether the failure was due to the hardware or software design? Even if you
have negative information to report, the writing should be confident. You can mention

Format for Documentation of Robot Development Page 8

that recommendations will follow, but be careful not to make recommendations in this
section.

6.0 Conclusion

This section should be a brief, bottom-line summary. It needs to explain how your robot
met the design criteria and team goals outlined in the introduction (general, no
specifics). Do not bring anything new into a conclusion section; instead restate the key
points from the body of the report.

7.0 Recommendations
With the new information you have acquired after the completing the robot from
friends, colleagues or from a competition, how would you change your design if you
have to do it over? Remember to provide justification for each recommendation that
should be concentrating on the things that didn’t work.

2.3 END PAGES

2.3.1 Reference
Reference the ideas, theories, figures or quotes that you take from other sources.
Listing of references should follow the format described by American Psychological
Association (APA) referencing.

2.3.2 Appendices
Include any supplemental information that doesn’t fit in the major sections of the
report. Some examples are listed below:
 Arduino C code or any other code used
 Additional drawings of the vehicle or secret features
 Other
The last pages of the appendix should be a brief, individual, signed paragraph from each
team member that states that member’s specific contribution(s) to the overall effort,
including analysis, testing, and writing.

Format for Documentation of Robot Development Page 9