Add breadboard

08-74HC595-Snake/.gdbinit

@@ -1,21 +0,0 @@
-# 1. Connect to the running OpenOCD server
-target remote :3333
-
-# 2. Configure GDB for Espressif-specific environments
-set remote hardware-watchpoint-limit 2
-set remote hardware-breakpoint-limit 2
-set mem inaccessible-by-default off
-
-# 3. Handle FreeRTOS multi-threading without crashing GDB
-handle SIGTRAP noprint nostop pass
-
-# 4. Define a custom macro to safely reset the ESP32-S3
-define reset
-    monitor reset halt
-    flushregs
-end
-
-# 5. Execute a fresh reset and set initial breakpoint
-reset
-thbreak setup
-continue

08-74HC595-Snake/08-74HC595-Snake.ino

@@ -1,74 +1,380 @@
 #include <Arduino.h>
+
 #include "controls.h"
 #include "error.h"
-
-/*
-Need 11 GPIO pins
-  - 74HC95 for the 8 segment
-	- 74HC595 for the rows of the 8x8
-	- 74HC9 for the cols of the 8x8
-	- 1x for the Joystick button
-	- 1x for the buzzer
-Need 3 ADC pins
-  - Joy X
-	- Joy Y
-	- Difficulty potentiometer
-*/
-
-// Pins 1 and 2 are on ADC channel 0 and 1.
-#define PIN_JOY_X            1
-#define PIN_JOY_Y            2
-// Pin 47 is GPIO only
-#define PIN_JOY_Z            47
-
-// We save 4 pins by updating all 3 shift registers at once
-// with one clock and one update signal. Each shift register
-// only needs its own data line.
-#define PIN_74HC595_CLOCK          11
-#define PIN_74HC595_UPDATE         12
-
-#define PIN_74HC595_LEDROWS_DATA              18
-#define PIN_74HC595_LEDCOLS_DATA              13
-#define PIN_74HC595_SCOREBOARD_DATA           14
+#include "IC74HC595.h"
+#include "7Segment.h"
+#include "matrix.h"
 
 #define PIN_BUZZER                 21
 
-#define PIN_DIFFICULTY             9
-
 #define PWM_FREQUENCY         1000
 #define PWM_BITWIDTH          12
+#define PWM_BUZZER_CHANNEL    0
 
-Joystick js;
+#define ENTITY_ALIVE          1 << 0
+#define ENTITY_FOOD           1 << 1
+#define ENTITY_SNAKE          1 << 2
+
+#define ENTITY_HIGH_MASK       248     // 11111000
+#define ENTITY_LOW_MASK        7       // 00000111
+
+#define ENTITY_SHIFT_LIFETIME  3
+
+int8_t player_x;
+int8_t player_y;
+int8_t delta_x;
+int8_t delta_y;
+
+// Entities represent a lit pixel on the LED matrix. Each entity is an 8 bit mask that consists of:
+//
+// 8             0
+// 0 0 0 0 0 0 0 0
+// ^       ^ ^ ^ ^
+// |       | | | `-- Alive or dead. When 1, display this entity.
+// |       | | `---- Food (1)
+// |       | `------ Snake (1)
+// |       |
+// `-------+-------- Lifetime. How many game cycles should this entity remain for? 0-248.
+//                   The lifetime gets counted down each cycle!
+
+#define GAMESTATE_SCREENCAL      1
+#define GAMESTATE_PLAY           2
+#define GAMESTATE_LOSE           3
+#define GAMESTATE_WIN            4
+
+uint8_t entities[64] = {0};
+int found_food = 0;
+int8_t tail_length = 2;
+uint32_t gamespeed;
+uint32_t lastupdate;
+uint32_t difficulty = 0;
+uint8_t pad1 = 0;
+uint8_t score = 0;
+uint8_t pad2 = 0;
+uint8_t open_indexes[64] = {0};
+
+Button btn_left = {PIN_BUTTON_LEFT, 0, LOW, BUTTON_STABLETIME, 0};
+Button btn_up = {PIN_BUTTON_UP, 0, LOW, BUTTON_STABLETIME, 0};
+Button btn_down = {PIN_BUTTON_DOWN, 0, LOW, BUTTON_STABLETIME, 0};
+Button btn_right = {PIN_BUTTON_RIGHT, 0, LOW, BUTTON_STABLETIME, 0};
+
+uint8_t gamestate = 0;
 
 void initSerial()
 {
 	Serial.begin(115200);
+	Serial.printf("\nSERIAL READY\n");
+}
+
+void initBuzzer() {
+  ledcAttachChannel(PIN_BUZZER, 1000, 10, PWM_BUZZER_CHANNEL);
+  ledcWriteTone(PIN_BUZZER, 2000);
+	delay(1000);
+	ledcWriteTone(PIN_BUZZER, 0);
+}
+
+void move_player()
+{
+	player_x += delta_x;
+	player_y += delta_y;
+	if ( player_x > 7) {
+		player_x = 0;
+	} else if ( player_x < 0 ) {
+		player_x = 7;
+	}
+	if ( player_y > 7 ) {
+		player_y = 0;
+	} else if ( player_y < 0 ) {
+		player_y = 7;
+	}
+}
+
+void collide_player()
+{
+	uint8_t entity;
+	entity = entities[(player_x * 8) + player_y];
+	// Is there an entity where we're going?
+	if ( entity > 0 ) {
+		// We die if we hit our own body
+		if ( (entity & ENTITY_SNAKE) == ENTITY_SNAKE ) {
+			ledcWriteTone(PIN_BUZZER, 2000);
+			delay(1000);
+			ledcWriteTone(PIN_BUZZER, 0);
+			init_game();
+		} else if ( (entity & ENTITY_FOOD) == ENTITY_FOOD ) {
+			found_food = 1;
+			score += 1;
+		}
+	}
+}
+
+void draw_entities()
+{
+	uint8_t entity;
+	resetMatrix();
+	if ( gamestate == GAMESTATE_SCREENCAL ) {
+		for ( int i = 0 ; i < 64 ; i++ ) {			
+			if ( pokeMatrixPixel((i / 8), (i % 8)) != ERRNO_SUCCESS ) {
+				Serial.printf("Failed to poke pixel : %d\n", i, errno);
+				return;
+			}
+		}
+	} else {
+		// Poke matrix pixels for every living entity
+		for ( int i = 0 ; i < 64; i++ ) {
+			entity = entities[i];
+			if ( ( entity & ENTITY_ALIVE ) == ENTITY_ALIVE ) {
+				if ( pokeMatrixPixel((i / 8), (i % 8)) != ERRNO_SUCCESS ) {
+					Serial.printf("Failed to poke pixel for entity %d : %d\n", i, errno);
+					return;
+				}
+			}
+		}
+	}
+	displayMatrix();
+}
+
+void update_matrix_entities()
+{
+	uint8_t entity;
+	int8_t elife = 0;
+	// Poke matrix pixels for every living entity
+	for ( int i = 0 ; i < 64; i++ ) {
+		entity = entities[i];
+		if ( (entity & ENTITY_ALIVE) == ENTITY_ALIVE && i != ((player_x * 8) + player_y) ) {
+			// Snake parts age (except the head)
+			if ( (entity & ENTITY_SNAKE) == ENTITY_SNAKE ) {
+				elife = (entity & ENTITY_HIGH_MASK) >> ENTITY_SHIFT_LIFETIME;
+				if ( found_food == 0 ) {
+					// Count down their lifetime
+					if ( elife == 0 ) {
+						entity = 0;
+					} else {
+						elife -= 1;
+						entity = (elife << ENTITY_SHIFT_LIFETIME) | (entity & ENTITY_LOW_MASK);
+					}
+					entities[i] = entity;
+				} /*else {
+					elife += 1;
+					entity = (elife << ENTITY_SHIFT_LIFETIME) | (entity & ENTITY_LOW_MASK);
+					entities[i] = entity;
+					}*/
+			}
+		}
+	}
+}
+
+void place_random_entity(int8_t eflags, int8_t set_player)
+{
+	uint8_t index = 0;
+	uint8_t entity = 0;
+	uint8_t open_positions = 0;
+
+	memset((void *)&open_indexes, 0x00, 64);
+	
+	// Count how many positions are open on the board
+	for ( int i = 0 ; i < 64; i++ ) {
+		entity = entities[i];
+		if ( entity == 0) {
+			open_indexes[open_positions] = i;
+			open_positions += 1;
+		} else {
+		}
+	}
+	
+	if ( open_positions == 0 ) {
+		// This is a win condition!
+		gamestate = GAMESTATE_WIN;
+		return;
+	}
+	
+	index = random(0, open_positions-1);
+	if ( index > 63 ) {
+		Serial.printf("Index out of bounds!\n");
+		return;
+	}
+	index = open_indexes[index];
+	
+	// Place a random piece of food on the board
+	entities[index] = (eflags);
+
+	if ( set_player == 1 ) {
+		player_x = (index / 8);
+		player_y = (index % 8);
+	}
+}
+
+void init_game()
+{	
+	tail_length = 2;
+	memset((void *)&entities, 0x00, 64);
+	gamespeed = 1000;
+	lastupdate = millis();
+	score = 0;
+	delta_x = 0;
+	delta_y = 0;
+	
+	place_random_entity(ENTITY_HIGH_MASK | ENTITY_ALIVE | ENTITY_FOOD, 0);
+	
+	// Place the player away from the food
+	place_random_entity(((tail_length << ENTITY_SHIFT_LIFETIME) | ENTITY_ALIVE | ENTITY_SNAKE), 1);
+}
+
+void read_controls()
+{
+	difficulty = readDifficulty();
+	if ( readButton(&btn_up) != ERRNO_SUCCESS ||
+			 readButton(&btn_left) != ERRNO_SUCCESS ||
+			 readButton(&btn_right) != ERRNO_SUCCESS ||
+			 readButton(&btn_down) != ERRNO_SUCCESS ) {
+		Serial.printf("Failed to read buttons\n");
+		return;
+	}
+	if ( gamestate == GAMESTATE_SCREENCAL ) {
+		if ( btn_up.state + btn_down.state + btn_left.state + btn_right.state != 0 ) {
+			init_game();
+			gamestate = GAMESTATE_PLAY;
+		}
+	} else {
+		// We don't let the player reverse direction back on themselves.
+		if ( (delta_x == 0) && (btn_up.state & BUTTON_STATE_DOWN) == BUTTON_STATE_DOWN ) {
+			delta_x = 1;
+			delta_y = 0;
+		}
+		if ( (delta_x == 0) && (btn_down.state & BUTTON_STATE_DOWN) == BUTTON_STATE_DOWN ) {
+			delta_x = -1;
+			delta_y = 0;
+		}
+		if ( (delta_y == 0) && (btn_right.state & BUTTON_STATE_DOWN) == BUTTON_STATE_DOWN ) {
+			delta_y = -1;
+			delta_x = 0;
+		}
+		if ( (delta_y == 0) && (btn_left.state & BUTTON_STATE_DOWN) == BUTTON_STATE_DOWN ) {
+			delta_y = 1;
+			delta_x = 0;
+		}
+	}
+}
+
+void display_score()
+{
+	uint8_t integerValues[] = {
+		CHAR_7SEG_0,
+		CHAR_7SEG_1,
+		CHAR_7SEG_2,
+		CHAR_7SEG_3,
+		CHAR_7SEG_4,
+		CHAR_7SEG_5,
+		CHAR_7SEG_6,
+		CHAR_7SEG_7,
+		CHAR_7SEG_8,
+		CHAR_7SEG_9,
+	};
+	uint8_t score_cur = 0;
+	int rc = 0;
+
+	if ( gamestate == GAMESTATE_SCREENCAL ) {
+		select7SegDisplay(PIN_7SEGMENT_DIGIT4);
+		rc = writeIC74HC595Char(&scoreboard, CHAR_7SEG_C, MSBFIRST);
+		rc += writeIC74HC595Char(&scoreboard, CHAR_7SEG_OFF, MSBFIRST);
+		select7SegDisplay(PIN_7SEGMENT_DIGIT3);
+		rc += writeIC74HC595Char(&scoreboard, CHAR_7SEG_A, MSBFIRST);
+		rc += writeIC74HC595Char(&scoreboard, CHAR_7SEG_OFF, MSBFIRST);
+		select7SegDisplay(PIN_7SEGMENT_DIGIT2);
+		rc += writeIC74HC595Char(&scoreboard, CHAR_7SEG_L, MSBFIRST);
+		rc += writeIC74HC595Char(&scoreboard, CHAR_7SEG_OFF, MSBFIRST);
+		if ( rc != ERRNO_SUCCESS ) {
+			Serial.printf("Failed to write scoreboard: %d", errno);
+			return;
+		}
+		return;
+	}
+	
+	if ( difficulty > 0 ) {
+		gamespeed = 1000 / difficulty;
+	} else {
+		gamespeed = 1000;
+	}
+	score_cur = (score % 10);
+	select7SegDisplay(PIN_7SEGMENT_DIGIT1);
+	rc = writeIC74HC595Char(&scoreboard, integerValues[score_cur], MSBFIRST);
+	rc += writeIC74HC595Char(&scoreboard, CHAR_7SEG_OFF, MSBFIRST);
+	if ( rc != ERRNO_SUCCESS ) {
+		Serial.printf("Failed to write scoreboard: %d", errno);
+		return;
+	}	
+
+	score_cur = (score / 10);
+	select7SegDisplay(PIN_7SEGMENT_DIGIT2);
+	rc = writeIC74HC595Char(&scoreboard, integerValues[score_cur], MSBFIRST);
+	rc += writeIC74HC595Char(&scoreboard, CHAR_7SEG_OFF, MSBFIRST);
+	if ( rc != ERRNO_SUCCESS ) {
+		Serial.printf("Failed to write scoreboard: %d", errno);
+		return;
+	}	
+
+	select7SegDisplay(PIN_7SEGMENT_DIGIT4);
+	rc = writeIC74HC595Char(&scoreboard, integerValues[difficulty], MSBFIRST);
+	rc += writeIC74HC595Char(&scoreboard, CHAR_7SEG_OFF, MSBFIRST);
+	if ( rc != ERRNO_SUCCESS ) {
+		Serial.printf("Failed to write scoreboard: %d", errno);
+		return;
+	}
+}
+
+void gamelogic()
+{
+	uint32_t updatetime = millis();
+	found_food = 0;
+	Serial.printf("Score is %d\n", score);
+	if ( (updatetime - lastupdate) > gamespeed ) {
+		lastupdate = updatetime;
+		// Skip all of this if we have no delta (the player isn't playing yet)
+		if ( (delta_x + delta_y) != 0 ) {
+			move_player();
+			collide_player();
+			// Add a snake entity to the new location
+			if ( found_food == 1 ) {
+				tail_length += 1;
+				place_random_entity(ENTITY_HIGH_MASK | ENTITY_ALIVE | ENTITY_FOOD, 0);				
+			}
+			entities[(player_x * 8) + player_y] = ((tail_length << ENTITY_SHIFT_LIFETIME) | ENTITY_ALIVE | ENTITY_SNAKE );
+		}
+		update_matrix_entities();
+		found_food = 0;
+	}
 }
 
 void setup() {	
-	memset(&js, 0x00, sizeof(Joystick));
-
 	initSerial();
-	if ( initJoystick(&js, PIN_JOY_X, PIN_JOY_Y, PIN_JOY_Z) != ERRNO_SUCCESS ) {
-		Serial.printf("Failed to initialized Joystick datastructure : %d\n", errno);
+	score = 0;
+	if ( init74HC595(&matrixcols) != ERRNO_SUCCESS ) {
+		Serial.printf("failed to initialize matrix series 74HC595");
 	}
+	if ( initButton(&btn_up) != ERRNO_SUCCESS ||
+			 initButton(&btn_left) != ERRNO_SUCCESS ||
+			 initButton(&btn_right) != ERRNO_SUCCESS ||
+			 initButton(&btn_down) != ERRNO_SUCCESS ) {
+		Serial.printf("Failed to initialize buttons\n");
 	}
+	if ( init74HC595(&scoreboard) != ERRNO_SUCCESS ) {
+		Serial.printf("Failed to initialize scoreboard 74HC595");
+	}
+	if ( init7Segment() != ERRNO_SUCCESS ) {
+		Serial.printf("Failed to initialize 7 segment display");
+	}
+	initBuzzer();
+	init_game();
+	gamestate = GAMESTATE_SCREENCAL;
 	
+	Serial.printf("\nSETUP READY\n");
+}
 
 void loop() {
-	if ( readButton(&js.button) != ERRNO_SUCCESS ) Serial.printf("Failed to read calibration button : %d\n", errno);
-	if ( js.button.state == BUTTON_STATE_DOWN && js.state != JOYSTICK_STATE_CALIBRATING ) {
-		js.button.state = BUTTON_STATE_HELD;
-	  js.state = JOYSTICK_STATE_CALIBRATING;
-	}
-	if ( js.state == JOYSTICK_STATE_CALIBRATING ) {
-		if ( calibrateJoystick(&js) != ERRNO_SUCCESS ) {
-			Serial.printf("Failed to calibrate joystick : %d\n", errno);
-		}
-	}
-	if ( ( js.state & JOYSTICK_STATE_CALIBRATED) == JOYSTICK_STATE_CALIBRATED ) {
-		if ( readJoystick(&js) != ERRNO_SUCCESS ) {
-			Serial.printf("Failed to read joystick state : %d\n", errno);
-		}
-	}
+	int rc = 0;
+	read_controls();
+	display_score();
+	gamelogic();
+	draw_entities();
 }

08-74HC595-Snake/7Segment.cpp

@@ -0,0 +1,42 @@
+#include <Arduino.h>
+#include "7Segment.h"
+#include "IC74HC595.h"
+#include "error.h"
+
+int init7Segment() {
+    pinMode(PIN_7SEGMENT_DIGIT1, OUTPUT);
+    pinMode(PIN_7SEGMENT_DIGIT2, OUTPUT);
+    pinMode(PIN_7SEGMENT_DIGIT3, OUTPUT);
+    pinMode(PIN_7SEGMENT_DIGIT4, OUTPUT);
+    return ERRNO_SUCCESS;
+}
+
+void test7Segment()
+{
+	uint8_t segments[] = {
+		PIN_7SEGMENT_DIGIT1,
+		PIN_7SEGMENT_DIGIT2,
+		PIN_7SEGMENT_DIGIT3,
+		PIN_7SEGMENT_DIGIT4
+	};
+	for ( int j = 0; j < 4 ; j++ ) {
+		select7SegDisplay(segments[j]);
+		for ( int i = 0 ; i < 8; i++ ) {
+			if ( i > 0 ) {
+				writeIC74HC595Char(&scoreboard, ((uint8_t) ~(SEG_DP | (1 << i))), MSBFIRST);
+			} else {
+				writeIC74HC595Char(&scoreboard, ((uint8_t) ~(SEG_DP | 1)), MSBFIRST);
+			}
+			delay(1000);
+		}
+	}
+}
+int select7SegDisplay(uint8_t pin)
+{
+    digitalWrite(PIN_7SEGMENT_DIGIT1, LOW);
+    digitalWrite(PIN_7SEGMENT_DIGIT2, LOW);
+    digitalWrite(PIN_7SEGMENT_DIGIT3, LOW);
+    digitalWrite(PIN_7SEGMENT_DIGIT4, LOW);
+    digitalWrite(pin, HIGH);
+    return ERRNO_SUCCESS;
+}

08-74HC595-Snake/7Segment.h

@@ -0,0 +1,48 @@
+#ifndef _7SEGMENT_H_
+#define _7SEGMENT_H_
+
+#define SEG_A              1
+#define SEG_B              1 << 1
+#define SEG_C              1 << 2
+#define SEG_D              1 << 3
+#define SEG_E              1 << 4
+#define SEG_F              1 << 5
+#define SEG_G              1 << 6
+#define SEG_DP             1 << 7
+
+// 3, 5, A, F don't properly handle segment D (bottom). Not sure why.
+// Other digits that include the bottom segment (like 2, 0, 8) and that don't include it
+// (like 7, 9, 4) work fine.
+
+#define CHAR_7SEG_0        (uint8_t) ~( SEG_A | SEG_B | SEG_C | SEG_D | SEG_E | SEG_F)
+#define CHAR_7SEG_1        (uint8_t) ~( SEG_B | SEG_C)
+#define CHAR_7SEG_2        (uint8_t) ~( SEG_A | SEG_B | SEG_G | SEG_E | SEG_D)
+#define CHAR_7SEG_3        (uint8_t) ~( SEG_A | SEG_B | SEG_C | SEG_D | SEG_G )
+#define CHAR_7SEG_4        (uint8_t) ~( SEG_F | SEG_G | SEG_B | SEG_C)
+#define CHAR_7SEG_5        (uint8_t) ~( SEG_A | SEG_F | SEG_G | SEG_C | SEG_D)
+#define CHAR_7SEG_6        (uint8_t) ~( SEG_A | SEG_F | SEG_E | SEG_D | SEG_C | SEG_G)
+#define CHAR_7SEG_7        (uint8_t) ~( SEG_A | SEG_B | SEG_C)
+#define CHAR_7SEG_8        (uint8_t) ~( SEG_A | SEG_B | SEG_C | SEG_D | SEG_E | SEG_F | SEG_G)
+#define CHAR_7SEG_9        (uint8_t) ~( SEG_A | SEG_B | SEG_C | SEG_F | SEG_G)
+
+#define CHAR_7SEG_A        (uint8_t) ~( SEG_A | SEG_B | SEG_C | SEG_E | SEG_F | SEG_G)
+#define CHAR_7SEG_B        (uint8_t) ~( SEG_C | SEG_D | SEG_E | SEG_F | SEG_G)
+#define CHAR_7SEG_C        (uint8_t) ~( SEG_A | SEG_D | SEG_E | SEG_F)
+#define CHAR_7SEG_D        (uint8_t) ~( SEG_C | SEG_D | SEG_E | SEG_B | SEG_G)
+#define CHAR_7SEG_E        (uint8_t) ~( SEG_A | SEG_D | SEG_E | SEG_F | SEG_G)
+#define CHAR_7SEG_F        (uint8_t) ~( SEG_A | SEG_E | SEG_F | SEG_G)
+#define CHAR_7SEG_L        (uint8_t) ~( SEG_D | SEG_E | SEG_F)
+#define CHAR_7SEG_DP       (uint8_t) ~SEG_DP
+#define CHAR_7SEG_OFF      0xFF
+
+#define PIN_7SEGMENT_DIGIT1        7
+#define PIN_7SEGMENT_DIGIT2        6
+#define PIN_7SEGMENT_DIGIT3        5
+#define PIN_7SEGMENT_DIGIT4        4
+
+int init7Segment(void);
+void test7Segment(void);
+int select7SegDisplay(uint8_t num);
+
+
+#endif // _7SEGMENT_H_

08-74HC595-Snake/IC74HC595.cpp

@@ -0,0 +1,21 @@
+#include <Arduino.h>
+#include "IC74HC595.h"
+#include "error.h"
+
+IC74HC595 matrixcols = {PIN_74HC595_MATRIX_UPDATE, PIN_74HC595_MATRIX_DATA, PIN_74HC595_MATRIX_CLOCK};
+IC74HC595 scoreboard = {PIN_74HC595_SCOREBOARD_UPDATE, PIN_74HC595_SCOREBOARD_DATA, PIN_74HC595_SCOREBOARD_CLOCK};
+
+int init74HC595(IC74HC595 *sr) {
+    pinMode(sr->updatepin, OUTPUT);
+    pinMode(sr->clockpin, OUTPUT);
+    pinMode(sr->datapin, OUTPUT);
+    return ERRNO_SUCCESS;
+}
+
+int writeIC74HC595Char(IC74HC595 *sr, uint8_t value, uint8_t order)
+{
+    digitalWrite(sr->updatepin, LOW);
+    shiftOut(sr->datapin, sr->clockpin, order, value);
+    digitalWrite(sr->updatepin, HIGH);
+    return ERRNO_SUCCESS;
+}

08-74HC595-Snake/IC74HC595.h

@@ -0,0 +1,28 @@
+#ifndef _IC74HC595_H_
+#define _IC74HC595_H_
+
+// We save 4 pins by updating all 3 shift registers at once
+// with one clock and one update signal. Each shift register
+// only needs its own data line.
+#define PIN_74HC595_SCOREBOARD_CLOCK          11
+#define PIN_74HC595_MATRIX_CLOCK          12
+
+#define PIN_74HC595_MATRIX_UPDATE 8
+#define PIN_74HC595_SCOREBOARD_UPDATE 17
+
+#define PIN_74HC595_MATRIX_DATA              18
+#define PIN_74HC595_SCOREBOARD_DATA           14
+
+typedef struct IC74HC595 {
+    uint8_t updatepin;
+    uint8_t datapin;
+    uint8_t clockpin;
+} IC74HC595;
+
+extern IC74HC595 matrixcols;
+extern IC74HC595 scoreboard;
+
+int init74HC595(IC74HC595 *sr);
+int writeIC74HC595Char(IC74HC595 *sr, uint8_t value, uint8_t order);
+
+#endif // _IC74HC595_H_

08-74HC595-Snake/README.md

@@ -1,19 +1,63 @@
 # Breadboard
 
-This project uses 3 74HC595 serial to parallel shift registers, a 7-segment display multi unit, an 8x8 LED matrix, an active buzzer, an NPN transistor, a joystick, a handful of resistors and a potentiometer to make a playable Snake game.
+![breadboard](breadboard.png)
+
+This project uses 3 74HC595 serial to parallel shift registers, a 7-segment display multi unit, an 8x8 LED matrix, an active buzzer, an NPN transistor, a joystick (later replaced with 4 buttons), a handful of resistors and a potentiometer to make a playable Snake game.
+
+This was easily the most challenging project so far, taking me almost two weeks to get it working right. I wound up having to break the project out across 4 separate breadboards. The breadboards look as gross in real life as it does in Fritzing.
 
 # Lessons Learned
 
+* C has admitted design flaws
+* Hardware debouncing is definitely the way to go
+* The Arduino IDE debugger really sucks
+* It's been a long time since I had to think this hard about what my code was doing to the hardware
 * Compiling, uploading, and debugging Arduino code from the CLI
-* Managing mutexes in Arduino to handle thread locking
-* How to write data to a 74HC595 shift register without using the Arduino HAL
-* How to drive a 7-segment display
-* How to drive an 8x8 LED matrix
+* Breadboards probably introduce just as many bugs as I do
+* How to drive a 7-segment display and an 8x8 LED matrix using shift registers
+* Embedded platforms have undocumented limits that may surprise you
 * You don't need lots of pixels, or even colors, to make it fun
 
+## C design flaw : the binary operators in comparison
+
+If you've followed my blog much at all, you will know that I am of the opinion that, as a programming language, [C is basically perfect. (Fight me)](https://aklabs.net/2026/01/10/libakerror/#There-is-no-problem-C-is-not-broken). But ... it does have quirks. And one of those quirks had me scratching my head from the time I wrote the game logic to the very end.
+
+If you haven't played a snake game before, it is a simple thing. You have a snake, and you have food. The snake moves around the board and eats the food. The food stays on the board until the snake eats it. When the snake eats the food, the snake gets longer. If the snake runs into its own body, the game ends. If the snake gets so big that there is no longer space for food to spawn on the game board, you win.
+
+In my snake game there are two kinds of entities on the game board: snake and food. Entities have a certain lifetime, and when they reach the end of that lifetime, they disapear from the screen. Food, however, is never supposed to disappear. It stays until the snake eats it.
+
+Initially my code was counting down the lifetime on food entities, and I couldn't figure out why. Can you spot the bug?
+
+```arduino
+if ( entity & ENTITY_ALIVE == ENTITY_ALIVE && i != ((player_x * 8) + player_y) ) {
+    // Snake parts age (except the head)
+    if ( entity & ENTITY_SNAKE == ENTITY_SNAKE ) {
+```
+
+The intent is obvious:
+
+- If an entity is alive
+- AND the entity is not the player's current position
+- AND the entity is a snake body part
+- ... Decrement its lifetime
+
+As it turns out, I had fallen victim to a classic blunder without realizing it. The `&` operator has a lower precedence than the `==` operator. So the compiler was actually generating an evaluation that looked like this:
+
+```arduino
+if ( entity && (ENTITY_SNAKE == ENTITY_SNAKE) ) {
+```
+
+... what the hell? That's not what I meant! But according to [The Man Himself](https://www.lysator.liu.se/c/dmr-on-or.html), this is a long standing design flaw in the C language:
+
+> Early C had no separate operators for & and && or | and ||. [...] Instead it used the notion (inherited from B and BCPL) of "truth-value context": where a Boolean value was expected, after "if" and "while" and so forth, the & and | operators were interpreted as && and || are now; in ordinary expressions, the bitwise interpretations were used.
+
+In other words, inside of a comparison operation (`if` or `switch` or `for` or `while`), `&` and `|` get evaluated AFTER the comparison operators (`<, >, <=, >=, ==, !=` etc). He admitted and lamented this design choice, but hey, it's already out in the wild, so we aren't changing it.
+
+Parenthetize your bitwise operations inside of comparisons, and you'll be just fine. Don't let this happen to you, kids.
+
 ## Compiling, uploading, and debugging from the CLI
 
-The Arduino IDE is ... not great. Its editor is crummy; I edit my code in Emacs and just use the IDE to upload, monitor and debug it. And frankly its debugger is not that great - I find most GUI debuggers to be kind of clunky, and this one especially. It's great for finding and adding libraries and things like that, but I don't like being constrained inside of it. Luckily the IDE is mostly just calling `arduino-cli` behind the scenes so everything the IDE does, we can do from the CLI. Setting up the arduino-cli is reasonably simple, but it quickly falls apart when you want to start debugging.
+The Arduino IDE is ... not great. Its editor is crummy; I edit my code in Emacs and just use the IDE to upload, monitor and debug it. And frankly its debugger is not that great - I find most GUI debuggers to be kind of clunky, and this one especially so.It *works*, but I would say, *just barely*. The IDE is great for finding and adding libraries and things like that, but I don't like being constrained inside of it. Luckily the IDE is mostly just calling `arduino-cli` behind the scenes so everything the IDE does, we can do from the CLI. Setting up the arduino-cli is reasonably simple, but it quickly falls apart when you want to start debugging.
 
 To set up the ESP32S3 dev board:
 
@@ -100,112 +144,142 @@ Monitor port settings:
 Connecting to /dev/ttyACM0. Press CTRL-C to exit.
 ```
 
-Let's debug it. The process requires spinning up OpenOCD and connecting GDB to it. Figuring out where OpenOCD got installed is not necessarily straightforward ... it depends on your toolchain, version, etc ... There is some googling involved. But once you find it:
+Let's debug it. The process requires spinning up OpenOCD and connecting GDB to it. Figuring out where OpenOCD got installed is not necessarily straightforward ... it depends on your toolchain, version, etc ... There is some googling involved. The easiest way is to fire up a debugger session from inside of `arduino-ide` and check `ps -aufx` to find the openocd process being executed. But once you find it:
 
 ```
 cd ~/.arduino15/packages/esp32/tools/openocd-esp32/v0.12.0-esp32-20251215/share/openocd/scripts/
 ../../../bin/openocd -f interface/esp_usb_jtag.cfg -f target/esp32s3.cfg
 ```
 
-Now you can connect gdb to it. I use a `.gdbinit` file to help set up GDB for monitoring this specific hardware environment, doing things like mapping a custom reset function:
-
-```
-$ cat .gdbinit 
-# 1. Connect to the running OpenOCD server
-target remote :3333
-
-# 2. Configure GDB for Espressif-specific environments
-set remote hardware-watchpoint-limit 2
-set remote hardware-breakpoint-limit 2
-set mem inaccessible-by-default off
-
-# 3. Handle FreeRTOS multi-threading without crashing GDB
-handle SIGTRAP noprint nostop pass
-
-# 4. Define a custom macro to safely reset the ESP32-S3
-define reset
-    monitor reset halt
-    flushregs
-end
-
-# 5. Execute a fresh reset and set initial breakpoint
-reset
-thbreak setup
-continue
-```
+Now you can connect gdb to it. Right?
 
 <center><img alt="This is where we would run the debugger, if we had one" src="nodebugger.jpeg" width="320px"/></center>
 
-This is where it gets quite silly. Apparently the esp32 toolchain installed by `arduino-cli` doesn't include the debugger. (Who would want a silly thing like that?) So you have to actually download and install the esp32 toolchain from Espressif directly, make sure that the gcc version matches, and then just drop in the debugger from that toolchain.
+Not really.
 
-I'm sure there won't ever be any problems at all from mixing and matching like this.
+The Arduino IDE hides some complexity in how to hook up the debugger. The openocd server serves as a bridge between gdb and the jtag interface on the ESP32, and you can't just hook gdb up to it. Even once you find the right gdb binary to connect to it (it's buried somewhere in your arduino install), there is some configuration magic buried in the arduino IDE installation that tells gdb and openocd how to talk to each other. I tried several times to make this work outside of the Arduino IDE and to be perfectly frank it was not worth the effort.
 
-So I had to ...
+You can install the Espressif ESP32 toolchain separately, and run the debugger from that, but again you're going to have some trouble getting it to work exactly right. There's a strong change the upstream Espressif toolchain  you downloaded has a different gcc version than what your Arduino IDE is running.
 
-1. Install the Espressif EIM tool directly from Espressif via Apt
-2. Install the ESP-IDF via the Espressif EIM tool
-3. ... wait ... watch my disk space get consumed by duplicate dev tools ...
-4. Source the ESP-IDF environment variables into my terminal `source "/home/andrew/.espressif/tools/activate_idf_v6.0.1.sh"`
-5. Run the debugger against openocd
+As long as I'm working with Arduino, I'll just use the Arduino IDE to debug the code. When I move on to STM32 after these projects, I'll drop out to my beloved command line gdb.
 
-... And it works
+## More breadboard bugs
 
-```
-Hardware assisted breakpoint 1 at 0x42001f3f: file /home/andrew/source/source.starfort.tech/andrew/esp32-learning/08-74HC595-Snake/08-74HC595-Snake.ino, line 49.
-Info : [esp32s3.cpu0] Target halted, PC=0x42008890, debug_reason=00000000
-[esp32s3.cpu0] Target halted, PC=0x42008890, debug_reason=00000000Info : Set GDB target to 'esp32s3.cpu0'
+My biggest frustration with these breadboards so far has been resistors. Resistors have really long legs out of the package, and I think for breadboard usage, much shorter resistor legs would be better. With their long legs, they short into other nodes, bend over, come loose, and get caught on other wires as they get moved around. I hate to cut down resistor legs since I might need them longer in other projects, but with this project, I had to start cutting them down so they would lie flush on the board.
 
-Set GDB target to 'esp32s3.cpu0'
-Info : [esp32s3.cpu1] Target halted, PC=0x42001F3F, debug_reason=00000001
-[esp32s3.cpu1] Target halted, PC=0x42001F3F, debug_reason=00000001
-Info : Detected FreeRTOS version: (10.5.1)
-[New Thread 1070529176]
-[Remote target exited]
-[New Thread 1070202636]
-[New Thread 1070204132]
-[New Thread 1070185320]
-[New Thread 1070207644]
-[New Thread 1070194980]
-[New Thread 1070183888]
-[Switching to Thread 1070529176]
+For example I had a problem with the LCD 7 segment display where segment D (the very bottom light in a cell) and segment E (the bottom left light in a cell) would only light together. So 2, 6, 8, 0, b, and d all appeared correctly. But 3, 5, A, and F would not. I traced every wire, every connection, checked every voltage on every pin of the display and the shift register. Best I can tell, it was due to a short somewhere in the breadboard. But I made the rookie mistake of wiring *everything* up before starting to work on the code, so by the time I saw the error, I was retiscent to pull it apart. But I'm glad I did; cutting down the resistor legs for flush mounting solved the problem.
 
-Thread 2 "loopTask" hit Temporary breakpoint 1, setup ()
-    at /home/andrew/source/source.starfort.tech/andrew/esp32-learning/08-74HC595-Snake/08-74HC595-Snake.ino:49
-49              memset(&js, 0x00, sizeof(Joystick));
-(gdb)
+By Day 4 of the project the breadboard had defeated me. The LED matrix had a short of some kind very similar to what the 7 segment LCD had. Some columns didn't work, some rows didn't work, and bumping the boards and resistors caused things to behave strangely. With great reluctance, I pulled everything apart, rewired the LED matrix and 7 segment display on their own breadboards away from the main ESP32 breakout and the potentiometer, cut down all the resistor wires for flush mounting, and that resolved all the issues.
+
+The issues with loose connections persisted. I had the game basically done but I was still struggling with rows or columns on the 8x8 mysteriously disappearing. i would bump the breadboard, and it would come back. The worst part was that sometimes the game would start with a dead row or column and you would have no idea until your snake entered it, or you found some food in it by accident. I wound up introducing a calibration state at the beginning of the game that did nothing more than light up all the pixels on the matrix, so you could make sure they were all lighting up before playing the game.
+
+## Joysticks and ADC and wierd outputs
+
+Once I had the 7 segment and LED matrix driver finally working (able to plot arbitrary pixels on the LED matrix), I attached the joystick so the user could control the snake. Attached the joystick X and Y to pins 1 and 2, power and ground, Z to 47, and ... the shift registers driving the 7 segment and matrix would see ADC values output to them from their signal pins whenever joystick X or Y went positive.
+
+<center><img alt="Something's fucky" src="somethingsfucky.jpg" width="320px" /></center>
+
+For example, the potentiometer that I use as a difficulty selector was on pin 9. The joystick X and Y were on pins 1 and 2. The serial data signals for the shift registers were on pins 14 and 18. The Freenove ESP32-S3-WROOM pinout shows:
+
+* 1 : `GPIO1, ADC1_CH0, T1`
+* 2 : `GPIO2, ADC1_CH1, LED_ON, T2`
+* 9 : `GPIO9, CAM_Y3, ADC1_CH8, T9`
+* 14 : `GPIO14, ADC2_CH3, T14`
+* 18 : `GPIO18, CAM_Y7, ADC2_CH7, U1RXD`
+
+Essentially this means that the shift registers were using GPIO pins that were doubled up on ADC2, and the joystick & potentiometer were using pins set up for ADC1. Why in the world would providing analog input values on pins 1 and 2 affect the outputs read on pins 2 and 9 - they are different ADC channels - let alone 14 and 18, when they are a separate ADC device entirely? I even tried moving pin 9 directly to ground - so there was never any signal coming to that pin, it was pinned to ground - and I still read values off that pin corresponding to the joystick values coming in to the ADC.
+
+I didn't actually wind up figuring this out. I wrestled with it for a bit, checked the TRM to see if maybe I could disable ADC channels I wasn't using, tried multisampling the ADC, tried attenuating it ... Nothing helped. I considered moving the shift register serial and clock lines to different GPIO pins without ADC, but almost every pin on this thing is connected to the ADC. There are no pins that are *just* GPIO with nothing else. I knew there must have been SOMETHING I did wrong, but at this point I'd been struggling with the LED matrix wiring and logic for days, and I was just tapped out with figuring out hardware wierdness. I threw in the towel on the joystick, and changed my design to use a small controller that used 4 buttons instead.
+
+... Once I got all that working, I discovered that the wire between the potentiometer and pin 10 was bad. No continuity through the wire. Had it been that way all along? I don't think so. But sure as shit it's dead now. Replaced that and the wierd analog readings on the potentiometer went away. I had already ripped out the joystick handling code, so I didn't try putting it back in. There's no turning back now.
+
+## Debouncing is a much bigger problem than I thought
+
+When I made the switch from a joystick to 4 d-pad style buttons, I reused my button debounce code from previous projects. It seemed to work pretty well. However, when I wired up 4 buttons on a breadboard, and got into a situation where I needed to have my fingers resting on them all the time to be ready to change the direction of the snake, I figured out how much of a problem software debouncing really is. Those buttons were *constantly* firing when I didn't want them to. Even just holding my fingers NEAR the buttons would sometimes cause them to start bouncing. Sometimes interference from neighboring wires would do it on their own! Eventually I just learned to live with it, but the next time I do a project like this, I think I'm going to use a 74HC14 or something similar as a hardware debouncer before my software even sees that signal. Super noisy! I really wanted to integrate them on this project, but honestly I didn't want to touch the breadboards again once I had all the wires working, so I just learned to live with it.
+
+## Arduino IDE debugger woes and ESP32 limits
+
+I spent about an hour struggling with a `Stack smashing protection` fault. Try as I might, I couldn't get the Arduino IDE debugger to show me where the actual crash was in my code. All I was getting was a fault with some addresses in memory for a backtrace. Sure, I could objdump the binary, figure out the addresses, and figure it out that way. But if I'm gonna do that, WTF is the point of having a GUI debugger? There are some GUI tools for decoding ESP32 stacktraces, but the Arduino IDE integration for them hasn't worked in at least one whole major version, and the newer versions want to run in some IDE I don't want to use.
+
+I wound up figuring it out essentially through trial and error. The `place_random_entity()` function uses an array of 64 bytes to store references to entries on the LED matrix where there are currently no actors. I had originally allocated that inside of the function itself - on the stack. Apparently this was the *wrong* place to put it. Moving this to a global variable resolved my problem. I have to assume that the default stack size was something ridiculously small, even though the scant documentation I could find said it would be something like 8Kb.
+
+I'm sure there was a more elegant solution than just moving it in to a global variable. But at this point, 9 days in to the project, lol bitch please, you're getting a global variable and we're making this damn thing run.
+
+## Driving 7-segment displays and 8x8 matrixes with shift registers
+
+These 7 segment LCD displays have an odd relationship between their pins and the segments of the LCD. You might think that you would start at pin 1 and proceed in some kind of logical fashion, clockwise or counterclockwise, around the device. Nope. The pins are all over the place; I assume because that's the most logical place for the physical connections to be, and putting them somewhere else would be inconvenient for the chip designer. Wiring them is kind of a pain, especially when you have a lot on the breadboard - especially depending on the kind of jumper wires you're using. Then there's the fact that you would need 8 individual GPIO lines to light up a single 7 segment LED; if you wanted to run a 4-cell unit (like I have on this game), then you need 12 GPIO pins. Needless to say, we can't sacrifice that many GPIOs.
+
+That's where the 74HC595 shift register comes in. It's a delightful little IC that takes in 8 bits over serial input, and reproduces them in parallel on the output. So you can use 3 pins (one data, one clock, and one latch) to do the job that used to require 8. So we throw a 74HC595 between the ESP32 and the 7 segment matrix, wire up the output enable pin to ground (because we essentially always want it to be enabled), give it some voltage, and voila - we're pushing 8 bits of parallel data with 8 bits of serial input.
+
+When I started this project, I had initially planned to write my own driver for the 74HC595's serial protocol, instead of using the builtin Arduino `shiftOut()` function. However there was so much time spent chasing other gremlins in this project that I ultimately abandoned this idea. I'll have to tinker with that some other time.
+
+One caveat to working with these 7 segment LED matrixes (beyond the wierd pin layout): when working with multiple cells, you need to turn the cell OFF immediately after you write to it, before going to the next one. If you don't, you get really wierd ghosting artifacts across the matrix. I'm not sure why that happens; but it does.
+
+One neat thing about these 74HC595 units is that you can daisy chain them together to create larger shift registers. By hooking the QH pin of the first IC to the serial in of the next IC, whenever we overflow past bit 7 on the first shift register, we begin pushing bits out of the first shift register into the second one. This allows us to essentially treat the daisy chain of 74HC595s like one big register of 16, or 24, or 32, or whatever bits width. And we never have to use more than 3 GPIOs; they all use the same clock, the same latch enable, and the same data pin. The ones wired further downstream in series just pull their data from the QH pin of the IC before them. 
+
+When I was originally designing the circuit for this, I intentionally didn't look at the upstream tutorial for using 74HC595s and tried to just figure it out from the datasheet. The datasheet did *not* make it clear to me that they could be wired in series like that - even going back now with that knowledge I struggle to see it in the datasheet. So I wound up with them sharing clock and latch signals, but they each had their own data pin, and I would push data to them individually. Obviously, this caused all kinds of problems; since I would only push to 1 of the 2 at a time, the one not receiving data would see the latch tripped, pull data from its serial pin, get noise, and corrupt itself. I struggled with this for a lot longer than I care to admit before I finally gave up, went and read the tutorial, wired it up exactly the way they had it, then stared at it for a while before realising how they had done the series wiring. When the light bulb finally came on, it was blinding.
+
+Wiring them in series is how the 8x8 LED matrix is driven. In this project, the 8x8 LED matrix is used like a very small screen, with each position on it treated like a pixel. Again, the wiring I have is what was in the tutorial, because I spent so much time struggling with my own wiring that I just accepted what the tutorial had and went with it. Unfortunately that leads to an odd little convention in the code for displaying a row on the matrix:
+
+```arduino
+void writeLEDMatrix(uint8_t row, uint8_t col)
+{
+    digitalWrite(matrixcols.updatepin, LOW);
+    shiftOut(matrixcols.datapin, matrixcols.clockpin, LSBFIRST, row);
+    shiftOut(matrixcols.datapin, matrixcols.clockpin, MSBFIRST, col);
+    digitalWrite(matrixcols.updatepin, HIGH);
+}
 ```
 
-Nevermind that the arduino-cli is compiling with a 14.x version of the esp32 gcc and this toolchain I just installed is using 16.x. .... You know what it's fine. Don't worry about it.
+You might notice that I'm reversing the bit order on the two `shiftOut` calls. No, that's not a bug, and until the very end o the project, I didn't really understand why it's doing it that way. Apparently the wiring tutorial I followed, for some reason, reversed the order of the wiring for columns, such that pin 1 of the shift register went to column 8 of the matrix. I presume they did this because, on their breadboard, that made the wiring make more sense. That wasn't necessary in my case, but since I followed their wiring, I adopted the convention without really realizing it. Because the wiring on those columns is backwards, the bit ordering on the columns has to be flipped. 
 
-This kind of garbage is apparently just part and parcel of working in the embedded world. When I get into STM32 and PIC microcontrollers here in a bit, I'll wind up with even more toolchains strung about and connected together with other various glue. I'm not entirely unfamiliar with this - back when I was at Nintendo, rigging up software for the devkits involved spaghetti library version and application management of the highest order. It wasn't until right about the time tht I left that we finally got with SDSG and got a working tool to manage all of that mess in a somewhat reasonable manner.
+I didn't figure this out until almost all other bugs were resolved. And by that time, I'll be damned if I'm gonna go in there and rip out wiring. It works this way, and it'll live this way.
 
-This just means that I'll continue using the Arduino IDE to debug my code; I can do everything else safely from the command line.
+Regardless, now that we had a pair of 8 bit registers that would allow us to control all the pixels on the 8x8 matrix, we could treat it like a tiny framebuffer. It might seem intuitive to say "we will select row X in the row shift register, and column Y in the column shift register, and away we go". But no... That's not how this hardware works. When you're driving hardware with software, you have to remember that the interface you're working with was designed primarily with the HARDWARE engineer's set of tradeoffs in mind. It's the software's job to adapt to the hardware interface, not the other way around. And in this case, the 8x8 matrix is either a common anode or a common cathode array of LEDs, meaning that all the LEDs on a row or column either share a common `+` or `-` connection. This means you can only turn on or off ROWS or COLUMNS at a time, and you control which elements in that row or column are lit by individual bits inside of the byte you send to the shift register.
 
-## Custom 74HC595 driver code
+This is why the matrix code only uses 8 bytes to control 64 individual pixels.
 
-* Getting the Arduino code to compile the additional .c file and include the header
-* Managing the clock signal
+```arduino
+uint8_t matrixcolumns[8] = {0};
 
-## Driving 7-segment displays
+int pokeMatrixPixel(uint8_t x, uint8_t y)
+{
+    if (x > 7 || y > 7) {
+    	ERROR(ERRNO_OUTOFBOUNDS);
+    }
+    // Because of the alignment of the screen in our demo, we treat columns as the X axis
+    matrixcolumns[x] = matrixcolumns[x] | (1 << y);
+    return ERRNO_SUCCESS;
+}
+```
 
-* Single units
-* Multiple units
+We are actually storing 8 columns represented by 8 bytes. Each bit inside of those bytes represents a single pixel in the column (row id). We treat columns as X and rows as Y because of the orientation of the matrix on the breadboard relative to the player and other controls. When we are poking a pixel, we just turn on the bit inside of the column (X) for the row (Y). Then, when we go to draw pixels on the matrix (think like flipping a page buffer on a VGA display or populating a framebuffer), we just send each entire column one by one, using the row shift register as a selector:
 
-## Driving an 8x8 LED matrix
-
-* Treat it like a tiny framebuffer. 64 (8*8) bytes, each containing a packed bitfield.
-  * High nibble
-    * On / Off
-    * Is it a pellet or a snake part
-  * Low nibble
-    * How many game cycles should this stay lit. For snake parts, this is a counter. For pellets this is ignored.
+```arduino
+void displayMatrix()
+{
+    for (int i = 0; i < 8; i++) {
+    	writeLEDMatrix(matrixcolumns[i], ~(1 << i));
+    }
+}
+```
 
 ## Fun within constraints
 
-* Only 1 color
-* Only 64 possible pixels
-* Four 7 segment readouts
-* Only 1 sound
-* Only 1 button
+I had never written a snake game before. (Wild, right?) So this was a fun project but it was also complicated by the fact that not only was I figuring out all the ins and outs of the 7 segment displays, the LED matrix, and the shift registers, but I was also figuring out how a snake game works. And I was doing it on a device that is (by modern standards) tiny - the ESP32-S3 has 512kB of internal RAM, with about 340kB of that being usable by your application. Granted, you can do A LOT with 512kB - the entire Amiga OS Kernel was written in 512kB of ROM, for example. But for average developers like us, that are used to working with gigabytes of ram at our disposal, this is essentially a starvation diet.
+
+Further, the hardware components themselves introduced a ton of constraints on the project:
+
+* The screen has only 1 color
+* The screen is tiny. Only 64 possible pixels.
+* I only have four 7 segment readouts to display information to the player
+* The speaker can only make 1 sound
+* The use of breadboards instead of protoboards required that all my D-Pad buttons were on the same horizontal plane
 * One player
-* 1 difficulty adjuster (controls the speed of the game clock)
+* 1 difficulty adjuster, which controls the speed of the game clock
+
+... But the product was (for me, at least) still really fun. Part of the reason this took me so long is that, when diagnosing a bug, I would just sit and play with it for long periods of time. Before I had game logic working, I would just watch the snae scroll off the side of the matrix and back on to the other side. I would play with the potentiometer and watch numbers change. Once I had the basic game logic working, and was diagnosing an issue with the scoreboard not displaying properly, I would just play snake for several rounds before getting back to work.
+
+It is very, very rare that I feel any kind of *fun* in the work I do professionally. I'm usually *glad that it's done* more than I am *excited to see it working*. This was absolutely not that way. Working through it was very frustrating at times, and there was more than once that I thought "This is too ambitious. Step back and do something smaller." But I'm glad I didn't. Because every breakthrough was a delightful little reward.
+
+And being able to play a hardware Snake game with my wife and kids, on a tiny little microcontroller, on a bunch of breadboards, that I (mostly) designed and implemented myself, was really fun. 10/10, highly recommended.

08-74HC595-Snake/build.sh

@@ -1,4 +1,4 @@
 #!/bin/bash
 
-arduino-cli compile --fqbn esp32:esp32:esp32s3:CDCOnBoot=cdc --output-dir build/ .
+arduino-cli compile --clean --optimize-for-debug --fqbn esp32:esp32:esp32s3:CDCOnBoot=cdc --output-dir build/ .
 

08-74HC595-Snake/controls.cpp

@@ -4,23 +4,6 @@
 #include "controls.h"
 #include "error.h"
 
-// For initializing B103-348 style joysticks
-int initJoystick(Joystick *js, uint8_t pin_x, uint8_t pin_y, uint8_t pin_z)
-{
-	if ( js == NULL ) {
-		ERROR(ERRNO_NULLPOINTER);
-	}
-	js->button.pin = pin_z;
-	js->button.debouncetime = BUTTON_STABLETIME;
-	js->button.pressedvalue = LOW;
-	pinMode(js->button.pin, INPUT_PULLUP);
-	js->x.pin = pin_x;
-	js->x.calibration.stable_time = JOYSTICK_STABLETIME;
-	js->y.pin = pin_y;
-	js->y.calibration.stable_time = JOYSTICK_STABLETIME;
-	return ERRNO_SUCCESS;
-}
-
 // For initializing simple buttons
 int initButton(Button *button)
 {
@@ -28,53 +11,6 @@ int initButton(Button *button)
     return ERRNO_SUCCESS;
 }
 
-// Calibrate a given joystick
-int calibrateJoystick(Joystick *js)
-{
-	uint32_t x = 0;
-	uint32_t y = 0;
-	uint32_t curmillis = 0;
-	if ( js == NULL ) {	
-		ERROR(ERRNO_NULLPOINTER);
-	}
-	curmillis = millis();
-	if ( js->x.calibration.start_time == 0 || js->y.calibration.start_time == 0 ) {
-		// Starting a new calibration cycle
-		Serial.printf("Starting a new calibration cycle\n");
-		js->x.calibration.low = 65535;
-		js->x.calibration.high = 0;
-		js->y.calibration.low = 65535;
-		js->y.calibration.high = 0;
-		js->x.calibration.start_time = curmillis;
-		js->y.calibration.start_time = curmillis;
-		return ERRNO_SUCCESS;
-	}
-	if ( (curmillis - js->x.calibration.start_time) >= js->x.calibration.stable_time ) {
-		js->state = JOYSTICK_STATE_CALIBRATED;
-		js->x.calibration.start_time = 0;
-		js->y.calibration.start_time = 0;
-		Serial.printf("Calibrated joystick to x: <%d, %d> y <%d, %d>\n",
-									js->x.calibration.low,
-									js->x.calibration.high,
-									js->y.calibration.low,
-									js->y.calibration.high);
-		return ERRNO_SUCCESS;
-	}
-	x = analogRead(js->x.pin);
-	if ( x < js->x.calibration.low ) {
-		js->x.calibration.low = x;
-	} else if ( x > js->x.calibration.high ) {
-		js->x.calibration.high = x;
-	}
-	y = analogRead(js->y.pin);
-	if ( y < js->y.calibration.low ) {
-		js->y.calibration.low = y;
-	} else if ( y > js->y.calibration.high ) {
-		js->y.calibration.high = y;
-	}
-	return ERRNO_SUCCESS;
-}
-
 // Read the state of a given button
 int readButton(Button *button)
 {
@@ -115,40 +51,14 @@ int readButton(Button *button)
 	button->state = button->state | BUTTON_STATE_BOUNCING;
 	button->debounce_start_time = curmillis;
     }
-	
     return ERRNO_SUCCESS;
 }
 
-int readJoystick(Joystick *js)
+uint32_t readDifficulty()
 {
-	uint32_t adcvalue = 0;
-	if ( js == NULL ) {	
-		ERROR(ERRNO_NULLPOINTER);
-	}
-	js->state = js->state | JOYSTICK_STATE_READING;
-	
-	adcvalue = analogRead(js->x.pin);
-	if ( adcvalue < js->x.calibration.low || adcvalue > js->x.calibration.high ) {
-		js->x.position = adcvalue;
-	} else {
-		// Snap to center
-		js->x.position = 2048;
-	}
-	adcvalue = analogRead(js->y.pin);
-	if ( adcvalue < js->y.calibration.low || adcvalue > js->y.calibration.high ) {
-		js->y.position = adcvalue;
-	} else {
-		// Snap to center
-		js->y.position = 2048;
-	}
-	//Serial.printf("Joystick x %d y %d\n", js->x.position, js->y.position);
-	
-	readButton(&js->button);
-	js->state = js->state ^ JOYSTICK_STATE_READING;
-	if ( errno != ERRNO_SUCCESS ) {
-		Serial.printf("Failed to read joystick button : %d\n", errno);
-		return errno;
-	}
-	js->state = js->state | JOYSTICK_STATE_READY;
-	return ERRNO_SUCCESS;
+    analogRead(PIN_DIFFICULTY);
+    delay(1);
+    uint32_t setting = analogRead(PIN_DIFFICULTY);
+    uint32_t divisor = 4096/9;
+    return setting/divisor;
 }

08-74HC595-Snake/controls.h

@@ -4,8 +4,14 @@
 #include <Arduino.h>
 #include <stdint.h>
 
+#define PIN_BUTTON_LEFT      1 // Red
+#define PIN_BUTTON_UP        2 // Green
+#define PIN_BUTTON_DOWN      47 // Yellow
+#define PIN_BUTTON_RIGHT     13 // Blue
+
+#define PIN_DIFFICULTY             10
+
 #define BUTTON_STABLETIME    100
-#define JOYSTICK_STABLETIME  3000
 
 // Button states
 #define BUTTON_STATE_BOUNCING     (1 << 0)
@@ -13,22 +19,6 @@
 #define BUTTON_STATE_UP           (1 << 2)
 #define BUTTON_STATE_HELD         (1 << 3)
 
-// Joystick states
-#define JOYSTICK_STATE_CALIBRATING (1 << 0)
-#define JOYSTICK_STATE_CALIBRATED  (1 << 1)
-#define JOYSTICK_STATE_READING     (1 << 2)
-#define JOYSTICK_STATE_READY       (1 << 3)
-
-typedef struct Calibration {
-	// When did calibration start
-	uint32_t start_time;
-	// Low calibration range
-	uint32_t low;
-	// High calibration range
-	uint32_t high;
-	// How long we should sample values on this joystick
-	uint32_t stable_time;
-} Calibration;
 
 typedef struct Button {
     // What pin is this button on
@@ -43,30 +33,8 @@ typedef struct Button {
     uint32_t debounce_start_time;
 } Button;
 
-typedef struct JoystickAxis {
-	// What ADC pin is this joystick axis connected to
-	uint8_t pin;
-	// Calibration data
-	Calibration calibration;
-	// Position as of the last read time.
-	uint32_t position;
-} JoystickAxis;
-
-typedef struct Joystick {
-	// X axis data
-	JoystickAxis x;
-	// Y axis data
-	JoystickAxis y;
-	// This is the Z axis switch on the joystick control
-	Button button;
-	// What is the state of this joystick (bitmask of JOYSTICK_STATE_*)
-	uint8_t state;
-} Joystick;
-
-int initJoystick(Joystick *js, uint8_t pin_x, uint8_t pin_y, uint8_t pin_z);
 int initButton(Button *button);
-int calibrateJoystick(Joystick *js);
 int readButton(Button *button);
-int readJoystick(Joystick *js);
+uint32_t readDifficulty();
 
 #endif // _JOYSTICK_H_

08-74HC595-Snake/debug.sh

@@ -1,8 +1,5 @@
 #!/bin/bash
 
-(cd ~/.arduino15/packages/esp32/tools/openocd-esp32/v0.12.0-esp32-20251215/share/openocd/scripts/ ; ../../../bin/openocd -f interface/esp_usb_jtag.cfg -f target/esp32s3.cfg) &
+(cd ~/.arduino15/packages/esp32/tools/openocd-esp32/v0.12.0-esp32-20251215/share/openocd/scripts/ ; ../../../bin/openocd -f board/esp32s3-builtin.cfg) &
 
 /home/andrew/.espressif/tools/xtensa-esp-elf-gdb/16.3_20250913/xtensa-esp-elf-gdb/bin/xtensa-esp32-elf-gdb -x .gdbinit ./build/08-74HC595-Snake.ino.elf
-
-#/home/andrew/.arduino15/packages/esp32/tools/esp-x32/2601/share/licenses/binutils/gdb -x .gdbinit ./build/08-74HC595-Snake.ino.elf
-

08-74HC595-Snake/error.h

@@ -6,6 +6,7 @@
 #define ERRNO_IO              2
 #define ERRNO_TIMEOUT         3
 #define ERRNO_CALIBRATION     4
+#define ERRNO_OUTOFBOUNDS     5
 
 #define ERROR(x) errno=x; return x;
 

08-74HC595-Snake/matrix.cpp

@@ -0,0 +1,56 @@
+#include <Arduino.h>
+#include <stdint.h>
+#include "error.h"
+#include "IC74HC595.h"
+#include "matrix.h"
+
+uint8_t matrixcolumns[8] = {0};
+
+int pokeMatrixPixel(uint8_t x, uint8_t y)
+{
+    if (x > 7 || y > 7) {
+	ERROR(ERRNO_OUTOFBOUNDS);
+    }
+    // Because of the alignment of the screen in our demo, we treat columns as the X axis
+    matrixcolumns[x] = matrixcolumns[x] | (1 << y);
+    return ERRNO_SUCCESS;
+}
+
+void resetMatrix()
+{
+    matrixcolumns[0] = 0;
+    matrixcolumns[1] = 0;
+    matrixcolumns[2] = 0;
+    matrixcolumns[3] = 0;
+    matrixcolumns[4] = 0;
+    matrixcolumns[5] = 0;
+    matrixcolumns[6] = 0;
+    matrixcolumns[7] = 0;
+}
+
+void displayMatrix()
+{
+    for (int i = 0; i < 8; i++) {
+	writeLEDMatrix(matrixcolumns[i], ~(1 << i));
+    }
+}
+
+void writeLEDMatrix(uint8_t row, uint8_t col)
+{
+    digitalWrite(matrixcols.updatepin, LOW);
+    shiftOut(matrixcols.datapin, matrixcols.clockpin, LSBFIRST, row);
+    shiftOut(matrixcols.datapin, matrixcols.clockpin, MSBFIRST, col);
+    digitalWrite(matrixcols.updatepin, HIGH);
+}
+
+void testMatrix()
+{
+    uint8_t row = 0;
+    uint8_t col = 0;
+    for ( int i = 0; i < 8; i++ ) {
+	row = (1 << i);
+	col = ~(1 << i);
+	Serial.printf("%d = (%d, %d)\n", i, row, col);
+	writeLEDMatrix(row, col);
+    }
+};

08-74HC595-Snake/matrix.h

@@ -0,0 +1,12 @@
+#ifndef _MATRIX_H_
+#define _MATRIX_H_
+
+#include <stdint.h>
+
+int pokeMatrixPixel(uint8_t x, uint8_t y);
+void resetMatrix();
+void displayMatrix();
+void writeLEDMatrix(uint8_t row, uint8_t col);
+void testMatrix();
+
+#endif // _MATRIX_H_