F19: Tower Defense in Space

From Embedded Systems Learning Academy
Revision as of 02:34, 19 December 2019 by Proj user10 (talk | contribs)

Jump to: navigation, search
Logo

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.

Tower Defense...In Space!

Tower Defense ... In Space.

Abstract

My abstract goes here.

Introduction and Objectives

This project provides us hands-on experience using freeRTOS in a real application. Our objective is to apply what we have learned in class and develop a game using our SJtwo Board. In this project, we need to use both cooperative scheduling and preemptive scheduling technique to make this game run efficiently. We create tasks for displaying the game objects on LED matrix, moving enemies, shooting enemies, and managing game stages. We also need to synchronize and sequentialize each task by setting the task priorities carefully and using binary semaphore.

Like most tradition tower defense game, the player needs to defend the homeland from the invasion of aliens. The player can place different kinds of towers strategically that attack the invading aliens from entering into our homeland by shooting the enemies. If any enemy spaceships reach the end of the path, then the user loses.

We created a controller that consists of a joystick and two buttons. The user can use the joystick to move the cursor and decide where to place the towers. After that, the user needs to press the black button to select and confirm the location of the towers. If the player knows that he will lose the game in the middle of the game, the player can press the red button which restarts the game.

Team Members

TEAM MEMBERS & RESPONSIBILITIES

Team Members

Administrative Roles

Technical Roles

  • [Ryan Zelek]

Team Lead

  • Game Design Lead

Git Repo Manager

  • Hardware Design Lead
  • [Chong Hang Cheong]

Wiki Report Manager

  • LED Matrix API
  • [Polin Chen]

Bill of Materials Manager

  • Joy Sticker && Decoder API


Schedule

TEAM MEETING DATES & DELIVERABLES

Week#

Date Assigned

Deliverables

Status

1 10/15/19
  • Share team contact information
  • Create Git Repository
  • Set up group Slack channel
  • Invite Preet to Slack
  • Establish Code Guidelines and Standards
  • Complete
  • Complete
  • Complete
  • Complete
  • Complete
2 10/22/19
  • Identify major hardware components (BOM)
  • Begin purchasing major items
  • Finalize game architecture
  • Have Git Repo Setup
  • Complete
  • Complete
  • Complete
  • Complete
3 10/29/19
  • Solidify individual roles and responsibilities
  • Establish baseline software architecture design and guidelines going forward
  • Complete
  • Complete
4 11/5/19

Kelvin

  • Verify functionality of LED matrix and gather resources for further understanding


  • Complete
5 11/12/19

Kelvin

  • Find out feasibility of creating an LED matrix driver in C

Polin

  • Have APIs ready for joystick and buttons

Ryan

  • Have basic user interface for the game displayed through serial port

Zach

  • First controller PCB design complete
  • Specify any remaining hardware components and coordinate purchase


  • Complete


  • Complete


  • Complete


  • Complete
  • Complete
6 11/19/19

Kelvin

  • Complete baseline API for LED matrix

Polin

  • Determine feasibility of MP3 decoding and integration into system

Ryan

  • Complete first pass at basic tower defense level with straight pathway

Zach

  • Controller PCB sent out for fabrication
  • Design break-out PCB for LED matrix + IO expander />


  • Complete


  • Complete


  • Complete


  • Complete
  • Complete
7 11/26/19

Kelvin

  • LED matrix driver should be reviewed and complete

Polin

  • Work with Zach to identify remaining hardware components and, if applicable, MP3 decoder requirements

Ryan

  • Work with Kelvin to integrate his API into the game
  • Game should be running with LED matrix display involvement
  • Advanced game logic design/implementation is near feature complete

Zach

  • PCB assembled and tested. Problems identified and solutions proposed


  • Complete


  • Complete


  • Complete
  • Complete
  • Complete


  • Complete
8 12/3/19
  • Complete game testing and validation
  • Critical bugs (software AND hardware) identified and a clear path towards closure has been identified
  • Complete
  • Complete
9 12/10/19
  • Continuation of previous week activities (bug fixes, etc)
  • Implement any potential optimizations and/or expansions
  • Complete
  • Complete


Bill of Materials

Top Level

PART NAME

PART MODEL & SOURCE

QUANTITY

COST PER UNIT (USD)

32x64 RGB LED Matrix [1] 2 $49.95
64x64 RGB LED Matrix Sparkfun 1 $79.95
NovaeLED 64x64 RGB LED Matrix (2-Pack) Amazon 1 $80.99
64x64 RGB LED Matrix* Adafruit 1 $104.07
5V 4A PSU - 1 FREE


Breakout Board PCB**

Item #

PART NAME

PART SOURCE

QUANTITY

COST PER UNIT (USD)

1 IC REG LINEAR LD1117S33CTR DIGIKEY 5 $0.351
2 MHS16N-ND 16POS CONN 2.54MM DIGIKEY 2 $2.60
3 CAP CER 0.1UF 25V X7R 1206 DIGIKEY 5 $0.221
4 CAP CER 10UF 16V X5R 1206 DIGIKEY 5 $0.202
5 RES SMD 470 OHM 1% 1/4W 1206 DIGIKEY 10 $0.0267
6 PTC RESET FUSE 24V 500MA 1206 DIGIKEY 10 $0.1588
7 CONN SOCKET 40POS 0.1 TIN PCB DIGIKEY 2 $5.03
8 Manufacturing x 5 boards * JLCPCB 1 $29.81


Gamepad PCB**

Item #

PART NAME

PART SOURCE

QUANTITY

COST PER UNIT (USD)

1 Analog 2-axis Thumb Joystick w/ select button Amazon 1 $7.67
2 SAM8205-ND 10POS 1.27MM DIGIKEY 5 $3.38
3 LED GREEN 1206 SMD DIGIKEY 5 $0.24
4 LED RED 1206 SMD DIGIKEY 5 $0.257
5 RES 1K OHM 1% 1/2W 1206 SMD DIGIKEY 5 0.0358
6 CAP CER 0.1UF 50V X7R 1206 DIGIKEY 5 $0.088
7 12x12x7.3mm Tactile Push Button w/ cap (pack of 25) Amazon 1 $7.89
8 Manufacturing x 5 boards * JLCPCB 1 $14.21


* Shipping and tax included in value shown in the cost per unit column
** Only parts that were purchased are displayed.


System Design

System Block Diagram

Hardware Design - Electrical

Overview

At a high level hardware integration requirements fell into two categories:

1. Reduce risk of unreliable cable connections and eliminate possibility of damage to components through unexpected disconnections, power surges, etc.
2. Provide a more fluid physical interface for the user to interact with the game via hardware


To accomplish these goals, two boards were designed: a breakout board and a gamepad controller. The breakout board serves as a connection hub between all system hardware components; power, the RGB matrix, the SJTWO board, etc. while the joystick provides a cleaner package to present the user with the games inputs. The diagram below shows the relationship between the main subsystems:


Tower defense in space hw block diagram.PNG


All board designs were done using EAGLE and manufactured by JLCPCB. Both boards were only two layers and used passive components for the most part.


Breakout Board Design

The breakout board design requirement was to interface all external hardware components with the embedded system (SJTWO). The hardware connections are:

1. The 64x64 RGB Matrix
2. Output power to the RGB Matrix
3. User game controller (see next section)
4. Input power supply (5V)
5. The SJTWO embedded system


Breakout Board Schematic


Breakout Board PCB Top Layout
Breakout Board PCB Bottom Layout
Breakout Board PCB Top Layout
Breakout Board PCB Bottom Layout
Populated and mounted to the SJTWO board

Known Issues

Summary

Description

Version

Status

5V should not be routed to game controller. 3.3V should be routed to the game controller instead of 5V since the ADC pins are not 5V tolerant. 0.1 Resolved Rev 0.2
Wrong silkscreen/not enough room near power input. Power input silkscreen too small, part too big for 3.3V LED to fit 0.1 Resolved Rev 0.2
Linear regulator not needed. The schematic for the SJTWO board labels the input voltage pin as VIN RAW, which is different than the label on the

optional input port. They are both the same, so this input feeds directly into the on-board 3.3V regulator. Essentially we're driving the regulator with the same voltage it outputs which just won't work well.

0.1, 0.2 UNRESOLVED

Gamepad Hardware Design

The gamepad board design requirement was to provide a more packaged interface for the user to interact with the game.

Gamepad Schematic


Gamepad PCB Top
Gamepad PCB Bottom
Gamepad PCB Fully Populated (no enclosure)

Hardware Design (Mechanical)

Only a few mechanical components were needed for this project. Namely simple brackets for mounting electrical hardware to the RGB matrix and displaying the matrix itself. All CAD designs were done using Onshape, a free CAD tool that can be used entirely through your web browser.

For displaying the RGB matrix, two brackets were 3D printed to prop it up. Their STL files can be found under our source repository.

Mounting bracket design used to prop up the RGB matrix

Hardware Integration

RGB LED MATRIX

The LED matrix that we use is 64 pixels by 64 pixels and is controlled through a 12-pin header consisting of the following pins:

LED Matrix - Row Scanning
  • Five Mux pins (A,B,C,D,E) for Row Selection
    • In order to select a specific row of the LED matrix, we need to control the output level of each mux pin. Since the LED matrix light up two rows of LEDs at one time, we can only select 1 out of 32 rows.
  • Two sets of RGB pins (R1,G1,B1,R2,G2,B2) for Color Selection
    • Since we are driving two rows of LED matrix at once, we need 2 sets of RGB pins. One set is used to control the color pixels of the upper half of the display and the other set for the bottom half of the display.
  • Output Enable Pin (OE)
    • Output Enable (OE) pin is used to turn on or off the LEDs of the current row.
  • Latch Pin (LAT)
    • Latch pin is used to prevent the data being shifted into the shift registers and tells the shift register when it is time to switch to newly entered data.
  • Clock Pin (CLK)
    • triggers a shift on the shift registers

All these pins are required to display a specific color on a specific pixel of the LED matrix display.

Pin Connections between SJtwo Board and REG LED Matrix

Joysticker controller

The joystick that we use is the product from Adafruit, the Analog 2-axis Thumb Joystick. This 2-axis Thumb Joystick provides the following pins:

  1. two ADC pin
    1. In order to control the tower location, we need to control the Joysticker, since the direction has four: Up, Down, Left, Right, we use the Y and X-axis to implement this function.
  2. Three GPIO pin
    1. In order for selecting for the tool we need two GPIO pin for button and 1 GPIO pin for controlling the LED on the JOY STICKER controller

MP3 Decoder

The MP3 decoder that we use is Sparkfun’s vs1053 shield MP3 decoder which is the board based on the vs1053b chip.

MP3 Decoder Module Pinout
MP3 Decoder Module Pinout

Software Design

RGB LED Matrix

RGB Data Element

All the LED Matrix data are stored in a buffer with its size equal to 32 by 64. Each element in this buffer store the color of two pixels, one pixel from the upper half of the display and one pixel from the lower half of the display.

In order to display the gaming objects in animation, we need to refresh the display by displaying the color pixels on each row one by one. Below is a basic flowchart that describes the process of refreshing the display.


  • Loop through each row of the LED display
  1. Select Row (By controlling the output level of 5 mux pins, we can select one row at one time)
  2. Disable the LED Display output (Turn off the LEDs of the current row of the display)
  3. Unlatch the Data
  4. Clock in Data for each column(Store the color of each pixel inside display_matrix buffer)
  5. Latch the Data
  6. Enable the LED Display output (Display the color of each pixel of the current row)
  7. Delay for a 100us (Increase the light intensity of the LEDs by delay a short amount of time)
  8. Disable the LED Display output (Turn off the LEDs of the current row of the display)

Process of refreshing display

JOY STICKER

The JOY_STICKER is using the task to pool the ADC channel data to get the direction from the Joysticker.


  • Loop through each time to poll the enum type data to get direction
  1. Receiving the data from two ADC channel(5=x, 4=y)
  2. Comparing which one has higher absolute data
  3. If (X > Y == YES) ,then we go to the loop to compare It's closer to Right or Left
  4. If (X > Y == YES && Right > LEFT == YES), then the status is Right
  5. If (X > Y == YES && Right > LEFT == NO), then the status is Left
  6. If (X > Y == NO) ,then we go to the loop to compare It's closer to Up or Down
  7. If (X > Y == NO && Up > Down == YES), then the status is Up
  8. If (X > Y == NO && Up > Down == NO), then the status is Down
Game controller flow chart
Game controller

System Flow Charts

System Testing and Validation

Technical Challenges

LED Matrix Flickering Issue

Issue: While we are developing the game, we notice that some color pixels are lit when they are supposed to be off. We suspect that this flickering issue may be caused by the poor connection of jumper wires.

Solution:

  1. Design a breakout circuit board which provides a more reliable and stable connection between the LED matrix and SJTWO Board.
  2. Place all the draw functions in one single task. This makes the refresh rate of the display more consistent and is easier for the synchronization of other tasks.

MP3 Decoder - SJtwo Board SPI Selection

Issue:

  1. The mp3 decoder1053b's document is a kind of confusing for the mode when 1032b have several modes
  2. It's hard to know the configuration is successful or not.

Solution:

  1. Doing the survey on the GitHub is really important. For example, using the sin wave and hello binary example to test how the Initialization and HZ parameter would save a lot of time.
  2. Besides, we also have to be careful to check the SJBoard's SPI because of the SD card reader is using for reading SDcard. Hence, I would recommend using other

SPI0, SPI1 instead of using SPI2.

Conclusion

Conculsion please.

Video Demonstration

Demo Video (Player Wins)

Demo Video (Player Loses)

Source Code

Tower_Defense_In_Space_Gitlab

Advice for Future Students

Test your LED Matrix and make sure it is not defective

The first 64x64 LED Matrix that we got from Sparkfun suffers from a serious flickering issue. After spending for a week trying to debug what causes the flickering issue, we still have no idea whether it is a hardware issue or software issue. Later, we borrow another LED matrix from a student of our class and test our code. With the other student's LED matrix (we use our own power supply and ribbon cables), there is no flickering issue at all. Therefore, we conclude that our LED matrix is defective.