Difference between revisions of "F20: Treasure Diver"

From Embedded Systems Learning Academy
Jump to: navigation, search
(Schedule)
(Grading Criteria)
Line 1: Line 1:
=== 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>
 
 
 
== Treasure Diver ==
 
== Treasure Diver ==
  

Revision as of 22:27, 9 November 2020

Treasure Diver

Abstract

Treasure Diver is a single player game in which the player descends into watery depths on the hunt for treasure. The player must dodge obstacles and enemy creatures all while collecting treasure along the way. While descending the player is able to attack enemies at a range which in turn may give them power ups such as extra air, faster move speed, or temporary invincibility. When they reach the bottom they can collect the Motherlode. After that they have to ascend the cavern and make it out with all their treasure in one piece. Hitting an enemy or obstacle causes the player to lose air and a treasure chest and when their air hits zero it’s game over. At the end of a level the player is given a score based on treasure collected, remaining air, and the amount of enemies destroyed.

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

Treasure Diver GitLab


Schedule

Week # Start Date End Date Task Status
1 9/27/2020 10/3/2020
  • 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
  • Completed
  • Completed
  • Completed
  • Completed
  • Completed
  • Completed
  • Completed
  • Completed
  • Completed
  • Completed
  • Completed
2 10/4/2020 10/10/2020
  • Read past semester reports to decide on parts vendors
  • Completed
3 10/11/2020 10/17/2020
  • 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
  • Completed
  • Completed
  • Completed
  • Completed
4 10/18/2020 10/24/2020
  • 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
  • Completed
  • Completed
  • Completed
  • Completed
  • Completed
  • Completed
5 10/25/2020 10/31/2020
  • Read datasheets and conduct research for driver writing
  • Plan CAD enclosure design on paper
  • Finalize gameplay, rules, and level design on paper
  • Completed
  • Completed
  • Completed
6 11/1/2020 11/7/2020
  • Parts arrive
  • 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
  • Completed
  • Completed
  • Completed
  • Completed
  • Completed
7 11/8/2020 11/14/2020
  • 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
  • Implement gameplay logic code on master controller
  • Implement game pad controller code
  • Completed
  • Completed
  • Completed
8 11/15/2020 11/21/2020
  • LED matrix can scroll to next screen when character reaches the bottom of current screen
  • Character moves on LED matrix based on received direction controls
  • Bullet moves on LED matrix when button is pressed
  • Begin collision detection logic implementation
  • 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 presses and thumbstick/tilt 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 gameplay logic code on master controller
  • Finalize game pad controller code
  • Finalize PCB design on paper and design in PCB software
9 11/22/2020 11/28/2020
  • LED matrix graphics design for all levels is complete
  • Collision detection logic is fully functional and displays correctly on LED matrix
  • LED matrix side bar data (health, power ups) is displayed and updates correctly
  • LED matrix displays character orientation correctly depending on current movement direction
  • MP3 decoder plays correct song/track during gameplay and for each menu/game over screen
  • Begin full system testing with all components integrated
  • Finalize PCB design in software and order PCB
10 11/29/2020 12/5/2020
  • LED matrix menu screens and game over screens are complete
  • Volume controls in menu are implemented
  • Controller input (joystick or accelerometer) option is implemented in menu
  • Integrate circuitry with 3D printed enclosure
  • PCB arrives, conduct PCB testing to ensure proper connections
  • Solder PCB and integrate with existing project circuitry
  • Begin full system testing with PCB
  • Finalize MP3 track selection for each screen and during gameplay
11 12/6/2020 12/12/2020
  • Fine tune LED matrix display based on testing results
  • Finish rough draft of project report
  • Implement aesthetic enhancmenets to side bar, menu, and game over screens
  • Implement aesthetic enhancements to project enclosure
12 12/13/2020 12/19/2020
  • Film demo video and upload. Create link on Wiki report
  • Demo Day
  • Finalize project report and submit


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

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.