Show page

Differences

This shows you the differences between two versions of the page.

--- pm:prj2024:fgul:andra.vlad [2024/05/16 00:05]
andra.vlad [Bibliografie/Resurse]
+++ pm:prj2024:fgul:andra.vlad [2024/05/26 15:06] (current)
andra.vlad [Rezultate Obţinute]
@@ Line 5: / Line 5: @@
 În acest proiect voi implementa un joc de Tetris controlat de un joystick. Jocul va fi afișat pe o matrice de LED-uri 8x8. \\
-Detaliile jocului (scor, game over etc.) se vor afișa pe un display LCD 16x2. \\
+Detaliile jocului (scor, highscore, game over etc.) se vor afișa pe un display LCD 20x4. \\
-De fiecare dată când se va face un rând în jocul de Tetris, buzzer-ul va emite un sunet de confirmare. \\
+Buzzer-ul va cânta melodia Tetris. De fiecare dată când se va face un rând în jocul de Tetris, buzzer-ul va întrerupe melodia și va emite un sunet de confirmare, după care rândul va fi eliminat de pe matricea de LED-uri. \\
-Am ales acest proiect nu numai pentru că este un joc retro foarte drăguț, ci și pentru că am putut include multe dintre informațiile învățate la laborator, precum lucrul cu GPIO, SPI, I2C și multe altele. :D
+Am ales acest proiect nu numai pentru că este un joc retro foarte drăguț, ci și pentru că am putut include multe dintre informațiile învățate la laborator, precum lucrul cu GPIO, SPI, I2C, EEPROM, întreruperi și multe altele. :D
 ===== Descriere generală =====
-În jocul nostru, vom avea nevoie de joystick pentru rotirea pieselor. Atunci când se va face un rând, se va adăuga un punctaj la scorul total afișat pe display. De asemenea, atunci când jocul se va termina, matricea LED va emite un semnal luminos și buzzerul va emite un sunet pentru a semnala finalizarea jocului.
+Jocul funcționează astfel:
+  * La **pornire**, se afișează o **animație** cu TETRIS pe matricea de LED-uri și un mesaj pe display.
+  * La fiecare **începere a jocului**, începe să cânte **melodia Tetris** și se deplasează în jos la un interval de câteva secunde **piesa de Tetris** aleasă random. Pe display afișăm **scorul**.
+  * Putem muta Joystick-ul în stânga/dreapta pentru **mutarea piesei** și în sus pentru **rotirea** ei. Mutăm Joystick-ul în jos ca să forțăm piesa să se ducă direct jos (**force down**), fără a mai aștepta ca să se deplaseze câte un rând la un anumit interval.
+  * În **momentul în care se creează o linie**, se mărește scorul. Linia dispare din joc, toate piesele deasupra ei se deplasează în jos. Melodia curentă se întrerupe și buzzer-ul **emite un sunet** ce semnalează noul scor. **Scorul se actualizează** pe display.
+  * Dacă ajungem cu vreo piesă pe rândul de sus al matricii de LED-uri, jocul se încheie. Melodia se oprește și se afișează '**Game Over**'.
+  * În orice punct al jocului, chiar și după 'Game Over', putem **ține apăsat pe butonul de switch** al Joystick-ului timp de 3 secunde pentru a da **restart**. După acest interval, matricea de LED-uri va avea toate LED-urile aprinse, se va afișa pe display 'Restarting Game...', iar după 5 secunde jocul va reîncepe și melodia va începe să cânte de la capăt.
-**Schema bloc** este următoarea: \\ \\ {{:pm:prj2024:fgul:schema_bloc_andra_vlad.png?400|}}
+Pentru înțelegerea interacțiunii dintre joc și jucător, am realizat o schemă simplificată. **Schema bloc** este următoarea: \\ \\ {{:pm:prj2024:fgul:schema_bloc_andra_vlad.png?400|}}
 ===== Hardware Design =====
@@ Line 17: / Line 24: @@
 Piese utilizate:
   * Arduino MEGA 2560
-  * Modul cu Matrice LED MAX7219 (versiunea SMD) - matrice de LED-uri 8x8
+  * Modul cu Matrice LED MAX7219 - matrice de LED-uri 8x8
   * LCD 2004 cu Backlight Albastru și Interfață I2C
   * Modul Joystick Biaxal
@@ Line 25: / Line 32: @@
 Modulul de comunicație **MAX7219** mi s-a părut interesant, deoarece acesta folosește protocolul SPI pentru comenzi ca și MOSI, fără MISO. Acesta facilitează controlul unei matrice de LED-uri folosind un număr mic de pini. Interesanți sunt pinii DIN și CS:
   * **DIN** = Data In, transmite date în mod serial (câte 1 bit) către MAX7219, comenzi precum ce LED-uri să aprindă.
-  * **CS** = Chip Select, însă nu funcționează chiar ca Slave Select-ul cu care eram obișnuiți. Pinul este folosit să marcheze când ar trebui începute citirea datelor. Este setat la 0 ca să fie începută sesiunea de comunicare (să accepte date pe DIN) și la 1 ca să se încheie comunicarea. Pinul **DOUT** al modulului este folosit dacă dorim să conectăm mai multe matrice de LED-uri între ele.
+  * **CS** = Chip Select, însă nu funcționează chiar ca Slave Select-ul cu care eram obișnuiți. Pinul este folosit să marcheze când ar trebui începute citirea datelor. Este setat la 0 ca să fie începută sesiunea de comunicare (să accepte date pe DIN) și la 1 ca să se încheie comunicarea.
+Pinul **DOUT** al modulului este folosit doar dacă dorim să conectăm mai multe matrice de LED-uri între ele.
 </note>
-**Schema electrică** este următoarea: \\ \\
+Pentru a vedea cum conectez pinii analogici și digitali am ales să realizez schematicul în **Fusion**. Majoritatea simbolurilor și footprint-urilor sunt făcute de mine, însă am plecat la câteva piese de la unele deja existente [[pm:prj2024:fgul:andra.vlad#Bibliografie/Resurse|[0]]]. **Schema electrică** este următoarea: \\ \\
-{{:pm:prj2024:fgul:schema_electrica_andra_vlad.png?800|}}
+{{:pm:prj2024:fgul:andra_vlad_schematic_corect_2.png?800|}}
-În stadiul curent al proiectului, am conectat printr-un breadboard și testat toate componentele pentru a mă asigura că funcționează corespunzător. Cu toate acestea, am considerat că ar fi mai potrivit însă pentru un joc să conectez piesele pe o bucată de plexiglas, pentru a avea tot ce am nevoie într-un mod accesibil pentru utilizator. A fost necesar să îmi mai comand anumite piese și mai multe fire, motiv pentru care nu am hardware-ul încă asamblat, așadar pozele urmează să fie atașate ulterior. De asemenea, plănuiesc să conectez proiectul la o baterie.
+Inițial, am conectat și testat toate componentele pentru a mă asigura că funcționează corespunzător. Am considerat că ar fi mai potrivit pentru un joc să conectez piesele pe o bucată de plexiglas, pentru a avea tot ce am nevoie într-un mod accesibil pentru utilizator. De asemenea, plănuiesc să conectez proiectul la o baterie, pentru a putea fi ținut în mână de jucător. Pentru a testa faptul că funcționează componentele, am folosit următoarele resurse: [[pm:prj2024:fgul:andra.vlad#Bibliografie/Resurse|[1], [2], [3]]]. Am folosit bibliotecile LiquidCrystal_I2c și LedControl, însă voi detalia mai mult despre acestea la partea de software.
+{{:pm:prj2024:fgul:pozica_hardware_andra_vlad.jpeg?500|}}
 \\
-Pentru a testa faptul că funcționează componentele, am folosit următoarele resurse: [0], [1], [2]. Am folosit bibliotecile LiquidCrystal_I2c și LedControl, însă voi detalia mai mult despre acestea la partea de software.
 ===== Software Design =====
+==== Logica jocului ====
+Mediul de dezvoltare al proiectului este **PlatformIO**. \\
+Stadiul jocului de pe matricea de LED-uri 8x8 este reprezentat de o matrice 12x8 în cod. Motivul pentru care mai avem câteva linii în plus este pentru că o piesă 'cade' progresiv în joc, nu apare din start pe matricea de LED-uri. Matricea conține valori de 0, 1, 2 și 3:
+  * **0** = **nu am nicio piesă plasată** în joc, LED-ul nu este aprins.
+  * **1** = parte din **piesa curentă**, care se mișcă treptat în jos. LED-ul este aprins.
+  * **2** = **centrul piesei curente** (pivot), marcat ca să știm cum să rotim piesa. LED-ul este aprins.
+  * **3** = parte din **piesele deja plasate** în joc. LED-ul este aprins.
+Pentru înțelegerea jocului, am realizat un schelet cu mai puține detalii, pe care îl voi aprofunda în următoarele secțiuni.
+<code c>
+void loop() {
+    // Daca butonul de SWITCH de pe JoyStick e apasat de mai mult de 3 secunde, resetam jocul.
+    if (restartGame) {
+        // Aprinde LED-urile, reseteaza variabilele...
+        delay(5000);
+        // Restart game
+    }
+    if (!gameOver) {
+        if (intervalJoystick) {
+            // ... Citim input-urile de la Joystick ...
+            if (X_val < CENTRU - 200) {
+                moveLeft();
+            } else if (X_val > CENTRU + 200) {
+                moveRight();
+            } else if (Y_val < CENTRU - 200) {
+                rotateLeft();
+            } else if (Y_val > 840) {
+                forceTetrominoDown();
+                selectRandomTetromino();
+            }
+        }
+        // Daca a trecut un anumit interval de timp, se actualizeaza jocul.
+        if (intervalUpdate) {
+            // Daca ajugem jos, adaugam scor si trecem la o piesa noua.
+            if (pieceSettled) {
+                int score = addScore();
+                selectRandomTetromino();
+            }
+            // Altfel, mutam piesa in jos.
+            else {
+                moveDown();
+            }
+        }
+    }
+    else {
+        // Opreste melodia, afiseaza 'Game Over', reseteaza variabilele...
+    }
+}
+</code>
-<note tip>
+==== Interacțiunea joc-jucător ====
-Descrierea codului aplicaţiei (firmware):
+  * Pentru a genera piese random, am folosit un pin analog pentru a genera un seed astfel încât jucătorul să nu primească aceleași piese la fiecare joc. Am adăugat și un calcul de **probabilități astfel încât șansele de a primi aceeași piesă** de Tetris de 2-3 ori la rând să fie **reduse**, considerând ca matricea noastră de LED-uri este mică și sunt totuși puține piese ce pot fi generate.
-  * mediu de dezvoltare (if any) (e.g. AVR Studio, CodeVisionAVR)
+<code c>
-  * librării şi surse 3rd-party (e.g. Procyon AVRlib)
+const int SEED_PIN = A2;
-  * algoritmi şi structuri pe care plănuiţi să le implementaţi
-  * (etapa 3) surse şi funcţii implementate
-</note>
-===== Rezultate Obţinute =====
+void setup() {
+    randomSeed(analogRead(SEED_PIN) + micros());
+}
-<note tip>
+void selectRandomTetromino() {
-Care au fost rezultatele obţinute în urma realizării proiectului vostru.
+    int probabilitate[5] = {100, 100, 100, 100, 100};
-</note>
+    if (pieceId != -1) {
+    // Reducem probabilitatea unei piese de a aparea de doua ori
+        probabilitate[pieceId] = max(probabilitate[pieceId] - 50, 0);
+    }
+    // Daca apare o piesa de 2 ori, ii scadem din nou probabilitatea de a aparea.
+    if (freqPiece >= 2) {
+        probabilitate[pieceId] = max(probabilitate[pieceId] - 30, 0);
+    }
-===== Concluzii =====
+    // .... Calcul probabilitati dupa intervale pe baza greutatilor ...
+    int randomPiece = selectedPiece;
+    if (pieceId != randomPiece) {
+        freqPiece = 0;
+    }
+    else {
+        freqPiece++;
+    }
+    pieceId = randomPiece;
+}
+</code>
-===== Download =====
+  * A fost nevoie de calibrarea senzorilor Joystick-ului și adăugarea unor intervale astfel încât interacțiunea cu jucătorul să fie una funcțională. Pe lângă un **threshold** de 200 al axelor, am adăugat verificări suplimentare astfel încât jucătorul să nu poată da force down decât după intervale mai mari de timp și să nu poată roti/da force down până când piesa nu este vizibilă.
-<note warning>
+==== Biblioteci Arduino ====
-O arhivă (sau mai multe dacă este cazul) cu fişierele obţinute în urma realizării proiectului: surse, scheme, etc. Un fişier README, un ChangeLog, un script de compilare şi copiere automată pe uC crează întotdeauna o impresie bună ;-).
+Pentru implementarea codului, am folosit următoarele biblioteci și resurse:
+  * [[https://www.arduino.cc/reference/en/libraries/liquidcrystal-i2c/|LiquidCrystal_I2C]] pentru setarea display-ului și afișarea textelor. Display-ul meu comunică prin I2C printr-un modul de comunicație care a venit direct conectat la acesta. Pentru a înțelege cum funcționează I2C, am folosit cunoștințele din [[https://ocw.cs.pub.ro/courses/pm/lab/lab6-2023-2024|laboratorul 6]]. Am folosit codul de la [[pm:prj2024:fgul:andra.vlad#Bibliografie/Resurse|[2]]] pentru a determina adresa I2C a modulului.
+<code c>
+// Argumente: adresa I2C a modulului LCD, numărul de coloane și numărul de rânduri al LCD-ului.
+LiquidCrystal_I2C lcd = LiquidCrystal_I2C(0x27, 20, 4);
-Fişierele se încarcă pe wiki folosind facilitatea **Add Images or other files**. Namespace-ul în care se încarcă fişierele este de tipul **:pm:prj20??:c?** sau **:pm:prj20??:c?:nume_student** (dacă este cazul). **Exemplu:** Dumitru Alin, 331CC -> **:pm:prj2009:cc:dumitru_alin**.
+lcd.init();
-</note>
+lcd.backlight();
+lcd.clear();
+// setCursor = setează linia și coloana cursorului.
+lcd.setCursor(0, 0);
+lcd.print("Tetris Game");
+lcd.setCursor(0, 1);
+lcd.print("is Starting...");
+</code>
+   * [[https://www.arduino.cc/reference/en/libraries/ledcontrol/|LedControl]] pentru folosirea matricei de LED-uri cu ajutorul modulului MAX7219. Modulul folosește SPI, despre care am învățat în [[https://ocw.cs.pub.ro/courses/pm/lab/lab5-2023-2024|laboratorul 5]] și am detaliat despre funcționalitățile acestuia în partea de hardware.
+<code c>
+// Pini folosiți de comunicarea SPI și numărul de module MAX7219.
+LedControl lc = LedControl(DATA_IN_PIN, CLK_PIN, LOAD_PIN, NUM_MAX7219);
+lc.shutdown(0, false);
+lc.setIntensity(0, 1);
+lc.clearDisplay(0);
+for (int i = 0; i < 8; i++) {
+    for (int j = 0; j < 8; j++) {
+        lc.setLed(0, i, j, gameGrid[i + 4][j] != 0);
+    }
+}
+</code>
+  * [[https://www.arduino.cc/reference/en/libraries/timerone/|TimerOne]] pentru folosirea întreruperilor. Am avut nevoie de întreruperi pentru a putea avea jocul și melodia simultan. Pentru întreruperi, am folosit cunoștințele din [[https://ocw.cs.pub.ro/courses/pm/lab/lab2-2023|laboratorul 2]].
+<code c>
+void setup() {
+    Timer1.initialize(100000); // Initializam timerul cu 1 secunda.
+    Timer1.attachInterrupt(urmatoareaNotaCantecel);
+}
+void loop() {
+ // .... Restul jocului ...
+  int switch_state = digitalRead(SW_pin);
+  if (switch_state == LOW) {
+    if (buttonPressTime == 0) {
+            buttonPressTime = millis();
+        }
+    // Daca butonul e apasat timp de 3 secunde, restartam jocul.
+    else if (millis() - buttonPressTime >= 3000) {
+        restartGame();
+        buttonPressTime = 0;
+    }
+  }
+ // ....
+}
+void restartGame() {
+  Timer1.stop();
+  // ... Resetare variabile ...
+  gameOver = false;
+  playSong = true;
+  currentNote = 0;
+  Timer1.start();
+}
+</code>
+  * [[https://github.com/MajicDesigns/MD_Parola|MD_Parola]] pentru folosirea animațiilor de LED-uri pentru MAX7219. Aceasta folosește de asemenea bibliotecile SPI.h și MD_MAX72xx.h. Pentru utilizare, am folosit urmatorul clip: [[pm:prj2024:fgul:andra.vlad#Bibliografie/Resurse|[4]]].
+<code c>
+MD_Parola lc_animatie = MD_Parola(HARDWARE_TYPE, DATA_IN_PIN, CLK_PIN, LOAD_PIN, NUM_MAX7219);
+void setup() {
+    lc_animatie.begin();
+    // Setam brightness-ul.
+    lc_animatie.setIntensity(0);
+    // Aliniem textul la centru, cu speed time 100 si pause time 1000, cu animatia de scroll left.
+    lc_animatie.displayText("TETRIS", PA_CENTER, 100, 1000, PA_SCROLL_LEFT, PA_SCROLL_LEFT);
+    while (!lc_animatie.displayAnimate()) {
+        // Asteptam sa se termine animatia.
+    }
+}
+</code>
+  * [[https://docs.arduino.cc/learn/built-in-libraries/eeprom/|EEPROM]] este biblioteca folosită pentru a scrie în memoria plăcuței și a stoca datele chiar după ce aceasta a fost închisă. ATMega2560 are 4KB de memorie EEPROM și am învățat cum să o folosim în [[https://ocw.cs.pub.ro/courses/pm/lab/lab0-2023|laboratorul 0]]. Eu o folosesc pentru a reține highscore-ul.
+<code c>
+int address1 = 0;
+void setup() {
+    // Extragem valoarea highscore-ului din jocuri anterioare din memoria EEPROM.
+    EEPROM.get(address1, retrievedValue1);
+}
+int addScore() {
+    // ...
+    if (new_score > highscore) {
+        highscore = new_score;
+        EEPROM.put(address1, highscore);
+    }
+    return new_score;
+}
+</code>
+  * Pentru **cântecul de Tetris**, am folosit următorul cod de pe GitHub: [[pm:prj2024:fgul:andra.vlad#Bibliografie/Resurse|[5]]].
+===== Optimizări ====
+  * Pentru a nu consuma bateria, după finalizarea jocului LED-urile și LCD-ul se închid, însă dacă activăm opțiunea de Restart ele se vor reaprinde și jocul va reveni la normal.
+  * Pentru a nu a actualiza continuu LCD-ul în fiecare loop, avem variabila **displayGameOver** care se asigură că mesajul este afișat doar prima oară când intrăm în buclă cu Game Over, dar și **lastScore** și **currentScore** care se asigură că actualizăm scorul pe display doar atunci când scorul diferă între loop-uri.
+  * Reducerea apelurilor multiple la **millis()**
+  * Modularizarea codului în funcții ce au funcționalități repetate în verificările noastre pentru mutarea Tetromino-urilor.
+===== Rezultate Obţinute =====
+<html>
+<iframe width="560" height="315" src="https://www.youtube.com/embed/XZkV4incpBM" title="demo tetris" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" referrerpolicy="strict-origin-when-cross-origin" allowfullscreen></iframe>
+</html>
+===== Concluzii =====
+Deși nu a fost unul foarte complex din punct de vedere al implementării hardware, consider că proiectul m-a ajutat, deoarece am reușit să interacționez cu multe dintre cunoștințele despre care am învățat la laborator și acum știu să lucrez cu ele atât la nivel de regiștri, cât și la nivelul bibliotecilor disponibile pentru lucrul cu Arduino. Mi-aș fi dorit să implementez proiectul pentru mai multe matrice de LED-uri legate între ele, deoarece nu mi-am dat seama la început că e un spațiu atât de mic pentru Tetris. Cu toate acestea, consider că a ieșit bine și mă bucur că am realizat acest proiect și că acum am o jucărie nouă. ^_^
+===== Download =====
+{{:pm:prj2024:fgul:proiect_pm_andra_vlad.zip|}} \\
+{{:pm:prj2024:fgul:schematic_pm_andra_vlad.zip|}}
 ===== Jurnal =====
@@ Line 65: / Line 247: @@
 .04.2024 - descrierea proiectului \\
 .05.2024 - adăugarea schemei bloc și a componentelor hardware \\
-.05.2024 - începere realizare hardware
+.05.2024 - începere realizare hardware \\
-.05.2024 - realizarea schemei electrice și descrierea stadiului hardware
+.05.2024 - realizarea schemei electrice și descrierea stadiului hardware \\
+.05.2024 - corectare schematic și adăugare updates hardware \\
+.05.2024 - adăugare implementare software \\
+.05.2024 - finalizare implementare software și adăugarea fișierelor \\
+.05.2024 - adăugare demo \\
 ===== Bibliografie/Resurse =====
-<note>
+[0] Simbol și footprint MAX7219: https://www.snapeda.com/parts/MAX7219/Analog%20Devices/view-part/ \\
-[0] Interfacing Buzzer to Arduino: https://www.instructables.com/Interfacing-Buzzer-to-Arduino/ \\
+[1] Interfacing Buzzer to Arduino: https://www.instructables.com/Interfacing-Buzzer-to-Arduino/ \\
-[1] Arduino - LCD I2C: https://arduinogetstarted.com/tutorials/arduino-lcd-i2c \\
+[2] Arduino - LCD I2C: https://arduinogetstarted.com/tutorials/arduino-lcd-i2c \\
-[2] How to control 8x8 dot Matrix with MAX7219 and Arduino: https://youtu.be/SGjQ-E3UD7A
+[3] How to control 8x8 dot Matrix with MAX7219 and Arduino: https://youtu.be/SGjQ-E3UD7A \\
-</note>
+[4] MD Parola library for the Max7219 & Arduino: https://www.youtube.com/watch?v=_H2v8uDgqps \\
+[5] Tetris Song On Arduino: https://github.com/robsoncouto/arduino-songs/blob/master/tetris/tetris.ino
 <html><a class="media mediafile mf_pdf" href="?do=export_pdf">Export to PDF</a></html>

Administrativ

Cursuri CA

Laborator

Proiecte

Resurse

Tutoriale

Cablaje

Galerie Foto

Tutoriale Galileo

pm/prj2024/fgul/andra.vlad.1715807143.txt.gz · Last modified: 2024/05/16 00:05 by andra.vlad

Show page Old revisions

Media Manager Back to top