Difference between revisions of "F19: Alien Wars"

Revision as of 08:49, 18 December 2019

Alien Wars

Abstract

Alien wars is a single player combat game, with increasing levels of difficulty. Each level has a has target number of enemy spaceships to be destroyed, before the ultimate villain ‘the alien king’ appears. Once the ultimate villain is killed the player proceeds to next level. The speed of the enemy spaceships approaching the player will increase with the increasing levels. The player can choose to either shoot the enemy spaceship using missiles or dodge it. The game ends when the player crashes with enemy spaceship.

Objectives & Introduction

Objectives

Write drivers to display game characters and update the display continuously
Implement game algorithm for movement of player and enemy spaceships in real-time, generate bullets.
Implement spaceship, health and bullet collision algorithm
Write drivers to give directions from the input device (joystick)
Write drivers to transmit control signals wirelessly via Bluetooth
Write drivers to play game sounds via MP3 encoder
Use FreeRTOS tasks and understand task priority and synchronization.

Game User guide

1- player arcade game.
3-levels to reach victory.
Press switch on the joystick to start.
Movement of joystick controls the movement of spaceship
Press switch on joystick will now shoot bullets
Game advances as the spaceship kills certain enemy spaceships
The speed of the enemy spaceship increases in the second level
In the final level, the user spaceship faces the villain, user spaceship has to face the bullets from villain as well.
User spaceship has to survive the bullets and fire the enemy. After taking few hits, villain dies and its victory!
Throughout the game when the user spaceship collides with enemy or bullet, its health decreases, the color of the spaceship also changes. The game is over when player health is zero.

Team Members & Responsibilities

Abhinandan Burli
- Developing enemy game algorithm
- Developing game characters on LED matrix display
- GPIO driver for LED matrix display

Joel Samson
- Joystick interfacing - ADC driver
- Bluetooth Interfacing - UART driver for transmitter & receiver
- Game Animation Screens

Basangouda Patil
- Speaker and MP3 encoder interfacing
- GPIO driver for LED matrix displays
- Bug fixes and optimizations

Schedule

Week#	Date	Task	Status	Actual Completion Date
1	10/01/2019	Submission of Project Proposal	Complete	10/07/2019
2	10/08/2019	Alien Wars Project Approved	Complete	10/14/2019
3	10/15/2019	Create Wiki page for our project Submit project plan for upcoming weeks	Complete Complete	10/21/2019
4	10/22/2019	Research Required Components - LED matrix display, Joystick, Bluetooth module, MP3 encoder Order Parts and Identify Roles	Complete Complete	10/28/2019
5	10/29/2019	Analyze the hardware components - Bluetooth, LED Matrix display, MP3 encoder, joystick module. Read datasheets of all the components	Complete Complete	11/04/2019
6	11/05/2019	Develop basic game design, wiring and GPIO driver for LED matrix display. Test LED matrix display Print characters for start screen	Complete Complete Complete	11/11/2019
7	11/12/2019	Display objects on screen, control dynamic movement of player spaceship. Develop UART driver for wireless joystick communication (Bluetooth HC05 module)	Complete Complete	11/17/2019
8	11/19/2019	LED matrix integration with game. Develop enemy spaceships game algorithm Develop ADC driver for joystick interfacing Develop UART driver for MP3 encoder to play game sounds	Complete Complete Complete Complete	11/26/2019
9	11/26/2019	Joystick Integration with LED matrix display Develop missile collision and player life algorithm	Complete Complete	12/03/2019
10	12/03/2019	Initial game Testing Source code optimization	Complete Complete	12/09/2019
11	12/10/2019	Integration Testing Bug Fixes	Complete Complete	12/16/2019
12	12/17/2019	Final bug fixes and troubleshooting. Complete wiki report and final demo.	Complete Complete	12/18/2019

Parts List & Cost

Item#	Part Desciption	Vendor	Qty	Cost
1	SJTwo Boards	From Preet	3	$150.00
2	32x64 RGB LED Matrix	Adafruit	1	$92.00
3	Wiring Components and Cable	Amazon	1	$20
4	HC05 Bluetooth module	Amazon	2	$35
5	Adafruit Analog 2-axis thumb Joystick	Adafruit	1	$9
6	MP3 music player (YX5300)	Amazon	1	$8
7	5V,4A Power Adapter	Amazon	1	$10
8	DC Female Jack Power Adapter	Amazon	1	$5
9	AUX cable	Amazon	1	$5

Design & 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 and Implementation

YX5300 MP3 MODULE INTERFACING OVER I2C (SLAVE)

While browsing on amazon looking for a module to play extended sound effects (mp3 and wav files), I came across these modules that looked like they would fit my purpose. While it is easy to make the board play a sound, the downside is that there is not a huge lot of documentation for the board and the original is in Chinese. A copy of the official documentation I was able to find can be reached through this link. library can be found at on my code repository.

Hardware specifications

The yx5300 supports 8khz to 48khz sampling frequency mp3 and wav file formats. The audio files are stored on a micro SD card that plugs into a TF card socket on the back of the board.

The MCU controls the device playback by sending serial commands through a TTL level UART control interface (gnd, vcc, tx, rx). Pins are connected gnd to mcu ground, vcc to 5v power supply, yx5300 tx (transmit) to the designated rx (receive) pin for the library, yx5300 rx to tx. The mcu rx/tx can be hardware serial pins or a software controlled serial port. Sound is output through a headphone jack to headphones or an external amplifier. The board has a playback indicator led that blinks during playback and is steady otherwise. The TF card socket on the pcb reverse is for plugging in the micro SD card with mp3/wav files. The micro SD card should be formatted as fat16 or fat32 and songs must be prefixed with a unique 3 digit index number (for example, 001xxx.mp3, 002xxx.mp3, 003xxx.mp3, etc, where xxx is an arbitrary optional name. Songs may also be grouped in folders named ’01’, ’02’, ’03’, etc. An example folder and file structure on the micro SD card might look like:

+-+- 01
  | + 001-happy_dance.mp3
  | + 002-o_sole_mio.mp3
  |
  +- 02
  | + 003-humpty_dumpty.mp3
  | + 004-incy_wincy_spider.mp3
  | + 005-grand_duke.mp3
  | 
  +- 03
    + 006-fernando.mp3
    + 007-mamma_mia.mp3

Songs are referenced by folder and by song ‘index’, although it seems that the numeric index is sometimes ignored and the songs played in the order they are stored in the sd card. The documentation is unclear on this and seems to imply both situations. So, even if you plan only one playlist, it is better to keep them in a ’01’ folder and save all the songs to the SD card at the same time.

Communicating with the module

Communications is via asynchronous serial rs232 at 9600 bps, 8 data bits, no parity, 1 stop bit, no hardware flow control. Flow control is implemented using a request/response protocol with data packets in the following byte format:

Where the fields have the following meaning:

Start (0x7e) and end (0xef) mark the start and end of the serial packet. A receiver should synchronize on the start byte and read the packet to the end.
Version is always 0xff. I assume this is to cater for future changes in the protocol and would allow comms software to adjust dynamically.
Length is the number of bytes between the start byte and checksum. In this implementation it is always 6 bytes (the lighter colored boxes).
Cmd (command) in a request message is the control function code and in a response is error/status code.
Fback (feedback) is set to 1 to receive a request acknowledgement, or 0 for no acknowledgement.
Datahi and datalo are the high and low bytes of the command modifier or the status/error code. They are set to suit the cmd byte (see the tables below).
Chkhi and chklo are the checksum high and low bytes. The checksum is optional and can be omitted from requests messages, but a response from the device always includes the checksum field. The checksum is calculated as the two’s complement of the 16-bit sum of the bytes between start and checksum (ie, the same as those counted in length).

Device commands The interesting elements of the protocol message are the cmd and data fields. The cmd field allows us to control the module. The official english documentation provides a set of valid command codes and the Chinese documentation provides an additional set of codes. All the commands i have discovered are collated in the table below. Where the data field is required this is noted, otherwise it is set to zero and ignored.

Next_song 0x01 Play next song.
Prev_song 0x02 Play previous song.
Play_with_index 0x03 Play song with index number. Data is the index of the file.
Volume_up 0x04 Volume increase by one.
Volume_down 0x05 Volume decrease by one.
Set_volume 0x06 Set the volume to level specified. Data is the volume level [0..30].
Set_equalizer 0x07 Set the equalizer to specified level. Data is [0..5] – 0=normal, 1=pop, 2=rock, 3=jazz, 4=classic or 5=base.
Sng_cycl_play 0x08 Loop play (repeat) specified track. Data is the track number.
Sel_dev 0x09 Select file storage device. The only valid choice for data is tf (0x02).
Sleep_mode 0x0a Chip enters sleep mode.
Wake_up 0x0b Chip wakes up from sleep mode.
Reset 0x0c Chip reset.
Play 0x0d Playback restart.
Pause 0x0e Pause playback.
Play_folder_file 0x0f Play the file with the specified folder and index number
Stop_play 0x16 Stop playback.
Folder_cycle 0x17 Loop playback within specified folder. Data is the folder index.
Shuffle_play 0x18 Playback shuffle mode. Data is 0 to enable, 1 to disable.
Set_sngl_cycl 0x19 Set loop play (repeat) on/off for current file. Data is 0 to enable, 1 to disable.
Set_dac 0x1a Dac on/off control (mute sound). Data is 0 to enable dac, 1 to disable dac (mute).
Play_w_vol 0x22 Play track at the specified volume. Data hi byte is the track index, low byte is the volume level [0..30].
Shuffle_folder 0x28 Playback shuffle mode for folder specified. Data high byte is the folder index.

these are few of the commands, the rest can be found at

Bluetooth Implementation (Master & Slave)

Two HC05 Bluetooth modules were used. One was configured as the master using AT commands and the second module as slave. The baud rate for communication was set at 38400. The Master Bluetooth module was interfaced to the player joystick SJ2 board. The slave Bluetooth was interfaced to the main SJ2 board connected to the LED Matrix display. UART3 was used (Tx and Rx) for communication between the micro controller and HC05 Bluetooth module. On the transmitter side based on the analog joystick input, the enum value corresponding to that particular direction is sent. Based on the value received from the transmitter, decoding was done at the receiver driver and control value was sent to Update Spaceship task for further processing.

Bluetooth Module

UART3 initialization steps (Master & Slave)-

 
void uart__init_alien_uart3(lpc_peripheral_e uart, uint32_t peripheral_clock, uint32_t baud_rate)
{

   Turn ON UART3 peripheral;
   Set Pin directions;
   Set Pin functions;
   set Baud Rate as 38400;

}

Decoding at receiver node (setting the appropriate enum values)-

void set_joystick_control_signal(void) {

  if (received_data == 1)
    joystick_control_signal = down;
  else if (received_data == 2)
    joystick_control_signal = up;
  else if (received_data == 3)
    joystick_control_signal = left;
  else if (received_data == 4)
    joystick_control_signal = right;
  else if (received_data == 5)
    joystick_control_signal = right_up_diagonal;
  else if (received_data == 6)
    joystick_control_signal = right_down_diagonal;
  else if (received_data == 7)
    joystick_control_signal = left_up_diagonal;
  else if (received_data == 8)
    joystick_control_signal = left_down_diagonal;
  else if (received_data == 9)
    joystick_control_signal = bullet;
  else
    joystick_control_signal = center;
}

Thumb Joystick - SJTwo Board interface

The thumb joystick communicates with LPC408x controller via two ADC pins. The joystick provides two outputs: X-axis and Y-axis. The X-axis output (joystick) was connected to pin P0.25 (ADC2) and Y-axis output (joystick) to pin P0.26 (ADC3) of the micro controller. For player spaceship bullet firing the thumb joystick had a built-in button that was used. Based on the input readings a threshold level was defined. The corresponding enum was sent via Bluetooth to the receiver controller.

2-axis joystick

ADC initialization steps -

 
void adc__initialize_alien(void)
{

   Turn ON ADC peripheral;
   make ADC operational;
   set ADC clock;
   Set Pin functions;
   select ADC channels;
   start burst mode;

}

Threshold range for different joystick movements -

if (bullet_flag == true) {
    data = 9;
    bullet_flag = false;
  } else if (missile_flag == true) {
    data = 10;
    missile_flag = false;
  } else if ((value_x > 150 && value_x < 230) && (value_y > 150 && value_y < 230))
    data = 0; // center
  else if ((value_x < 150) && (value_y > 150 && value_y < 230))
    data = 3; // left
  else if ((value_x > 240) && (value_y > 150 && value_y < 230))
    data = 4; // right
  else if ((value_x > 150 && value_x < 230) && (value_y < 150))
    data = 1; // down
  else if ((value_x > 150 && value_x < 230) && (value_y > 240))
    data = 2; // up
  else if ((value_x > 320) && (value_y > 320))
    data = 5; // right up diagonal
  else if ((value_x > 310) && (value_y < 50))
    data = 6; // right down diagonal
  else if ((value_x < 100) && (value_y > 290))
    data = 7; // left up diagonal
  else if ((value_x < 50) && (value_y < 50))
    data = 8; // left down diagonal

Testing & Technical Challenges

This section includes information about testing and the technical challenges we faced while developing this project

Technical Challenges

Flickering of data -

SD card formatting and file structure -

Songs are referenced by folder and by song ‘index’, although it seems that the numeric index is sometimes ignored and the songs played in the order they are stored in the SD card. The documentation is unclear on this and seems to imply both situations. So, even if you plan only one playlist, it is better to keep them in a ’01’ folder and save all the songs to the SD card at the same time.

Exhausting UART peripherals -

We initially planned of interfacing the communication from the display board to the sound board over uart peripheral, as the project went on and since the master board has a bluetooth module to receive data from the joystick which is interfaced over uart too. We exhausted the uart peripherals on the sj two board, as the uart2 and uart4 were not getting iniitialized for some reason. Hence we had to change the interfacing protocol to i2c, where the display was the master and the sound board was the slave. The slave board was already using uart3, we had planned of using tx for communicating with the mp3 module and rx for receiving the commands from the display board. Finding game sounds to suit our game took a while, as we were looking for free sounds and many websites were selling it for price.

Int main(void) {

  i2c_data = 0;
  
  // uart interface to the mp3 module
  uart3_init();

  // i2c interface to receive the commands from the display board
  i2c2_init();
	
  // function prototype  bool senddatatomp3(char cmd, uint8_t msb, uint8_t lsb); 
  //set received to 0, so that after we send data we wait for an response and only     then go ahead with the next instruction 
  received = 0;
  senddatatomp3(0x09, 0x00, 0x02);
  while (received != 1)
    ;

  // stop playback
  received = 0;
  senddatatomp3(0x16, 0x00, 0x00);
  while (received != 1)
    ;

  while (1) {

    if (i2c_data == 1) {

      received = 0;
      senddatatomp3(0x08, 0x00, 0x01);

      i2c_data = 0;
    } else if (i2c_data == 2) {

      received = 0;
      senddatatomp3(0x0f, 0x01, 0x02);
      while (received != 1)
        ;
      i2c_data = 0;
    } else if (i2c_data == 3) {

      received = 0;
      senddatatomp3(0x0f, 0x01, 0x03);
      while (received != 1)
        ;
      i2c_data = 0;
    } else if (i2c_data == 4) {

      received = 0;
      senddatatomp3(0x0f, 0x01, 0x04);
      while (received != 1)
        ;
      i2c_data = 0;
    }
  }

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

Project Git link

References

Acknowledgement

We would like to thank our professor Preetpal Kang for putting together this class. It was indeed a great privilege and learning experience to be a part of this class. Big shout-out to all of our classmates, for contributing to Slack discussions. Special thanks to the ISA team for their valuable advice and constructive feedback

References Used

[1] Bluetooth AT commands