View source for F21: MARIO

=== Grading Criteria ===
<font color="green">
*  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.
</font>

== Project Title ==
Ace Mario

== Abstract ==
Super Mario is one of the best-selling games of all time, with more than 50 million copies sold worldwide. Our goal will be to produce a similar version of it where the player controls Mario. Mario has to race through the Mushroom Kingdom and save Princess.

== 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 ===
*  Vivek Tapkir
**   
*  Shreevats Gadhikar
**   
*  Daya Modekar
**

== Schedule ==

{| class="wikitable"
|-
! scope="col"| Week#
! scope="col"| Start Date
! scope="col"| End Date
! scope="col"| Task
! scope="col"| Status
|-
! scope="row"| 1
| 
* 10/12/2020
* 10/13/2020
|
* 10/18/2020
* 10/13/2020
|
* Read previous projects, gather information and discuss among the group members.
* Decide on day/time for weekly meetings
* Decide on 2 game ideas
* Decide on using wireless or wired controllers
* Decide on PCB software and manufacturer to order from
* Finalize parts list
* Setup splitwise account for cost sharing
* Discuss 3D printing options
* Break project up into tasks and begin assigning tasks to team members
* Setup team GitLab repo with master and working master branches
* Submit Project Proposal assignment
* 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
*Choose game based on Preet's Project Proposal feedback
*Submit Group Questions assignment
*Choose top picks for roles and responsibilities
*Finish schedule rough draft and upload to Wiki report
*Assign project tasks to team members
*Order project parts
*Submit Wiki schedule assignment
*Complete project GitLab Repo setup
*Obtain datasheets for all parts and upload to team Google Drive folder
*Brainstorm gameplay, rules, and level design on paper
|
* <span style="color:orange">In progress</span>
|-
! scope="row"| 3
|
*10/26/2020
|
*11/01/2020
|
*Read and familiarize with LED Matrix Datasheet
*Read datasheets and conduct research for driver writing
*Plan CAD enclosure design on paper
*Finalize gameplay, rules, and level design on paper
|
* <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
*Test all parts to ensure proper functionality
*Begin developing graphics driver for LED matrix
*Begin developing MP3 decoder board driver
*Begin developing bluetooth board driver
Finalize CAD enclosure design on paper and begin designing in AutoCAD software
|
* <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
*LED matrix can light a pixel(s) at specified locations
*LED matrix can display our game character and obstacles
*MP3 decoder can play a song from the SD card
*MP3 decoder can play/pause, jump to next/previous song, and increase/decrease volume
*Bluetooth modules can send controls data back and forth between game pad board and master board
*Controls data can be accessed using "get" and "set" API
*Plan PCB design on paper
*Game pad controller can read joystick and accelerometer values and detect switch presses
*Decide how to handle each collision detection case (character/enemy, bullet/enemy, etc.)
*MP3 decoder folder structure is finalized
*MP3 decoder can play a song at a specified index
*Analog thumbstick and accelerometer values are read by game pad board and sent over bluetooth
*Button press logic is implemented on game pad board and sent over bluetooth
*Finish enclosure design in AutoCAD software and start printing
*Order PCB components (resistors, capacitors, etc.)
*Finalize PCB design on paper and design in PCB software
*LED matrix top bar data (health, power ups) is displayed and updates correctly
*LED matrix displays character orientation correctly depending on current movement direction
*Controller input (joystick or accelerometer) option is implemented on game pad controller
*Character moves on LED matrix based on received direction controls
*Bullet moves on LED matrix when button is pressed
*Finalize PCB design in software and order PCB
|
* <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
|
*LED matrix menu screens and game over/victory screens are implemented on matrix
*Volume controls and controller input select in the options menu are implemented
*Integrate circuitry with 3D printed enclosure
*PCB arrives, conduct PCB testing to ensure proper connections
*Solder PCB and integrate with existing project circuitry
*LED matrix can scroll to next screen when character reaches the bottom of current screen
*Finalize MP3 track selection for each screen and during gameplay
*Collision detection logic is fully functional and displays correctly on LED matrix
*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
*Finish rough draft of project report
*Write gameplay logic code on master controller. Gameplay logic should update the score and status bar items correctly
*LED matrix graphics design for all levels is complete
*MP3 decoder plays correct song/track during gameplay and for each menu/game over screen
*Gameplay state machine switches to next state based on user button presses and gameplay progression 
|
* <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.
*Film demo video and upload. Create link on Wiki report
*Demo Day
*Finalize project report and submi
|
* <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 ==
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 ===
*  [https://sourceforge.net/projects/sjsu/files/CmpE_S2016/ Sourceforge Source Code Link]

== 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.