View source for F22: DDRTOS

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

== Abstract ==
Rhythm games have been popular for years and date back to the 1970’s, but hit its stride in 1997 when one of the most notable and popular games released - Dance Dance Revolution (DDR). The main point of a rhythm game is to use music and challenge a player’s ability to stay on beat and typically press a button to the beat of the song. Our project is based and dedicated to DDR, as we all share a passion for music and video games. DDR is played with four arrows for each direction up, down, left, and right that need to be hit at the time of a beat in order to score and increase the multiplier. There are several aspects that are taken from other games like Guitar Hero and Friday Night Funkin’ (sound effects, multiplier, and artwork) that have also become a part of the project. Our project name, DDRTOS, is a combination of the game DDR and RTOS which runs the project.

== 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 ==
[[File:MichaelHatzi.PNG|200px|middle]]
*  Michael Hatzikokolakis
**  Core gameplay development
**  Beatmap development 
[[File:Kyle_Kwong.jpg|200px|middle]]
*  Kyle Kwong
**  MP3 module driver development
**  Audio system research and design
**  Ensure coding standards
**  Assist on all parts of the project
[[File:Anthony_Zunino.png|200px|middle]]
*  Anthony Zunino
**  Enclosure Design
**  PCB Design
**  Converted the mp3 module to use UART queue instead of polling

== Schedule ==

{| class="wikitable"
|-
! scope="col"| Week#
! scope="col"| Start Date
! scope="col"| End Date
! scope="col"| Task
! scope="col"| Status
|-
! scope="row"| 1
| 
* 10/11/2022
|
* 10/17/2022
|
* Read previous projects
* Create GitLab repository
* Choose and order initial round of parts
* Establish wiki schedule
| 
* <span style="color:green">Completed</span>
* <span style="color:orange">In progress</span>
* <span style="color:green">Completed</span>
* <span style="color:green">Completed</span>
|-
! scope="row"| 2
| 
*10/18/2022   
| 
*10/24/2022
|

*Test LED Matrix
*Obtain output from mechanical key breakout board
|
* <span style="color:red">Not started</span>
* <span style="color:red">Not started</span>
|-
! scope="row"| 3
|
*10/25/2022
|
*10/31/2022
|
* Create a simple beatgrid for a test song
* Start work on audio processing driver
* Start work on graphics processing driver
|
* <span style="color:red">Not started</span>
* <span style="color:red">Not started</span>
* <span style="color:red">Not started</span>


|-
! scope="row"| 4
|
* 11/01/2022
|
* 11/07/2022
|
* Create main menu graphics and logic
* Design and assemble controller prototype 1
|
* <span style="color:red">Not started</span>
|-
! scope="row"| 5
|
*11/08/2022
|
*11/14/2022
|
* Start game (song playthrough) graphics and logic
|
* <span style="color:red">Not started</span>
|-
! scope="row"| 6
|
*11/15/2022
| 
*11/21/2022
|
* Continue song graphics and logic
* Map more songs and integrate
* Refine controller prototype 1
|
* <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/22/2022
| 
* 11/28/2022
|
* Design and assemble controller final prototype
* Start design and assembly of console/screen housing
|
* <span style="color:red">Not started</span>
* <span style="color:red">Not started</span>
|-
! scope="row"| 8
| 
* 11/29/2022
| 
* 12/05/2022
|

* Testing and bug fixing
* Update the wiki page
|
* <span style="color:red">Not started</span>
* <span style="color:red">Not started</span>
|-
! scope="row"| 9
| 
* 12/6/2022
| 
* 12/12/2022
|
* Testing and finishing touches
|
* <span style="color:red">Not started</span>

|-
! scope="row"| 10
| 
*12/14/2022
|
*12/15/2022
|
* Final Demo (10/14)
* Finalize GitLab repo
* Finalize the wiki page
* Upload test video
|
* <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 ==
Note:
For the keycaps, we suggest using uniform profile keycaps such as DSA or XDA.
{| class="wikitable"
|-
! scope="col"| Item#
! scope="col"| Part Desciption
! scope="col"| Vendor
! scope="col"| Qty
! scope="col"| Cost/Item
|-
! scope="row"| 1
| 64x64 RGB LED Matrix - 3mm Pitch (192mm x 192mm)
| Adafruit [https://www.adafruit.com/product/4732]
| 1
| $59.95
|-
! scope="row"| 2
| MP3 Module
| Amazon [https://www.amazon.com/gp/product/B08FFLH5XL/]
| 1
| $12.99
|-
! scope="row"| 3
| PCB 
| JLCPCB [https://www.pcbway.com/]
| 1
| $
|-
! scope="row"| 4
| NeoKey Socket Breakout for Mechanical Key Switches with NeoPixel – For MX Compatible Switches
| Adafruit [https://www.adafruit.com/product/4978]
| 4
| $1.75
|-
! scope="row"| 5
| LM7805 Power Regulator
| N/A
| 1
| N/A
|-
! scope="row"| 6
| 10-pin Terminal Block
| N/A
| 1
| N/A
|-
! scope="row"| 7
| LEDs
| N/A
| 8
| N/A
|-
! scope="row"| 8
| Mx style switches
| N/A
| 4
| N/A
|-
! scope="row"| 9
| Mx style keycaps
| N/A
| 4
| N/A
|-
! scope="row"| 10
| SeeedStudio 4-pin connectors
| N/A
| 2
| N/A
|-
! scope="row"| 11
| 4-pin to wire connector cable
| N/A
| 2
| N/A
|-
! scope="row"| 12
| 20-pin ribbon cable
| N/A
| 1
| N/A
|-
! scope="row"| 13
| Miscellaneous resistors and capacitors
| N/A
| N/A
| N/A
|-
|}
<HR>
<BR/>

== 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 ===
*  [https://www.youtube.com/watch?v=SimXCBoI7Hg Video Link]

=== Project Source Code ===
*  [https://gitlab.com/cmpe244-g7/ddrtos Project Source Code]

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

=== References Used ===
[https://picaxe.com/docs/spe033.pdf DF Mini mp3 player]

=== Appendix ===
You can list the references you used.