Difference between revisions of "F20: Bubble Shooter"

Revision as of 07:49, 18 December 2020

Abstract

Bubble shooter is an arcade game that has bubbles or balls present on the screen. The bubbles are of different colors and the goal is to clear them by forming a group of bubbles (3 or more) of the same color. Points are earned upon clearing the bubbles and increases with the number of bubbles cleared in a single shot. The player wins upon clearing the screen and loses when the bubbles touch the bottom of the screen.

Block Diagram of Bubble Shooter

Objectives & Introduction

[[File:Project Pic.jpg|thumb|500x500px|right Team Bubble Shooter]

The objective of this project is to develop a single-player 2D arcade game using LPC 4078 microcontroller on a 64 X 32 LED matrix display. Project focus on integrating Sj2 microcontroller board with LED Matrix, MP3 Decoder, 2 pushbuttons, and joystick. It focuses on integrating the micro-controller peripheral drivers, led drivers, MP3 player, button and joystick controller interface and the application software in FreeRTOS. The button controller interface consists of the joystick for moving the shooter left and right. The button is used to fire the ball.

Team Members

• Akshat Bhutiani
• Amiraj Nigam
• Anirudh Ashrit
• Hisaam Hashim

Technical Responsibilities

Administrative Responsibilities

Schedule

Bill Of Materials

PCB Design

The board is designed to connect modules in the game directly. Autodesk's Eagle software is used to design the Schematics and Board layout. The board has 2 layers(Top and Bottom). JLCPCB is the manufacturer of the PCB board. Connections from SJ2 Board are provided to the PCB, which are internally connected to MP3 Decoder, Joystick, Buttons, and LED Matrix pins. These are connected directly to the peripherals using a harness. Additional power and ground pins are also provided on the board.

Schematic Design of PCB

Design Overview of the PCB

PCB Board Layout

PCB Front Face

PCB Back Face

Joystick

Hardware Design

An ADA512 2-axis Analog Joystick and Button is used for controlling the movement of the launcher and shooting the ball. The data from the joystick is read using the ADC pins of the SJTwo board. The button switch is detected using a digital pin on the board.

Features of the joystick:

1. Usable with any voltage up to 5V 2. Analog outputs 3. 1 mA draw when used with 5V 4. On-board button 5. High sensitivity

Breakout board layout

Soldered joystick

Software Design & Implementation

The ADA512 joystick's device driver works on the principle that the ADC pins will be able to read the x and y values. The joystick consists of 2 inbuilt potentiometers that provide output (x and y directions) according to the way the joystick is moved.

Steps to read joystick data:

1. Turn on the ADC Peripheral 2. Make the ADC pin operational by setting the appropriate pin functionality using the IOCON registers. 3. Set the appropriate ADC clock (12.4 MHz is the maximum clock supported by the ADC). 4. Set the ADC pin functionality as input. 5. Select the number of channels to read. 6. Select burst mode for immediate conversion.

void adc__initialize_alien(void)
{
Turn ON ADC peripheral;
make ADC operational;
set ADC clock;
Set Pin functions;
select ADC channels;
start burst mode;
}  
data get_data(adc_channel_e x_port, adc_channel_e y_port, gpio_s button_press) {
data s;
s.x_data = adc__get_adc_value(x_port);
s.y_data = adc__get_adc_value(y_port);
if (gpio__get(button_press)) {
s.switch_pressed = true;
} else {
s.switch_pressed = false;
}
return s;
} 

MP3 Decoder

The MP3 shield communicates with the sister SJ2 board through SPI communication protocol with the SPI0 pins of the SJ2 board as follows:

Hardware Design

MP3 Layout

Software Design

MP3 Layout

Implementation

To initialize the MP3 decoder, we have first initialized the SSP0 and the SJ2 pins connected to the MP3 decoder with proper input/output function configurations. We then configure the decoder registers by selecting the MP3 chip select pin and writing data over SPI. These include the mode (default), clock frequency multiplier (3x), volume (max), and audio (44100 Hz stereo data). We then flush the mp3 decoder, sending it 2500 0 bytes. Reading the MP3 File from an SD Card[edit] We create a low priority task (read_song_from_sd_card) to read from the SD Card. Read_song_from_sd_card task first opens the mp3 file on the sd card and determines the size. Afterward, it reads in 512 bytes at a time to a global array (whenever the music playing task has finished playing the previous 16 bytes) and sets a global variable (sdready) to true. It will continue to do this until the file has been completely read, and then start over from the beginning.

Feeding the Decoder and Playing Music

We create another low priority task (play_song_task) to play music. If the MP3 DREQ pin is currently set, it delays. Otherwise, whenever sdready is true, it selects the Data chip select line and sends 32 bytes over the SPI bus. It then deselects data chip select and redoes this 16 times (sending the 512 bytes that have been read). After it has sent all 512 bytes, it sets sdready to false so the read_song_from_sd_card task knows to read in the next 512 bytes. It continues to repeat this process for as long as mp3sdcard reads in data to the array.

Task to read song from sd card

void read_level_1_bgm_from_sdcard(void *p) {
 vTaskSuspend(NULL);
 unsigned int ptr_to_bytes_read = 0;
 while (1) {
   const char filename_path[] = "level1.mp3";
   FIL song;
   // Open or creates a file
   FRESULT check = f_open(&song, filename_path, (FA_READ | FA_OPEN_ALWAYS));
   if (FR_OK == check) {
     f_lseek(&song, f_size(&song));
     current_position_in_mp3_file = f_tell(&song);
     current_position_in_mp3_file /= 32;
     f_lseek(&song, 0);
     mp3_file_size = 0;
     song_position = 0;
     f_read(&song, &data_buffer, BYTES_TO_READ, &ptr_to_bytes_read);
     while (mp3_file_size < current_position_in_mp3_file + 32) {
       if (song_position == 16 & sdready == false || sdready == false) {
         f_read(&song, &data_buffer, BYTES_TO_READ, &ptr_to_bytes_read);
         mp3_file_size += 16;
         song_position = 0;
         sdready = true;
       }
       vTaskDelay(1);
     }                            
     printf("Song finished! \n");
     f_close(&song);              
     song_position = 0;
     mp3_file_size = 0;
     vTaskDelay(500);
   }
   else {
     printf("Failed to read SD card \n");
   }
   vTaskDelay(1);
  }
 }

Task to play song

void play_song_task(void *p) {
 vTaskSuspend(NULL);
 while (mp3_file_size < current_position_in_mp3_file + 32) {
   while ((song_position < 16) && (sdready == true) && (mp3_sel == 0)) {
     while (!(LPC_GPIO0->PIN & (MP3_DREQ))) {
       vTaskDelay(1);
       ;
     }
     LPC_GPIO0->CLR = (MP3_DCS);
     for (int a = 0; a < 32; a++) {
       spi0_ExchangeByte(data_buffer[a + (song_position * 32)]);
     }
     // sdready = false;
     song_position++;
     LPC_GPIO0->SET = (MP3_DCS);
     if (song_position == 16) {
       mp3_sel = 0;
       sdready = false;
     }
   }
 }
}

Binary Semaphore

We have low priority created check_which_song_recieved_from_main_sj2_board_semaphore_give which will act as a producer task which will select which mp3 background music or sound fx need to be played and it will give the semaphore of the selected music file to the high priority consumer task called play_song_task which will suspend all other song handlers and play the selected song.

Communication between Main and Sister SJ2 board

We have initialized 3 GPIO pins on the main(P0.15, P0.18, P0.1) and sister board(P2.0, P2.2, P2.5) and we have a total of 8 songs list, to which the respective GPIO pins will be high or low based on the song selection. The GPIO pins on the mainboard will be the output pins and the GPIO pins on the sister board will be the input pins. Henceforth, the sister board will receive input from the mainboard for the song selection and a binary semaphore will play the song.

LED Matrix

Hardware Design

We use a 32x64 LED matrix consisting of 2048 LEDs arranged in 32 rows and 64 columns each, with each led having separate Red, Green, and Blue LED chips assembled together as a single unit. This 32x64 LED matrix is comprised of 2 of 16x32 led matrices placed vertically to each other. There are different drivers for controlling the corresponding rows and columns each. In order to illuminate a particular led, one needs to access and control the corresponding row and column (just like the coordinate-axis). To change the color of a particular led, each led must be controlled using the driver for that row and column. A layout of pins and connections can be seen below:

LED Matrix and SJ2 Connections

LED Matrix Ribbon Connector

The matrix pixels are controlled by 6 drivers, 3 for the top half of the matrix(R0, G0, B0) and 3 for the bottom half(R1, G1, B1). The three drivers for R, G, and B share an SCLK, Latch, and OE signal. The top half pixels of the matrix controlled by R0, G0, B0 are rows 0-15, and the second half controlled by R1, G1, B1 are rows 16-31. The display is multiplexed at a duty cycle of 1/16, this means that one row in the top half and one row in the bottom half will be illuminated at a time. In order to display an image, the row and column LEDs for that image must be turned “ON”, therefore, the entire panel must be scanned at a rate(speed) at which it appears that the image is being displayed without flickering. To display different colors and different brightness levels, the LED chips of the corresponding row and column must be adjusted by varying the amount and time that each LED chip is turned on during each cycle.

LED Matrix Specifications:

5V regulated power input, 4A max (all LEDs on)

2.1 mm x 2.1 mm LED size

1/16 Scan Rate

LED Matrix Interfacing

Start Screen of the game

Software Design

Game

The game has 3 levels apart from the main menu, Credit scene, and Game-over screen. Just like any other arcade game, the game only starts when you earn credits and it is earned by pressing a button. The game begins with the press of another button. A block of bubbles starts falling down with every turn and finishes if it touches the danger line below. Bubbles, when hit with similar color, get destroyed and the game advances to the next level when all the bubbles on the screen are cleared. There's also a hack to traverse through levels, just press the credit score button and it will do the job for you. But hey, that's a cheat code, so you're a cheater!

RGB Color Combo

Implementation

1. Initialize the LED matrix by configuring necessary pin directions. 2. Disable Output Enable (OE) GPIO before feeding matrix data. 3. Select the required row by setting bits on A, B, C, D GPIO pins. 4. Loop through the pixels (columns) in the selected row and set the pixel color on R, G, B GPIO pins. 5. Set zero on R, G, B GPIO pins to mask that particular pixel. 6. Set and Reset the clock for pushing the R, G, B bits for each column. 7. Issue latch to mark the row's completion and reset the latch before going to the next row. 8. Follow steps 2 to 7 for other rows.

for (uint8_t row = 0; row < (MAX_ROW); row++) {
     disableOE();
     set_row(row);
     for (uint8_t col = 0; col < MAX_COL; col++) {
       LPC_GPIO0->PIN |= (1 << CLK);
       set_color_bottom(game_matrix[row + (MAX_ROW / 2)][col]);
       set_color_top(game_matrix[row][col]);
       LPC_GPIO0->PIN &= ~(1 << CLK);
     }
     LPC_GPIO0->PIN |= (1 << LAT);
     enableOE();
     LPC_GPIO0->PIN &= ~(1 << LAT);
     enableOE();
     vTaskDelay(1);
}

Graphics Driver

We have managed to program the graphics in a relatively simple way by looking at the ADAFruit gfx library that comes ready to use with Arduino. Our graphics driver can implement graphics and animations such as letters, numbers, ball appearance and ball disappearance etc.

void place_launcher(LedMatrixDisplay led_display, pixel_color rgb, gfx__cursor start_cursor, bool 
choose_back_frame) {
game_event object_property = BACKGROUND_OBJECT;
rgb.event = object_property;
draw_line(led_display, rgb, ROTATION_90, start_cursor, 9, choose_back_frame);
modify_pixel(led_display, rgb, start_cursor.x + 0, start_cursor.y + 1, choose_back_frame);
modify_pixel(led_display, rgb, start_cursor.x + 0, start_cursor.y + 2, choose_back_frame);
modify_pixel(led_display, rgb, start_cursor.x + 1, start_cursor.y + 3, choose_back_frame);
modify_pixel(led_display, rgb, start_cursor.x + 2, start_cursor.y + 4, choose_back_frame);
modify_pixel(led_display, rgb, start_cursor.x + 3, start_cursor.y + 5, choose_back_frame);
modify_pixel(led_display, rgb, start_cursor.x + 4, start_cursor.y + 5, choose_back_frame);
modify_pixel(led_display, rgb, start_cursor.x + 5, start_cursor.y + 5, choose_back_frame);
modify_pixel(led_display, rgb, start_cursor.x + 6, start_cursor.y + 4, choose_back_frame);
modify_pixel(led_display, rgb, start_cursor.x + 7, start_cursor.y + 3, choose_back_frame);
modify_pixel(led_display, rgb, start_cursor.x + 8, start_cursor.y + 1, choose_back_frame);
modify_pixel(led_display, rgb, start_cursor.x + 8, start_cursor.y + 2, choose_back_frame);
}

Game Level 1

Game Over Screen

Graphics display

Game Engine

Game Design

The game starts with the Main Menu, which has the number of turns, score, and Level on the top. A credit count and Ball queue are placed at the bottom of the screen. Once the credit button is pressed and credits are accumulated and the game starts by pressing the trigger button. A bubble is ready inside the trigger and the player just needs to adjust the pointer and shoot in the desired direction. Two other bubbles based on the number of colored bubbles present on the top is available in the queue. After the ball is released from the trigger it checks the property of the above objects and functions accordingly. If the released bubble encounters a border wall, then it bounces off in the opposite direction, if it encounters the bubbles then sticks to it if it's a different color, else destroys all the same colored bubbles. And finally, if the ball touches the Wall on the top then it doesn't stick but gets destroyed. The trigger remains empty and the queue still has the old bubbles. Based on the final function of the released bubble, a function scans the number of different colored bubbles in the stack and calculates the color of bubbles that are present in more. The trigger and queue then get updated with new bubbles and the wall comes down a bit further near the danger line.

The above process keeps happening until either all the bubbles are cleared, the wall reaches the danger line, or you cheat your way to the next level. Have fun playing!

Testing & Technical Challenges

As with any other project, even this threw challenges along the way.

LED Matrix

1. Understanding the matrix and then getting it to run was difficult as proper documentation or resource for the matrix was not available.

2. OE pin was not active low and it took us some time to figure it out.

3. Bubble, after released by the player, should move in the direction of the pointer and bounce off the border wall.

A graphics library was developed to print Alphanumerics in both horizontal and vertical positions. The driver was designed in a way to simply accept the coordinates of the board, shape, and color of the bubble instead of plotting it manually.

MP3 Decoder

1. Communicating with the decoder using SSP was challenging and took multiple rounds of debugging to start playing the tracks.

2. Switching between the songs when levels change also gave some issues.

Inputs from SJ2 were enabled to indicate the level change within the state machine, this way when the level changed the respective pin indicated the song to be played.

Game Design

1. First major challenge was to clear all the same colored bubbles once it was hit by the player bubble.

2. The Second challenge was to figure out an algorithm for the released bubble to either get attached or destroyed when it touches the bubble-block.

3. Designing the functionalities of border walls to bounce the released bubble, the wall to come down and destroy if the player bubble touches it, and aligning with nearby bubbles were few other challenges faced in game design.

A function that scans the bubble-block and then returns the number of different colored bubbles present was implemented to identify and destroy all the same colored bubbles. Bubbles were defined with sticky and player properties and when the player bubble encounters the sticky property, stops moving and either sticks to it or destroys it. Similarly, a wall and bounce property was defined to guide the bubble.

Future Suggestions

1. Modify a single pixel with different locations to get a thorough understanding of the led matrix. Check all the possible colors to identify any faulty pixels on the board. Write a generic scalable code to help you in the game. Implement frame methodology to prevent flickering and achieve a smooth transition of pixels.

2. Preferably use UART based MP3 decoder rather than SPI.

Conclusion

This project was a fun and strenuous application of our engineering and project management skills.

After completing the driver labs during CMPE 244, we felt confident that we could develop a driver, for the Adafruit LED matrix, without using any third-party libraries. We researched the hardware operations of the LED matrix and how to drive the RGB LED. Once we could control LEDs one at a time, the project evolved from an engineering problem into more of a creative exercise.

Overall I think the biggest lesson that we learned is project management based. We spent a lot of time choosing between various game designs and it forced us to start our final iteration later than we would have liked. However, we bonded together and worked hard, and managed to get the game working.

Project Video

• Project Demo

Project Source Code

• Project Source Code

References

Acknowledgement

We would like to sincerely thank Professor Preetpal Kang for his all-round guidance, feedback, and support. His classroom lectures were significant in imparting knowledge on embedded systems. Further, we would like to thank the ISA team for their advice.

References Used

• RGB Panel Hookup Guide 1
• RGB Panel Hookup Guide 2
• Shift Register Datasheet
• MP3 Decoder hookup guide
• VS1053B datasheet
• AutoDesk Eagle Software Tutorial
• Joystick Reference