View source for F18: Goals of Glory

[[File:F18_GOGCoverPage.jpg||550x950px|right|Goals Of Glory]]

== Project Title ==



==== Goals of Glory ====

== Abstract ==
Gesture-based gaming is getting tremendous adoption due to immersive gameplay and increased player engagement. Goals of Glory is a classic penalty shootout game where 2 players can play wirelessly, and the corresponding game visuals are displayed on the LED Matrix in real time. The logic for player movement is based on the output from a Gyroscope and an Accelerometer embedded on MPU 6050 whereas accelerometer on the SJone helps drive goalkeeper movements. Thus the motion of player leg movements to kick and hand movements of the goalkeeper to stop the ball is mapped and the corresponding game animations are displayed on 64x64 LED Matrix. The LED matrix is interfaced to the SJone board in such a way that the main SJone board controlling the LED Matrix receives commands wirelessly from hand and leg movements of each player via the Nordic wireless mesh network. Three display screens are developed for the game UI- Start screen, Game screen, and Result screen. Thus, by playing Goals of Glory, players can experience gesture-based gaming capabilities.

== Objectives & Introduction ==

=== Introduction ===

Our project is divided into 4 modules

'''1) LED Module: ''' The 64x64 LED matrix is driven by a Master SJone board which is responsible to map game visuals.

'''2) Wireless Module: ''' Responsible for communication medium between the goalkeeper, player, and the main SJone board

'''3) Player Module: ''' This module is responsible for getting  the player movement that will be mapped to drive game visuals

'''4) Goalkeeper Module: ''' This module is responsible for getting  the goalkeeper movement that will be mapped to drive game visuals

=== Objectives ===
Our project involved a focused and rigorous approach to testing each module functionality and make necessary changes thereafter.
* Design power management PCB
* Developing game visuals for the penalty shootout game.
* Developing logic for display tasks such as curving the ball, selecting the player and ball color.
* Implement RGB LED matrix driver
* Perform RGB LED matrix pin layout with the SJone board and have a deep understanding of how a single or group of LED's are driven.
* Perform accelerometer driver
* Perform nordic wireless driver
* Have a proper synchronization between the player SJone board and goalkeeper SJone board
* Examine overall system and make necessary tweaks
* Prepare the entire system for demo purpose which includes gloves and mounting pads to mount hardware equipment

==== Team Members & Responsibilities ====
* '''Player Movements'''
**Aniket Phatak''
**Bhargav Shashidhara Pandit''

* '''Goalkeeper Movements'''
**Tahir Rawn''
**Harmeen Joshi''

* '''Display (RGB LED Matrix)'''
**Harmeen Joshi''
**Tahir Rawn''
**Satya Sai Deepak. Naidu''

* '''Wireless (Nordic)'''
**Aniket Phatak''
**Bhargav Shashidhara Pandit''

* '''PCB Design'''
**Satya Sai Deepak. Naidu''

==== Game Stats: ====
* 2-Player Penalty shootout Game
* 3-sec timer for each player to shoot
* Press switch on the main SJOne board to start
* Move the Goalkeeper SJone board left-right to have a corresponding movement of LED Matrix
* Control the ball movement via player SJone board to give direction i.e. left, right or straight
* Highest player to score wins and is displayed on the result screen

== Schedule ==


{| class="wikitable"
|-
! scope="col"| Week#
! scope="col"| Date
! scope="col"| Task
! scope="col"| Status
|-
! scope="row"| 1
| 09/25
|
* Discuss project ideas to implement gaming projects with group members
* To come up with new ideas for applications specific to FreeRTOS 
* Submitted the abstract for the Car Racing Game and 1v1 Penalty Shootout for project approval.
| 
*  Submitted project proposals and waiting for approval from the professor. 
|-
! scope="row"| 2
| 10/02
| 
* Research on components required for the approved project.
* Discuss project requirements and implementation logic with group members.
| 
* 1v1 Penalty Shootout Project got approved by the professor
|-
! scope="row"| 3
| 10/9
| 
* Divide the project into different modules.
* Assign responsibilities to each group member.
* Decide deadlines and deliverables for each module.
| 
* Divided the workload among each and every group members.
* Finalized the project implementation logic and developed the basic idea.
|-
! scope="row"| 4
| 10/23
| 
* To verify power requirements for LED Matrix
* Ordered 64x64 LED Matrix from Sparkfun.
* Ordered power supply for LED Matrix from Amazon.

| 
* Confirmed the voltage and current rating and placed an order for the power adapter.
|-
! scope="row"| 5
| 10/30
| 
* Started working on Accelerometer available on SJOne board for player movement.
* Understand 64x64 LED Matrix connections from Sparkfun datasheets.
* Brush up on transistor basics and understand how data flows in a given LED Matrix.
* Get accustomed to Eagle software for PCB design and get used to basic functionality.
| 
* Implemented few basic PCB designs 
* Verified pin connections, power requirements for 64x64 RGB LED Matrix.
* Installed Eagle software and made a simple circuit to get acquainted with the software.
|-
! scope="row"| 6
| 11/06
|
* To develop game visuals such as goalpost, ball and ball movement animation.
* To develop a good understanding of wireless communication between two SJone boards.
* To control individual LED's on a 64x64 LED Matrix.
* Understand output latch and output enable addressing modes on a LED Matrix.
| 
* Successfully able to display game visuals.
* Got a basic idea of addressing specific LEDs on LED Matrix using 5-address lines.
* Understood the functionality of latch, output enable and clock pins of LED Matrix.
|-
! scope="row"| 7
| 11/13
|
* To write LED Matrix driver to derive game visuals along with various colors.
* To finish with the PCB design for our application
* To map different orientation values with respect to X, Y and Z axis respectively.
| 
* Successfully able to achieve game visuals on LED Matrix such as ball movement, goalpost location
* Completed start screen, score screen and end result screen for the in-game module.
* Completed PCB design
|-
! scope="row"| 8
| 11/20
|
* To develop start screen, score screen and end result screen for the in-game module.
* Understand the high-level APIs for the Wireless nordic communication and implement a basic driver to communicate between two SJone boards.
* To order MPU 6050 gyroscope and accelerometer sensor.
| 
* Still working on the Start screen, score screen and result screen.
* Achieved wireless communication between 3 SJone boards
|-
! scope="row"| 9
| 11/27
|
* To understand MPU 6050 datasheet and reference manual and write accelerometer driver for our application.
* To achieve wireless data synchronization between player, goalkeeper and LED matrix modules.
| 
*Completed accelerometer & Gyroscope driver and successfully able to get raw values from MPU 6050
*Completed nordic driver and able to communicate between 3 SJone boards.
|-
! scope="row"| 10
| 12/4
|
* Improve the gyroscope and accelerometer by addition of functions to get yaw, pitch, and roll
* Testing of the complete integrated system. 
* Addition of extra graphics if time permits.
| 
* Completed entire gyro and accelerometer driver for added functionality
* Successfully able to achieve proper synchronization i.e. by driving the game visuals using goalkeeper and player movements.
|-
! scope="row"| 11
| 12/19
|
* Final Demo
| 
* Completed
|-
|}

== Parts List & Cost ==


{| class="wikitable"
|-
! scope="col"| Item#
! scope="col"| Part Desciption
! scope="col"| Vendor
! scope="col"| Qty
! scope="col"| Cost
|-
! scope="row"| 1
| SJOne Boards
|  Preet
| 3
| $240.00
|-
! scope="row"| 2
| 64x64 RGB LED Matrix
| Sparkfun
| 1
| $75.00
|-
! scope="row"| 3
| Power Adaptor Cable
| Amazon
| 1
| $9
|-
! scope="row"| 4
| PCB
| PCBWay [https://www.pcbway.com/]
| 10
| $30
|-
! scope="row"|5
| MPU 6050
| Amazon
| 2
| $11
|-
! scope="row"| 6
| WiFi Antenna
| Amazon
| 3 
| 24

|-
! scope="row"| 8
| Power Bank 
| Amazon
| 2
| $24
|-
! scope="row"| 9
| Miscellaneous (Jumper wires, Connectors, SMD's)
| CMPE Lab 294
|
| $5
|-
! scope="row"| 9
| Total
| -
| -
| 418
|}

== Design & Implementation ==

In this section, we would be discussing the design considerations for our project - Goals of Glory which would be covered in the following sections. The hardware design gives a brief explanation of the hardware components used. This is followed by a hardware interface that is employed in our project in order to facilitate communication between the hardware devices. Finally, we discuss the software design aspects of the project and complete this section with the discussion of the implementation of the project.

=== Hardware Design ===

[[File:GoG_BlockDiagram.png|thumb|750x500px|center| Goals of Glory block diagram]]

The Hardware design for our project Goals of Glory involves usage of 3 SJone boards, a 64x64 LED matrix, MPU6050 gyroscope & accelerometer sensor, MMA8452Q accelerometer (onboard sensor) and Nordic wireless (nRF24L01+).


''' LED Matrix '''

<center>
<table>
<tr>
<td>
[[File:frontview.jpg|thumb|400x300px|right| LED Matrix front View]]
</td>
<td>
</td>
<td>
[[File:rearview.jpg|thumb|400x300px|left| LED Matrix rear View]]
</td>
</tr>
</table>
</center>



A 64x64 RGB LED Matrix Panel is used as a display. It is divided into two 32x64 sections. Each LED can be independently addressed and controlled. The LED matrix display is constructed using a decoder to decode row address. The rows can be individually accessed using the A, B, C, D, and E address pins. At a time one row in each of the 32x64 sections is selected. Each bit in the shift register controls the corresponding column. On every falling edge of the clock pulse, the values at R1, B1, G1, R2, B2, and G2 pins are stored into the shift register and the register shifts the data by one bit. After this, the data on the shift register is passed onto the individual LED's when both OE and LE pins are set to high. The intensity of each pixel can be controlled by the rate of refresh of the individual LED. 


<center>
<table>
<tr>
<td>
LED matrix pins:
{| class="wikitable"
|-
! align="center"|S.NO
! align="center"|RGB LED pins
! align="center"|SJone GPIO pins
|-
| scope="row" align="center"|1
| scope="row" align="center"|R1
| scope="row" align="center"|P1.20
|-
| scope="row" align="center"|2
| scope="row" align="center"|G1
| scope="row" align="center"|P2.7
|-
| scope="row" align="center"|3
| scope="row" align="center"|B1
| scope="row" align="center"|P1.22
|-
| scope="row" align="center"|4
| scope="row" align="center"|R2
| scope="row" align="center"|P1.23
|-
| scope="row" align="center"|5
| scope="row" align="center"|G2
| scope="row" align="center"|P2.6
|-
| scope="row" align="center"|6
| scope="row" align="center"|B2
| scope="row" align="center"|P1.28
|-
| scope="row" align="center"|7
| scope="row" align="center"|A
| scope="row" align="center"|P1.29
|-
| scope="row" align="center"|8
| scope="row" align="center"|B
| scope="row" align="center"|P2.5
|-
| scope="row" align="center"|9
| scope="row" align="center"|C
| scope="row" align="center"|P2.0
|-
| scope="row" align="center"|10
| scope="row" align="center"|D
| scope="row" align="center"|P2.4
|-
|-
| scope="row" align="center"|11
| scope="row" align="center"|E
| scope="row" align="center"|P1.19
|-

| scope="row" align="center"|12
| scope="row" align="center"|CLK
| scope="row" align="center"|P2.1
|-
| scope="row" align="center"|13
| scope="row" align="center"|OE
| scope="row" align="center"|P2.2
|-
| scope="row" align="center"|14
| scope="row" align="center"|LAT
| scope="row" align="center"|P2.3
|-
| scope="row" align="center"|15
| scope="row" align="center"|VCC
| scope="row" align="center"|3.3V
|-
| scope="row" align="center"|16
| scope="row" align="center"|GND
| scope="row" align="center"|GND
|-
|}
</td>
<td>
</td>
<td>
[[File:F18_LEDMatrixOrg.png|thumb|700x600px|left| LED Matrix Organisation]]
</td>
</tr>
</table>
</center>




''' MPU 6050 Gyroscope and Accelerometer '''

MPU 6050 Six-Axis (Gyro + Accelerometer) MEMS Motiontracking device.
The MPU-6050 incorporates InvenSense’s MotionFusion™ and run-time calibration firmware that enables manufacturers to eliminate the costly and complex selection, qualification, and system level integration of discrete devices in motion-enabled products, guaranteeing that sensor fusion algorithms and calibration procedures deliver optimal performance for consumers. The MPU-6050 devices combine a 3-axis gyroscope and a 3-axis accelerometer on the same silicon die, together with an onboard Digital Motion Processor™ (DMP™), which processes complex 6-axis MotionFusion algorithms. The device can access external magnetometers or other sensors through an auxiliary master I²C bus, allowing the devices to gather a full set of sensor data without intervention from the system processor. The devices are offered in a 4 mm x 4 mm x 0.9 mm QFN package.

For precision tracking of both fast and slow motions, the parts feature a user-programmable gyro full-scale range of ±250, ±500, ±1000, and ±2000 °/sec (dps), and a user-programmable accelerometer full-scale range of ±2g, ±4g, ±8g, and ±16g. Additional features include an embedded temperature sensor and an on-chip oscillator with ±1% variation over the operating temperature range.

In Goals of Glory, the SJone board controlling the player uses the above mentioned MPU 6050 (Gyroscope and Accelerometer) to map direction and tilt. This is achieved using the yaw, pitch and roll values that we obtained by writing an extensive gyro driver. More importantly, we were able to achieve precise angle measurements such that appropriate data points are mapped for our application.
For the goalkeeper, we were able to achieve the left and right orientation using SJone onboard accelerometer. Using raw values of X,Y,Z we set up left, right, up and down directions for the goalkeeper to follow.


=== Hardware Interface ===


''' Nordic Wireless '''

The SJOne board(LPC1758) is interfaced with Nordic wireless (nRF24L01+) chip using SPI.

The nRF24L01+ is a single chip 2.4GHz transceiver with an embedded baseband protocol engine, suitable for ultra low power wireless applications. The nRF24L01+ is designed for operation in the frequency band of 2.400 - 2.483GHz.
The register map, which is accessible through the SPI, contains all configuration registers in the nRF24L01+ and is accessible in all operation modes of the chip. The embedded baseband protocol engine (Enhanced ShockBurst™) is based on packet communication and supports various modes from manual operation to advanced autonomous protocol operation. Internal FIFOs ensure a smooth data flow between the radio front end and the system’s MCU. Enhanced ShockBurst™
reduces system cost by handling all the high-speed link layer operations. nRF24L01+ supports an air data rate of 250 kbps, 1 Mbps and 2Mbps. The high air data rate combined with two power saving modes make the nRF24L01+ very suitable for ultra-low power designs.

In our project, we are employing three SJone boards each interfaced with a Nordic wireless chip. We use two boards for continuously transmitting direction data computed from the respective boards i.e player's and goalkeeper's movements. The third board receives the data transmitted from the other two boards. The three boards are uniquely identified based on their device ID (node address) as defined. In order for the boards to communicate smoothly without an interception, the communication has to occur on the same communication channel. This will prevent collision between two or more mesh networks.


''' Printed Circuit Board (PCB) Design '''

'''Introduction:'''
The game uses a 64x64 LED Matrix which needs a 5v input supply. Since the board supplies 3.3v we level shift the voltage to 5v to avoid any unwanted flickering. So, we have decided to design a level shifter circuit. The design starts with the schematics and then designing the footprint. The design ends with creating the Gerber files and sending them to the manufacturing unit.

[[File:Level Shifter_schematics.jpg|thumb|750x500px|center| Schematics for the circuit]]

'''Schematics:'''
The design was made in Eagle PCB design software. In preparing your schematics we encountered few challenges with the selection of equipment dimensions and dimension terminology(units). The designer should be aware of the dimensions of equipment that are to be used. After getting the idea of equipment, add the library of that equipment to eagle through manage library option. Now, the designer can get that item schematic and add it to the design schematics. Complete the schematics based on the circuit that the designer wants to implement. The above figure shows the schematics for a level shifter circuit.

[[File:Foot_Print.JPG|thumb|500x220px|left|Foot Print]]
[[File:Final_Board.JPG|thumb|500x220px|right|Final Board]]


'''Foot Print and Gerber Files:'''
After the schematics are done, you can see a  BRD/SCH  button i.e. schematic to board button. Using that button, the footprint page will be opened. Here you will be able to use some skills in designing a compact circuit. Selecting the trace width (in mils) accordingly based on your current ratings. We used a 2 layered 16 mils trace width for safer side to accommodate 4A flow of current. Place all your equipment in the square (board area) and can have positioned them upon the designers' will. Click on auto netlist button to run the simulations for possible tracing options 

The designer can select one or draw the traces manually( manual is mostly preferred for better results). The footprint of out circuit is shown in Figure.2. Now, continue with DRC(design real check ) to check the possible errors while manufacturing. Make sure that there are no errors. After all the errors are cleared create the Gerber files for manufacturing company to provide those files to the manufacturing machines.

'''''Few tips for schematics:'''''

• Make sure the dimensions of auxiliary equipment size match the equipment. For example, the supply port size is 4mm pitch 4 pins if I use 2mm pitch 4pins the circuit cannot be practically implemented. 

• Have a clear idea of the equipment and their availability in the market before getting started. Sometimes your design may be correct, but you will not be getting appropriate equipment for installing on circuit board.
• Use Vcc and Gnd pins for reducing circuiting complexity.

=== Software Design and Implementation ===
We have created four independent tasks to control different parts of the game at the same time. Those are as follows: 
* Update Display Task
This task is dedicated to refreshing the LED matrix at on a periodic basis. We have configured it to refresh the display after every 2 milliseconds.

* Control Goalkeeper Task
The Control Goalkeeper Task keeps track of the data coming wirelessly from the accelerometer sensor device mounted on the defending player’s hand and updates the goalkeeper position accordingly.
* Control Game Task
The control game task is the task which controls the flow of the game this includes waiting for the gyro-sensor values before animating the ball, updating player1 and player2 scores, determining the end of the game and taking appropriate action for it.
* Select Player Task
The select player task is the task displays the start screen animation and the color select logic.

To solve the ungraceful transition of the ball from the first half of the matrix to the other( Refer point 1e in the Challenges faced and Solutions section for more details) , we designed a draw pixel function which allows the users to pass the x, y and color coordinates without worrying about the two 32x64 sections and their different x coordinates this function takes the required 64x64 matrix coordinates, calculate the actual x (or ROW) coordinate value and the color value according to the 32x64 sections and draws the pixel at the desired location making addressing the exact required pixel easier. Following are the snippets of code that achieve this. 


[[File:drawPixel.jpg||500x600px|left|Draw Pixel]]
[[File:CalculateMatrixPosition.jpg||600x700px|right|Calculate Matrix Position]]

{|
|[[File:F18_GOGP2screentesting.jpg|thumb|350x250px|left|Player two Screen Testing]]
|[[File:F18_Startscreentesting.gif|thumb|450x350px|center|Start Screen Testing]]
|[[File:F18_tie.gif|thumb|250x250px|right|tie Testing]]
|}

===Testing===
{|
|[[File:F18_GOGP2screentesting.jpg|thumb|350x250px|left|Player two Screen Testing]]
|[[File:F18_Startscreentesting.gif|thumb|450x350px|center|Start Screen Testing]]
|[[File:F18_tie.gif|thumb|250x250px|right|tie Testing]]
|}

== Testing & Technical Challenges ==

===Issues, Challenges and solutions to get past them===

'''1.  RGB LED Matrix Display driver'''

a) Writing the driver function on our own was a challenge. We were able to easily glow a single row in the matrix. However, the challenge lied in glowing a single pixel value at a specified location. And lack of datasheet made it even more difficult. Once we got the control over glowing a single LED (check updateDisplay function as shown above), we were able to implement various functions to draw lines, digits, text, ball, and goalkeeper.

b) Matrix flickering problem in which pixels on the screen weren't consistently bright when a particular animation was going on
*To solve this, we stopped clearing the whole display multiple times and cleared the specific pixels which mattered. Also, we were using a separate task, in which we were sending the data through the queue to control game task which was causing the task to wait on the queue till the data arrived which was causing flickering.So we removed this task and read the wireless data packet in controlGoalkeeper task and controlGame task separately

c) Ball animation to achieve swing
*  We wrote an algorithm to find the path of the ball from the start point to endpoint (goalpost) to appear as if it were swinging

d) Handling screen refresh issue in which when we light up an LED, that would fade away in a few milliseconds
*  The solution to this was creating an array of size 64x64 and a dedicated task to update the LED matrix.

e) The ungraceful transition of the ball from the one half of the LED matrix to the other half
*   The solution to this calculated the new X value and new color in drawPixel function. Here we are calling calculateMatrixposition fucntion which will calculate and return new x value and new color value.

'''2. Designing the Gyroscope and Accelerometer driver for goalkeeper and player movements'''

a) Lose connection on MPU 6050
*  The solution to this was hard wiring the MPU 6050 sensor to a general purpose PCB so that connection issues occur. Once this was done, we were able to successfully get the tilt.
b) Precision for getting accurate direction
*  Since we have calculated five directions for ball movement, finding accurate gyroscope and accelerometer values with proper mapping was critical to our application.

'''3. Designing the Wireless driver'''
a)  System freeze when no data sent
*   We introduced a NACK to indicate that no data sent hence whenever this condition occurs it waits for the new data to be sent.

'''4. Dimensions of power pins for the PCB design'''

a) Accommodate the exact dimensions of the 5V Power pin on the PCB design.
*  Since there is no datasheet available for the 64x64 RGB LED Matrix, hence it was a difficult task. We used a basic approximation to determine the pin dimensions that would fit inside the PCB design such that it works just fine.

== Conclusion ==
We were successfully able to achieve gesture-based gaming capabilities via our game- Goals of Glory. Our project has been a huge success since we not only got it working but also had a great time playing and optimizing it to tune it for user application. In terms of learning, we are happy that we got introduced to graphics design. We were able to develop a game where 2 players i.e. a player and goalkeeper are able to play wirelessly and corresponding game visuals are displayed on LED Matrix in real time. This project helped us to work on different modules of an embedded system such as a display, wireless, gyroscope, an accelerometer and combine it into a ready-to-use hardware package. The project also improved our FreeRTOS skills which we learned in CMPE 244 class. Thus we were able to design an attractive and ready to use game console package encompassing gesture based gaming

=== Project Video ===
*  [https://www.youtube.com/watch?v=zId_HAEDWms Goals of Glory Demo Video]

=== Project Source Code ===
*  [https://github.com/HarmeenJ/Goals_of_Glory Source Code Link]


=== Acknowledgement ===
First of all, we would like to thank professor Preetpal Kang for giving us an opportunity to push ourselves than we could have imagined. We would also like to thank the ISA team for their help with various issues that we faced related to our project and lab assignments. Our project success also attributes to all 5 team members who worked tirelessly to complete the desired task in time. The amount of work put was worth the effort since once the project was completed we realized that it was totally worth it spending many sleepless nights on it.

=== References Used ===
[1] [https://www.freertos.org/ FreeRTOS]

[2] https://github.com/jrowberg/i2cdevlib/tree/master/Arduino/MPU6050

[3] [https://www.sparkfun.com/sparkx/blog/2650 Everything You Didn't Want to Know About RGB Matrix Panels]

[4] http://socialledge.com/sjsu/index.php/S18:_Death_Race

[5] [https://github.com/adafruit/Adafruit-GFX-Library Adafruit Github Library]

[6] https://www.invensense.com/products/motion-tracking/6-axis/mpu-6050/

[7] [https://www.sparkfun.com/datasheets/Components/SMD/nRF24L01Pluss_Preliminary_Product_Specification_v1_0.pdf Nordic Datasheet]

[8] https://www.sparkfun.com/products/14824