Add buzzer support

A buzzer can be connected between pins 2 and ground of the Arduino board. It
will be used to alert the user when they need to look at the game.

Author: VinDuv

Makefile

@@ -8,7 +8,7 @@ all: swsh.hex usb-iface.hex
 # Put program definitions (.o => src/<prog>.elf) here
 # make <prog>.hex will generate the final program and make flash-<prog> will
 # flash it.
-src/swsh.elf: src/swsh/swsh.o src/lib/automation.o src/lib/automation-utils.o src/lib/led-button.o
+src/swsh.elf: src/swsh/swsh.o src/lib/automation.o src/lib/automation-utils.o src/lib/user-io.o
 
 flash-%: %.hex
 	avrdude -p atmega328p -c avrispmkii -P usb -U flash:w:$<:i

README.md

@@ -6,7 +6,8 @@ Switch controller using an Arduino UNO R3.
 
 The API allows sending button presses/stick movements on the emulated
 controller, to read the state of a physical button connected between the
-Arduino’s pins 12 and ground, and to control the Arduino’s on-board LED.
+Arduino’s pins 12 and ground, and to control the Arduino’s on-board LED as well
+as an external buzzer.
 
 Pokémon Sword/Shield automation
 -------------------------------
@@ -67,6 +68,9 @@ Required hardware
    be tested. (Note: DFU programming may also stop working once this program is
    flashed onto the Arduino, so you should not attempt it if you do not have
    access to an external programmer)
+ - A buzzer can be optionally attached between pins 2 and GND of the Arduino
+   board, in order for the automation process to notify the user when something
+   needs their attention.
 
 Required software
 -----------------

src/lib/led-button.c renamed to src/lib/user-io.c

@@ -1,4 +1,4 @@
-#include "led-button.h"
+#include "user-io.h"
 
 #include <avr/io.h>
 #include <util/delay.h>
@@ -9,12 +9,16 @@
 /* Button on digital pin 12 port B */
 #define PORTB_BUTTON (1 << 4)
 
+/* Buzzer (digital pin 2) on port D */
+#define PORTD_BUZZER (1 << 2)
+
 
 /* Initializes the LED/button interface. */
 void init_led_button(void)
 {
-	/* Configure LED as output, button as input */
+	/* Configure LED as output, buzzer as output, button as input */
 	DDRB = (DDRB | PORTB_LED) & (~PORTB_BUTTON);
+	DDRD |= PORTD_BUZZER;
 
 	/* Enable pullup on button */
 	PORTB |= PORTB_BUTTON;
@@ -71,3 +75,12 @@ uint8_t blink_led(uint16_t on_time_ms, uint16_t off_time_ms, uint8_t count,
 
 	return button_presses;
 }
+
+
+/* Emit a brief beep the buzzer. */
+void beep(void)
+{
+	PORTD |= PORTD_BUZZER;
+	_delay_ms(1);
+	PORTD &= ~PORTD_BUZZER;
+}

src/lib/led-button.h renamed to src/lib/user-io.h

@@ -1,22 +1,23 @@
 /*
- * LED and button interface
+ * I/O user interface
  *
  * This file provides functions to provide a basic user interface using the
- * Arduino UNO LED (L) and a push button connected beween pins 12 and GND.
+ * Arduino UNO LED (L) a push button connected beween pins 12 and GND, and
+ * an optional buzzer connected between pins 2 and GND.
  *
  * The two other LEDs on the UNO board (RX/TX) are only accessible by the
  * USB interface and can be set using the automation API (see automation.h)
  */
 
-#ifndef LED_BUTTON_H
-#define LED_BUTTON_H
+#ifndef USER_IO_H
+#define USER_IO_H
 
 #include <stdint.h>
 #include <stdbool.h>
 
 /*
- * Initializes the LED/button interface. Must be called before calling
- * other functions in this file.
+ * Initializes the IO interface. Must be called before calling other functions
+ * in this file.
  */
 void init_led_button(void);
 
@@ -36,4 +37,9 @@ uint8_t count_button_presses(uint16_t wait_ms);
 uint8_t blink_led(uint16_t on_time_ms, uint16_t off_time_ms, uint8_t count,
 	bool wait_for_first_press);
 
+/*
+ * Emit a brief beep the buzzer.
+ */
+void beep(void);
+
 #endif

src/swsh/README.md

@@ -8,7 +8,11 @@ Requirements
 
 You will need an Arduino UNO R3, an external Arduino programmer, and a
 pushbutton inserted in the Arduino board, between pins 13 and GND (on the top
-row). See [the main README](../../README.md#required-hardware) for details.
+row).
+
+You can additionally install a buzzer between pins 2 and GND.
+
+See [the main README](../../README.md#required-hardware) for details.
 
 Installation
 ------------

src/swsh/swsh.c

@@ -5,7 +5,7 @@
 #include <util/delay.h>
 
 #include "automation-utils.h"
-#include "led-button.h"
+#include "user-io.h"
 
 /* Static functions */
 static void temporary_control(void);
@@ -21,6 +21,9 @@ int main(void)
 	init_automation();
 	init_led_button();
 
+	/* Initial beep to confirm that the buzzer works */
+	beep();
+
 	/* Wait for the user to press the button (should be on the Switch main menu) */
 	blink_led(100, 100, 1, true);
 
@@ -122,6 +125,9 @@ void max_raid(void)
 	set_text_speed(/* fast_speed */ false, /* save */ true);
 
 	for (;;) {
+		/* Ask the user to look at the light pillar color */
+		beep();
+
 		/* Drop the Wishing Piece in the den */
 		use_wishing_piece_and_pause();
 
@@ -155,6 +161,9 @@ void max_raid(void)
 	);
 
 	for (;;) {
+		/* Ask the user to look at the Pokémon in the Max Raid Battle */
+		beep();
+
 		/* Do the user wants to do this Raid? */
 		if (blink_led(250, 250, 10, false)) {
 			/* Restore the clock */