Nistor Andreea Iuliana 333CB

Proiectul constă în implementarea jocului Snake pe un LCD. Am vrut sa fie cât mai aproape de jocul original, astfel că am ales să păstrez controlul șarpelui din 4 butoane pentru stânga, dreapta, sus si jos. Scopul jocului este ca șarpele să crească cât mai mare fără să atingă marginile sau pe el, consumând hrana care apare random pe ecran.

De asemenea, atunci când player-ul pierde, i se da posibilitatea să își scrie numele pentru a-l trece intr-o listă de highscores. Un al cincelea buton este folosit pentru a schimba state-urile curente ale jocului (main page → game play → game over → check highscore & set name → highscores → main page).

Scopul proiectului este implementarea unui joc clasic lansat în 1976 pentru însușirea cunoștințelor dobândite la cursul de Proiectarea cu Microprocesoare.

Modul de funcționare este simplu: jucătorul va controla din cele 4 butoane și va putea urmări pe LCD mișcările șarpelui și apariția random a hranei.

• Arduino Uno
• breadboard
• LCD 16×2
• 4 butoane
• potențiometru
• led RGB

Mediul de dezvoltare folosit este Arduino IDE, schema bloc a fost realizata in Lucidchart, iar schema electrica in EAGLE. De asemenea am folosit librăriile LiquidCrystal.h pentru LCD si EEPROM.h pentru memoria EEPROM.

Definire pini și macro-uri:

• const int rs = 12, en = 11, d4 = 5, d5 = 4, d6 = 10, d7 = 2 → pentru LCD LiquidCrystal lcd(rs, en, d4, d5, d6, d7);
• #define redPin A3, greenPin A4, bluePin A5 → pini pentru Led-ul RGB
• #define BUTTON_GameState 3, BUTTON_UP 9, BUTTON_DOWN 8, BUTTON_RIGHT 7, BUTTON_LEFT 6 → pini pentru butoane
• #define GRAPHIC_WIDTH 16, GRAPHIC_HEIGHT 4, DEBOUNCE_DURATION 25 →variable pentru dimensiunea interfeței jocului și a duratei de debounce

Variabile globale:

• enum DisplayItem {GRAPHIC_ITEM_NONE, GRAPHIC_ITEM_A, GRAPHIC_ITEM_B, GRAPHIC_ITEM_NUM};
• enum {GAME_MENU, GAME_PLAY, GAME_LOSE, GAME_WIN, GAME_SCORES,GAME_NAMESCORE} gameState;
• enum {SNAKE_LEFT,SNAKE_UP,SNAKE_RIGHT,SNAKE_DOWN} snakeDirection; → definire stări joc/snake și setare grafică a interfeței / RAM-ului jocului

• byte block[3] = {B01110, B11111, B01110,} → corp snake
• byte apple[3] = {B00100, B01110, B00100,} → corp apple

• volatile bool Interrupt → verifică dacă a avut loc o întrerupere
• bool pressed → verifică dacă un buton a fost apăsat
• const int max_dimension = GRAPHIC_HEIGHT*GRAPHIC_WIDTH → dimensiunea maximă posibilă
• size_t snakeLength = 0 → inițializare variabilă care o să salveze dimensiunea snake-ului

• int a[4] → folosit pentru a salva highscore-urile in EEPROM
• hue → folosită pentru setarea culorii led-ului RGB

• String Name1thPlace,Name2thPlace,Name3thPlace,Name4thPlace → salvăm în ordine numele care au obținut highscore
• const char chars[] = {'A','B','C','D','E','F','G','H','I','J','K','L','M','N','O','P','Q','R','S','T','U','V','W','X','Y','Z'} → salvăm literele pentru setarea numelui în caz de highscore
• char setName[3] → o variabilă temporară în care salvam valorile anterioare ale numelor

• struct Pos {uint8_t x=0, y=0;};
• struct Pos applePos;
• struct Pos snakePosHistory[max_dimension] → poziții initiale snake/apple

• unsigned long lastGameUpdateTick = 0 → salvează progresiv timpul ultimului frame al jocului
• unsigned long gameUpdateInterval = 850 → rata de refesh a jocului
• uint8_t graphicRam[GRAPHIC_WIDTH*2/8][GRAPHIC_HEIGHT] → definire dimensiune RAM

• void BtnInterrupt() → functia de intrerupere a butonului BUTTON_GameState
• bool debounce_activate_edge(unsigned long* debounceStart), void debounce_deactivate(unsigned long* debounceStart) → functii care stabilesc si verifica ca valoarea logica a unui buton este cea corespunzatoare (atat dupa apasarea lui, cat si daca ar aprea efecte mecanice/zgomot).

• void graphic_flush(), void graphic_generate_characters(), void graphic_clear(), void graphic_add_item(uint8_t x, uint8_t y, enum DisplayItem item) → functii care genereaza RAM-ul jocului si prin care jocul, chiar daca e pe un lcd 16×2 este jucat pe 4 linii. De asemenea, sunt definite si generate modelele snake-ului si ale marului

• void setLedColorHSV(int h, double s, double v)
• void setLedColor(int redValue, int greenValue, int blueValue) → functile date la laborator pentru a seta culoarea rgb-ului mai usor.
• void game_new_apple_pos() → genereaza o pozitie random pentru mar. De asemenea, verifica sa nu genereze un mar unde se afla snake-ul
• void game_calculate_logic() → calculeaza miscarea si directia snake-ului, verifica daca s-a produs o coloziune (perete / self) si mareste rata de refresh a jocului daca snake-ul a mancat un mar (pana la un maxim al scorului de 20)

• void game_calculate_display() → schimba Game State-ul curent a jocului daca s-a intamplat un eveniment (de exemplu: jucatorul a pierdut sau a castigat)
• void Game_INIT() → starea initiala a jocului (cea initializata in setup)
• void Game_LOSE() → starea atunci cand jucatorul pierde
• void Game_MAIN() → starea in care este prezentat ecranul de inceput
• void Game_WIN() → starea atunci cand jucatorul castiga
• void Game_PLAY() → stare care genereaza snake-ul si marul la inceputul
• void Game_CHECKHIGHSCORES() → verifica daca jucatorul curent a obtinut un scor mai mare decat cei salvati in memorie EEPROM
• void Game_HIGHSCORES() → afiseaza cei mai buni 4 jucatori cu cele mai mari score-uri si schimba in memorie top-ul in caz ca alt jucator a obtinut un highscore mai bun

• void Test_SnakeLength() → functie care pune in 0 in fata scorului in caz ca acesta este mai mic decat 9 (pur estetic)
• void rgb_color() → seteaza culoarea Led-ului RGB in functie de cat de mare e scor-ul (verde → albastru → turcoaz → roz → portocaliu)
• void writeStringToEEPROM(int addrOffset, const String &strToWrite) → permite scrierea in memoriea EEPROM
• String readStringFromEEPROM(int addrOffset) → permite citirea din memoriea EEPROM

setup()

void setup(){
  pinMode(redPin,OUTPUT);
  pinMode(greenPin,OUTPUT);
  pinMode(bluePin,OUTPUT);
  pinMode(BUTTON_GameState, INPUT_PULLUP);
  pinMode(BUTTON_UP, INPUT_PULLUP);
  pinMode(BUTTON_RIGHT, INPUT_PULLUP);
  pinMode(BUTTON_LEFT, INPUT_PULLUP);
  pinMode(BUTTON_DOWN, INPUT_PULLUP);
  attachInterrupt(digitalPinToInterrupt(BUTTON_GameState), BtnInterrupt, FALLING); 
  graphic_generate_characters();
  Game_MAIN();
  gameState = GAME_MENU;
}

Definim pinii pentru Led-ul RGB ca OUTPUT (low-impedance state) astfel permintand sa treaca curent prin ei. Definim pinii pentru butoane ca INPUT_PULLUP folositi sa steze o valoare fixa pentru un pin, in cazul nostru daca butonul este apasat acesta o sa fie activ pe 0. Definim o intrerupe pentru butonul BUTTON_GameState aflat pe pinul 3 atunci cand el este apasat De asemenea, se genereaza in avans caracterele jocului si se apeleaza functia pentru interfata initiala a jocului.

loop()

if(Interrupt){ → verifica daca a aparut o intrerupere

       delay(5*DEBOUNCE_DURATION); -> un delay cu rol de debounce 
       switch(gameState){...} -> schimba starea curenta a jocului prematur la apasarea butonului GameState
 Interrupt = false;} ->resteaza valoarea setata in intrerupere pana la urmatoarea intrerupere

if(digitalRead(BUTTON_UP) == pressed){ -> verifica daca butonul respectiv a fost apelat
    if(debounce_activate_edge(&debCountBUTTON_UP)){ ->verifica debounce-ul
      snakeDirection=SNAKE_UP; -schimba directia snake-ului
    }
}else{
    debounce_deactivate(&debCountBUTTON_UP); -> in caz butonul nu a fost apasat, reseteaza timer-ul de debounce
}

Acelasi tipar de verificare este apelat pentru restul butoanelor care definesc miscarea snake-ului

if(millis()-lastGameUpdateTick>gameUpdateInterval){

  game_calculate_logic();
  game_calculate_display();
  graphic_clear();
  rgb_color();
  lastGameUpdateTick = millis();
} -> verifica constant daca jocul trebuie sa-si dea refresh sa recalculeze starea jocului, culoarea led-ului,
     dimensiunea + pozitia snake-ului si a marului

Demo youtube: https://www.youtube.com/watch?v=DwJfF1_lE9Y

Simpla idee că aș putea realiza un joc singură m-a motivat să duc până la capăt acest proiect. Consider că a fost un mod captivant prin care am aplicat cunoștințe dobândite în cadrul cursului de PM.

snake_nistorandreeaiuliana.zip

https://www.arduino.cc/en/Tutorial/BuiltInExamples/Debounce

https://www.arduino.cc/reference/en/language/functions/external-interrupts/attachinterrupt

https://ww1.microchip.com/downloads/en/DeviceDoc/Atmel-7810-Automotive-Microcontrollers-ATmega328P_Datasheet.pdf

Export to PDF