minors

.github/workflows/cd.yml

@@ -5,6 +5,9 @@ on:
     tags:
       - 'v*'
 
+permissions:
+  contents: write
+
 jobs:
   release:
     runs-on: ubuntu-latest
@@ -15,13 +18,12 @@ jobs:
       - name: Install Arduino CLI
         run: |
           curl -fsSL https://raw.githubusercontent.com/arduino/arduino-cli/master/install.sh | sh
-          echo "$HOME/bin" >> $GITHUB_PATH
+          echo "./bin" >> $GITHUB_PATH
 
       - name: Install Board Core and Libs
         run: |
           arduino-cli core update-index
           arduino-cli core install arduino:renesas_uno
-          arduino-cli lib install "Arduino_LED_Matrix"
 
       - name: Build Binary
         run: make compile
@@ -30,6 +32,6 @@ jobs:
         uses: softprops/action-gh-release@v2
         with:
           files: |
-            build/arduino.renesas_uno.unor4wifi/arduino_pong.ino.bin
+            build/*.bin
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/ci.yml

@@ -7,6 +7,8 @@ on:
       - 'arduino_pong.ino'
       - 'Makefile'
       - '.github/workflows/ci.yml'
+      - '*.cpp'
+      - '*.h'
 
 jobs:
   build:

.gitignore

@@ -1,3 +1,4 @@
 .secrets
 .arduino_cache/
 bin/
+build/

Makefile

@@ -30,8 +30,13 @@ prepare:
 	fi
 
 compile:
+	@mkdir -p build
 	@echo -e "$(GREEN)🛠️  Compiling $(SKETCH)...$(CLEAR)"
-	@$(CLI) compile -b $(BOARD) $(SKETCH)
+	@$(CLI) compile -b $(BOARD) --output-dir build $(SKETCH)
+
+clean:
+	@echo -e "$(GREEN)🛠️  Removing build files...$(CLEAR)"
+	@rm -rf build/
 
 prepare_and_compile:
 	make prepare --no-print-directory

README.md

@@ -3,11 +3,12 @@
 A classic implementation of the Pong game developed specifically for the Arduino UNO R4 WiFi, utilizing its built-in 12×8 LED matrix as the game screen.
 
 [![Arduino Pong CI](https://github.com/Dea1993/arduino_pong/actions/workflows/ci.yml/badge.svg?branch=master)](https://github.com/Dea1993/arduino_pong/actions/workflows/ci.yml)
+[![Arduino Pong CD](https://github.com/Dea1993/arduino_pong/actions/workflows/cd.yml/badge.svg)](https://github.com/Dea1993/arduino_pong/actions/workflows/cd.yml)
 [![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](LICENSE)
 
 # 📹 Preview
 
-![Pong](preview.png)
+![Pong](assets/preview.png)
 
 Youtube: https://youtu.be/ouLBTDjpKqc
 

arduino_pong.ino

@@ -1,22 +1,20 @@
 #include "Arduino_LED_Matrix.h"
 
-#define P1_BTN_UP 13
+#include "config.h"
-#define P1_BTN_BOTTOM 12
+#include "pong_render.h"
-#define P2_BTN_UP 11
+#include "pong_player.h"
-#define P2_BTN_BOTTOM 10
+#include "pong_ball.h"
-#define MATRIX_WIDTH 12
-#define MATRIX_HEIGHT 8
 
 // create LED matrix object
 ArduinoLEDMatrix matrix;
 
-// initial pong frame
+// initial pong frame matrix
 byte frame[MATRIX_HEIGHT][MATRIX_WIDTH] = {
   { 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0 },
   { 1, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0 },
   { 1, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0 },
-  { 1, 0, 0, 0, 0, 0, 1, 0, 0, 0, 0, 0 },
+  { 1, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0 },
-  { 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 1 },
+  { 0, 0, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1 },
   { 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 1 },
   { 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 1 },
   { 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0 }
@@ -24,185 +22,43 @@ byte frame[MATRIX_HEIGHT][MATRIX_WIDTH] = {
 
 // players coordinates
 int p1_start= 1;
-int p1_end= 3;
-
 int p2_start= 4;
-int p2_end= 6;
 
 // initials balls coordinates
-int ball_reset_x= MATRIX_WIDTH / 2;
+int ball_x= BALL_RESET_X;
-int ball_reset_y= MATRIX_HEIGHT / 2;
+int ball_y= BALL_RESET_Y;
-int ball_x= ball_reset_x;
-int ball_y= ball_reset_y;
-
-// initially ball has no movements
-// once game/round starts, balls gets random x and y movements
-int ball_move_x= 0;
-int ball_move_y= 0;
-
-int bar_length= 3;
-int p1_score= 0;
-int p2_score= 0;
 
 int need_refresh= 1;
 
-int initial_loop_delay= 200;
+int ball_delay= INITIAL_BALL_DELAY;
-int loop_delay= initial_loop_delay;
-// used to increase speed when game is too easy
-int hits= 0;
 
 long exec_t2= millis();
 
+
 void setup() {
-  //Serial.begin(115200);
   Serial.begin(9600);
-  // stard LED matrix
+  // start LED matrix
   matrix.begin();
   pinMode(P1_BTN_UP, INPUT_PULLUP);
   pinMode(P1_BTN_BOTTOM, INPUT_PULLUP);
   pinMode(P2_BTN_UP, INPUT_PULLUP);
   pinMode(P2_BTN_BOTTOM, INPUT_PULLUP);
 
-  randomSeed(analogRead(0));
+  randomSeed(millis());
-}
-
-void render_matrix() {
-  if (!need_refresh) return;
-  need_refresh= 0;
-  // clear
-  for (int x=0; x < MATRIX_WIDTH; x++) {
-    for (int y=0; y < MATRIX_HEIGHT; y++) {
-      frame[y][x]= 0;
-    }
-  }
-  
-  // players coords
-  for (int i= p1_start; i < p1_start+bar_length; i++) {
-    frame[i][0]= 1;
-  }
-  for (int i= p2_start; i < p2_start+bar_length; i++) {
-    frame[i][MATRIX_WIDTH-1]= 1;
-  }
-  
-  // ball coords
-  frame[ball_y][ball_x]= 1;
-
-  matrix.renderBitmap(frame, MATRIX_HEIGHT, MATRIX_WIDTH);
-}
-
-void pong_move_p1() {
-  if (digitalRead(P1_BTN_UP) == LOW && p1_start > 0) {
-    p1_start -= 1;
-    need_refresh= 1;
-  }
-  else if (digitalRead(P1_BTN_BOTTOM) == LOW && p1_start < 5) {
-    p1_start += 1;
-    need_refresh= 1;
-  }
-}
-
-void pong_move_p2() {
-  if (digitalRead(P2_BTN_UP) == LOW && p2_start > 0) {
-    p2_start -= 1;
-    need_refresh= 1;
-  }
-  else if (digitalRead(P2_BTN_BOTTOM) == LOW && p2_start < 5) {
-    p2_start += 1;
-    need_refresh= 1;
-  }
-}
-
-int ball_player_collision(int player) {
-  for (int p= player; p < player + bar_length; p++) {
-    if (ball_y == p) {
-      return 1;
-    }
-  }
-  return 0;
-}
-
-void point_scored() {
-  ball_x= ball_reset_x;
-  ball_y= ball_reset_y;
-  Serial.print("P1: ");
-  Serial.print(p1_score);
-  Serial.print(" - ");
-  Serial.print("P2: ");
-  Serial.print(p2_score);
-  Serial.println();
-
-  hits= 0;
-  loop_delay= initial_loop_delay;
-}
-
-void move_ball() {
-  need_refresh= 1;
-  if (ball_x < 0 || ball_x > MATRIX_WIDTH-1 || ball_y < 0 || ball_y > MATRIX_HEIGHT-1) {
-    // ball out of matrix limits
-    ball_x= ball_reset_x;
-    ball_y= ball_reset_y;
-    return;
-  }
-  
-  // if ball is not moving, get random direction
-  // this is the initial position
-  if (ball_move_x == 0 || ball_move_y == 0) {
-    // extract random number between 0 or 1 to select the directions
-    if (random(2) == 0) ball_move_x= 1;
-    else ball_move_x= -1;
-    if (random(2) == 0) ball_move_y= 1;
-    else ball_move_y= -1;
-  }
-
-  else if (ball_x == 0) {
-    // if p1 collision: reverse x, go left
-    if (!ball_player_collision(p1_start)) {
-      // else p2 score, reset board
-      p2_score += 1;
-      Serial.println("Player 2 Scores");
-      point_scored();
-    }
-    else {
-      hits += 1;
-      ball_move_x= ball_move_x * -1;
-    }
-  }
-  else if (ball_x == MATRIX_WIDTH-1) {
-    if (!ball_player_collision(p2_start)) {
-      // else p1 score, reset board
-      p1_score += 1;
-      Serial.println("Player 1 Scores");
-      point_scored();
-    }
-    else {
-      hits += 1;
-      ball_move_x= ball_move_x * -1;
-    }
-  }
-
-  if (ball_y == 0 || ball_y == MATRIX_HEIGHT-1) {
-    // reverse y, go down
-    ball_move_y= ball_move_y * -1;
-  }
-
-  if (hits >= 6 && loop_delay >= 80) {
-    // increase ball speed
-    hits = 0;
-    loop_delay -= 20;
-  }
-
-  ball_x+= ball_move_x;
-  ball_y+= ball_move_y;
 }
 
 void loop() {
   long exec_t1= millis();
-  pong_move_p1();
+  pong_move_p1(p1_start, need_refresh);
-  pong_move_p2();
+  pong_move_p2(p2_start, need_refresh);
-  render_matrix();
+  if (exec_t1 - exec_t2 > ball_delay) {
-  if (exec_t1 - exec_t2 > loop_delay) {
+    move_ball(ball_x, ball_y, ball_delay, p1_start, p2_start, need_refresh);
-    move_ball();
     exec_t2= exec_t1;
   }
+  if (need_refresh) {
+    render_matrix(frame, p1_start, p2_start, ball_x, ball_y);
+    matrix.renderBitmap(frame, MATRIX_HEIGHT, MATRIX_WIDTH);
+    need_refresh= 0;
+  }
   delay(50);
 }

config.h

@@ -0,0 +1,11 @@
+#define P1_BTN_UP 13
+#define P1_BTN_BOTTOM 12
+#define P2_BTN_UP 11
+#define P2_BTN_BOTTOM 10
+
+#define MATRIX_WIDTH 12
+#define MATRIX_HEIGHT 8
+#define BALL_RESET_X (MATRIX_WIDTH / 2)
+#define BALL_RESET_Y (MATRIX_HEIGHT / 2)
+#define BAR_LENGTH 3
+#define INITIAL_BALL_DELAY 200

pong_ball.cpp

@@ -0,0 +1,88 @@
+#include <Arduino.h>
+#include "config.h"
+#include "pong_player.h"
+
+// used to increase speed when game is too easy
+int hits= 0;
+
+int p1_score= 0;
+int p2_score= 0;
+
+// initially ball has no movements
+// once game/round starts, balls gets random x and y movements
+int ball_move_x= 0;
+int ball_move_y= 0;
+
+void point_scored(int &ball_x, int &ball_y, int &ball_delay) {
+  ball_x= BALL_RESET_X;
+  ball_y= BALL_RESET_Y;
+  Serial.print("P1: ");
+  Serial.print(p1_score);
+  Serial.print(" - ");
+  Serial.print("P2: ");
+  Serial.print(p2_score);
+  Serial.println();
+
+  hits= 0;
+  ball_delay= INITIAL_BALL_DELAY;
+}
+
+void move_ball(int &ball_x, int &ball_y, int &ball_delay, int p1_start, int p2_start, int &need_refresh) {
+  need_refresh= 1;
+  if (ball_x < 0 || ball_x > MATRIX_WIDTH-1 || ball_y < 0 || ball_y > MATRIX_HEIGHT-1) {
+    // ball out of matrix limits
+    ball_x= BALL_RESET_X;
+    ball_y= BALL_RESET_Y;
+    return;
+  }
+  
+  // if ball is not moving, get random direction
+  // this is the initial position
+  if (ball_move_x == 0 || ball_move_y == 0) {
+    // extract random number between 0 or 1 to select the directions
+    if (random(2) == 0) ball_move_x= 1;
+    else ball_move_x= -1;
+    if (random(2) == 0) ball_move_y= 1;
+    else ball_move_y= -1;
+  }
+
+  else if (ball_x == 0) {
+    // if p1 collision: reverse x, go left
+    if (!ball_player_collision(p1_start, ball_y)) {
+      // else p2 score, reset board
+      p2_score += 1;
+      Serial.println("Player 2 Scores");
+      point_scored(ball_x, ball_y, ball_delay);
+    }
+    else {
+      hits += 1;
+      ball_move_x= ball_move_x * -1;
+    }
+  }
+  else if (ball_x == MATRIX_WIDTH-1) {
+    if (!ball_player_collision(p2_start, ball_y)) {
+      // else p1 score, reset board
+      p1_score += 1;
+      Serial.println("Player 1 Scores");
+      point_scored(ball_x, ball_y, ball_delay);
+    }
+    else {
+      hits += 1;
+      ball_move_x= ball_move_x * -1;
+    }
+  }
+
+  if (ball_y == 0 || ball_y == MATRIX_HEIGHT-1) {
+    // reverse y, go down
+    ball_move_y= ball_move_y * -1;
+  }
+
+  if (hits >= 6 && ball_delay >= 80) {
+    // increase ball speed
+    hits = 0;
+    ball_delay -= 20;
+  }
+
+  ball_x+= ball_move_x;
+  ball_y+= ball_move_y;
+}

pong_ball.h

@@ -0,0 +1,7 @@
+#ifndef PONG_BALL_H
+#define PONG_BALL_H
+
+void point_scored();
+void move_ball(int &ball_x, int &ball_y, int &loop_delay, int p1_start, int p2_start, int &need_refresh);
+
+#endif

pong_player.cpp

@@ -0,0 +1,33 @@
+#include <Arduino.h>
+#include "config.h"
+
+int ball_player_collision(int player, int ball_y) {
+  for (int p= player; p < player + BAR_LENGTH; p++) {
+    if (ball_y == p) {
+      return 1;
+    }
+  }
+  return 0;
+}
+
+int pong_move_p1(int &p1_start, int &need_refresh) {
+  if (digitalRead(P1_BTN_UP) == LOW && p1_start > 0) {
+    p1_start -= 1;
+    need_refresh= 1;
+  }
+  else if (digitalRead(P1_BTN_BOTTOM) == LOW && p1_start < 5) {
+    p1_start += 1;
+    need_refresh= 1;
+  }
+}
+
+int pong_move_p2(int &p2_start, int &need_refresh) {
+  if (digitalRead(P2_BTN_UP) == LOW && p2_start > 0) {
+    p2_start -= 1;
+    need_refresh= 1;
+  }
+  else if (digitalRead(P2_BTN_BOTTOM) == LOW && p2_start < 5) {
+    p2_start += 1;
+    need_refresh= 1;
+  }
+}

pong_player.h

@@ -0,0 +1,8 @@
+#ifndef PONG_PLAYER_H
+#define PONG_PLAYER_H
+
+int ball_player_collision(int player, int ball_y);
+int pong_move_p1(int &p1_start, int &need_refresh);
+int pong_move_p2(int &p2_start, int &need_refresh);
+
+#endif

pong_render.cpp

@@ -0,0 +1,22 @@
+#include <Arduino.h>
+#include "config.h"
+
+void render_matrix(byte frame[MATRIX_HEIGHT][MATRIX_WIDTH], int p1_start, int p2_start, int ball_x, int ball_y) {
+  // clear
+  for (int x=0; x < MATRIX_WIDTH; x++) {
+    for (int y=0; y < MATRIX_HEIGHT; y++) {
+      frame[y][x]= 0;
+    }
+  }
+  
+  // players coords
+  for (int i= p1_start; i < p1_start+BAR_LENGTH; i++) {
+    frame[i][0]= 1;
+  }
+  for (int i= p2_start; i < p2_start+BAR_LENGTH; i++) {
+    frame[i][MATRIX_WIDTH-1]= 1;
+  }
+  
+  // ball coords
+  frame[ball_y][ball_x]= 1;
+}

pong_render.h

@@ -0,0 +1,9 @@
+#ifndef PONG_RENDER_H
+#define PONG_RENDER_H
+
+#include <Arduino.h>
+#include "Arduino_LED_Matrix.h"
+
+void render_matrix(byte frame[MATRIX_HEIGHT][MATRIX_WIDTH], int p1_start, int p2_start, int ball_x, int ball_y);
+
+#endif