Difference between revisions of "Sample Project Report"

From Embedded Systems Learning Academy
Jump to: navigation, search
(Undo revision 12565 by Proj user7 (talk))
 
(8 intermediate revisions by 4 users not shown)
Line 12: Line 12:
  
 
== Project Title ==
 
== Project Title ==
 +
Parking Frenzy
  
 
== Abstract ==
 
== Abstract ==
−
This section should be a couple lines to describe what your project does.
+
Parking Frenzy is car parking video game. The player will be able to move the car in right or left direction, the road itself will be descending towards the car and will also consist of obstacles such as other vehicles. The road will have lanes through which the car must navigate to ultimately be able to slot itself into the right parking spot alongside the road. The parking spots will be randomly generated along the edge of the LED matrix and the player must navigate the car into the spot at the right time or else it will result in a crash. The difficulty of the game will increase as the player reaches a certain amount of points. The difficulty will increase in terms of the speed of the car and the number of obstacles. The final score of the player will be displayed at the end of every game. a speaker attached to the board will generate the game sounds.
  
 
== Objectives & Introduction ==
 
== Objectives & Introduction ==
Line 20: Line 21:
  
 
=== Team Members & Responsibilities ===
 
=== Team Members & Responsibilities ===
−
*  Yaron Alexandrovich
+
*  Scott LoCascio
 
**   
 
**   
−
*  Emil Kurian
+
*  Naeem Mannan
 
**   
 
**   
−
*  Gerard Ramos
+
*  Rahul Ghadge
−
** 
 
−
*  Fred Sun
 
 
**   
 
**   
 +
  
 
== Schedule ==
 
== Schedule ==
−
Show a simple table or figures that show your scheduled as planned before you started working on the project.  Then in another table column, write down the actual schedule so that readers can see the planned vs. actual goals.  The point of the schedule is for readers to assess how to pace themselves if they are doing a similar project.
 
  
 
{| class="wikitable"
 
{| class="wikitable"
 
|-
 
|-
 
! scope="col"| Week#
 
! scope="col"| Week#
−
! scope="col"| Date
+
! scope="col"| Start Date
 +
! scope="col"| End Date
 
! scope="col"| Task
 
! scope="col"| Task
−
! scope="col"| Actual
+
! scope="col"| Status
 
|-
 
|-
 
! scope="row"| 1
 
! scope="row"| 1
−
| 10/8
+
|  
−
| Task list
+
* 10/12/2020
−
| Completed?  Problems Encountered?
+
* 10/13/2020
 +
|
 +
* 10/18/2020
 +
* 10/13/2020
 +
|
 +
* Read previous projects, gather information and discuss among the group members.
 +
* Create GitLab repository for project
 +
|
 +
* <span style="color:green">Completed</span>
 +
* <span style="color:orange">In progress</span>
 +
|-
 +
! scope="row"| 2
 +
|
 +
*10/19/2020 
 +
|
 +
*10/20/2020
 +
|
 +
 
 +
*Order necessary parts
 +
|
 +
* <span style="color:orange">In progress</span>
 +
|-
 +
! scope="row"| 3
 +
|
 +
*10/26/2020
 +
|
 +
*11/01/2020
 +
|
 +
*Read and familiarize with LED Matrix Datasheet
 +
|
 +
* <span style="color:red">Not started</span>
 +
 
 +
 
 +
|-
 +
! scope="row"| 4
 +
|
 +
* 11/02/2020
 +
|
 +
* 11/08/2020
 +
|
 +
* Develop graphics driver for LED matrix and implement initial game objects
 +
|
 +
* <span style="color:red">Not started</span>
 +
|-
 +
! scope="row"| 5
 +
|
 +
*11/09/2020
 +
*11/09/2020
 +
*11/09/2020
 +
*11/09/2020
 +
|
 +
*11/10/2020
 +
*11/15/2020
 +
*11/15/2020
 +
*11/15/2020
 +
|
 +
* Finalize wiki schedule
 +
* Order circuit boards components and complete the design for printing
 +
* circuit board and component assembly
 +
* Circuit board testing
 +
* Additional accessories if required and finalization of hardware
 +
|
 +
* <span style="color:red">Not started</span>
 +
* <span style="color:red">Not started</span>
 +
* <span style="color:red">Not started</span>
 +
* <span style="color:red">Not started</span>
 +
* <span style="color:red">Not started</span>
 +
|-
 +
! scope="row"| 6
 +
|
 +
*11/16/2020
 +
|
 +
*11/22/2020
 +
|
 +
*Integration of circuit boards and microcontroller
 +
* Game logic development
 +
* Testing and debugging the game logic
 +
|
 +
* <span style="color:red">Not started</span>
 +
* <span style="color:red">Not started</span>
 +
* <span style="color:red">Not started</span>
 +
|-
 +
! scope="row"| 7
 +
|
 +
* 11/23/2020
 +
 
 +
|
 +
* 11/29/2020
 +
|
 +
* Integrate game logic code with LED matrix
 +
* Integrate game sounds with game logic
 +
|
 +
* <span style="color:red">Not started</span>
 +
* <span style="color:red">Not started</span>
 +
|-
 +
! scope="row"| 8
 +
|  
 +
* 11/30/2020
 +
|
 +
* 12/06/2020
 +
|
 +
 
 +
* Integrate subsystem
 +
* Finalizing the video game
 +
* Update the wiki page.
 +
|
 +
* <span style="color:red">Not started</span>
 +
* <span style="color:red">Not started</span>
 +
* <span style="color:red">Not started</span>
 +
|-
 +
! scope="row"| 9
 +
|
 +
* 12/07/2020
 +
|
 +
* 12/13/2020
 +
|
 +
* Address bugs during testing of integrated system
 +
* Test pause/play functionality
 +
|
 +
* <span style="color:red">Not started</span>
 +
* <span style="color:red">Not started</span>
 +
* <span style="color:red">Not started</span>
 +
|-
 +
! scope="row"| 10
 +
|
 +
*12/16/2020
 +
*12/14/2020
 +
*12/14/2020
 +
*12/14/2020
 +
|
 +
*12/16/2020
 +
*12/16/2020
 +
*12/16/2020
 +
*12/16/2020
 +
|
 +
 
 +
*Final Demo
 +
*Update Gitlab repo with final code.
 +
*Update test video.
 +
*Update the wiki page.
 +
|
 +
* <span style="color:red">Not started</span>
 +
* <span style="color:red">Not started</span>
 +
* <span style="color:red">Not started</span>
 +
* <span style="color:red">Not started</span>
 +
|-
 
|}
 
|}
 +
 +
<HR>
 +
<BR/>
  
 
== Parts List & Cost ==
 
== Parts List & Cost ==
Line 69: Line 217:
 
Include sub-sections that list out a problem and solution, such as:
 
Include sub-sections that list out a problem and solution, such as:
  
−
=== My Issue #1 ===
+
=== <Bug/issue name> ===
 
Discuss the issue and resolution.
 
Discuss the issue and resolution.
  
Line 79: Line 227:
  
 
=== Project Source Code ===
 
=== Project Source Code ===
−
*  [https://sourceforge.net/projects/sjsu/files/CmpE_SJSU_S2015/ Sourceforge Source Code Link]
+
*  [https://sourceforge.net/projects/sjsu/files/CmpE_S2016/ Sourceforge Source Code Link]
  
 
== References ==
 
== References ==

Latest revision as of 04:44, 12 October 2022

Grading Criteria

  • How well is Software & Hardware Design described?
  • How well can this report be used to reproduce this project?
  • Code Quality
  • Overall Report Quality:
    • Software Block Diagrams
    • Hardware Block Diagrams
      Schematic Quality
    • Quality of technical challenges and solutions adopted.

Project Title

Parking Frenzy

Abstract

Parking Frenzy is car parking video game. The player will be able to move the car in right or left direction, the road itself will be descending towards the car and will also consist of obstacles such as other vehicles. The road will have lanes through which the car must navigate to ultimately be able to slot itself into the right parking spot alongside the road. The parking spots will be randomly generated along the edge of the LED matrix and the player must navigate the car into the spot at the right time or else it will result in a crash. The difficulty of the game will increase as the player reaches a certain amount of points. The difficulty will increase in terms of the speed of the car and the number of obstacles. The final score of the player will be displayed at the end of every game. a speaker attached to the board will generate the game sounds.

Objectives & Introduction

Show list of your objectives. This section includes the high level details of your project. You can write about the various sensors or peripherals you used to get your project completed.

Team Members & Responsibilities

  • Scott LoCascio
  • Naeem Mannan
  • Rahul Ghadge


Schedule

Week# Start Date End Date Task Status
1
  • 10/12/2020
  • 10/13/2020
  • 10/18/2020
  • 10/13/2020
  • Read previous projects, gather information and discuss among the group members.
  • Create GitLab repository for project
  • Completed
  • In progress
2
  • 10/19/2020
  • 10/20/2020
  • Order necessary parts
  • In progress
3
  • 10/26/2020
  • 11/01/2020
  • Read and familiarize with LED Matrix Datasheet
  • Not started


4
  • 11/02/2020
  • 11/08/2020
  • Develop graphics driver for LED matrix and implement initial game objects
  • Not started
5
  • 11/09/2020
  • 11/09/2020
  • 11/09/2020
  • 11/09/2020
  • 11/10/2020
  • 11/15/2020
  • 11/15/2020
  • 11/15/2020
  • Finalize wiki schedule
  • Order circuit boards components and complete the design for printing
  • circuit board and component assembly
  • Circuit board testing
  • Additional accessories if required and finalization of hardware
  • Not started
  • Not started
  • Not started
  • Not started
  • Not started
6
  • 11/16/2020
  • 11/22/2020
  • Integration of circuit boards and microcontroller
  • Game logic development
  • Testing and debugging the game logic
  • Not started
  • Not started
  • Not started
7
  • 11/23/2020
  • 11/29/2020
  • Integrate game logic code with LED matrix
  • Integrate game sounds with game logic
  • Not started
  • Not started
8
  • 11/30/2020
  • 12/06/2020
  • Integrate subsystem
  • Finalizing the video game
  • Update the wiki page.
  • Not started
  • Not started
  • Not started
9
  • 12/07/2020
  • 12/13/2020
  • Address bugs during testing of integrated system
  • Test pause/play functionality
  • Not started
  • Not started
  • Not started
10
  • 12/16/2020
  • 12/14/2020
  • 12/14/2020
  • 12/14/2020
  • 12/16/2020
  • 12/16/2020
  • 12/16/2020
  • 12/16/2020
  • Final Demo
  • Update Gitlab repo with final code.
  • Update test video.
  • Update the wiki page.
  • Not started
  • Not started
  • Not started
  • Not started


Parts List & Cost

Give a simple list of the cost of your project broken down by components. Do not write long stories here.

Design & Implementation

The design section can go over your hardware and software design. Organize this section using sub-sections that go over your design and implementation.

Hardware Design

Discuss your hardware design here. Show detailed schematics, and the interface here.

Hardware Interface

In this section, you can describe how your hardware communicates, such as which BUSes used. You can discuss your driver implementation here, such that the Software Design section is isolated to talk about high level workings rather than inner working of your project.

Software Design

Show your software design. For example, if you are designing an MP3 Player, show the tasks that you are using, and what they are doing at a high level. Do not show the details of the code. For example, do not show exact code, but you may show psuedocode and fragments of code. Keep in mind that you are showing DESIGN of your software, not the inner workings of it.

Implementation

This section includes implementation, but again, not the details, just the high level. For example, you can list the steps it takes to communicate over a sensor, or the steps needed to write a page of memory onto SPI Flash. You can include sub-sections for each of your component implementation.

Testing & Technical Challenges

Describe the challenges of your project. What advise would you give yourself or someone else if your project can be started from scratch again? Make a smooth transition to testing section and described what it took to test your project.

Include sub-sections that list out a problem and solution, such as:

<Bug/issue name>

Discuss the issue and resolution.

Conclusion

Conclude your project here. You can recap your testing and problems. You should address the "so what" part here to indicate what you ultimately learnt from this project. How has this project increased your knowledge?

Project Video

Upload a video of your project and post the link here.

Project Source Code

References

Acknowledgement

Any acknowledgement that you may wish to provide can be included here.

References Used

List any references used in project.

Appendix

You can list the references you used.

Retrieved from "http://socialledge.com/sjsu/index.php?title=Sample_Project_Report&oldid=69102"