Add a feature to release all Pokémon from Boxes

Author: VinDuv

src/swsh/README.md

@@ -274,3 +274,18 @@ During the Egg hatch animation (RX/TX lighted up, L blinking) you can interrupt
 process by pressing the button. The process will give you back control. Press it again
 while on the Switch main menu (cursor on the game icon) to get back back into the
 automation “main menu” where you can choose another automation task.
+
+### Release Boxes [Feature 5 - five button presses]
+
+This feature allows releasing one or multiple Boxes of Pokémon.
+
+**Pre-requisites:**
+
+ - The Boxes menu is open on the first Box whose Pokémon are to be released.
+ - The selection modes (X/Y buttons) are normal.
+ - The Boxes whose Pokémon are to be released are completely full.
+
+When this feature is activated, it will start by moving the selection cursor
+to the top left Pokémon in the Box. It will then wait for input; press the
+button once to release all Pokémon in the current Box and move to the next Box
+(on the right); press the button twice when you are done.

src/swsh/swsh.c

@@ -26,6 +26,11 @@ static void go_to_nursery_helper(void);
 static void get_egg(void);
 static void move_in_circles(uint16_t cycles, bool go_up_first);
 static bool hatch_egg(void);
+static void release_full_boxes(void);
+static void position_box_cursor_topleft(void);
+static void for_each_box_pos(bool top_left_start, void (*callback)(void));
+static void release_from_box(void);
+
 
 int main(void)
 {
@@ -72,6 +77,10 @@ int main(void)
 				auto_breeding();
 			break;
 
+			case 5:
+				release_full_boxes();
+			break;
+
 			default:
 				/* Wrong selection */
 				delay(100, 200, 1500);
@@ -733,3 +742,115 @@ bool hatch_egg(void)
 
 	return false;
 }
+
+
+/*
+ * From the Box menu, releases all Pokémon in the current box, then move
+ * to the next Box. User confirmation is asked for each Box. The Boxes must
+ * be completely full.
+ */
+void release_full_boxes(void)
+{
+	position_box_cursor_topleft();
+
+	bool cursor_topleft = true;
+
+	for (;;) {
+		/* Wait for user confirmation */
+		beep();
+		if (count_button_presses(500, 500) > 1) {
+			/* User cancelled, we are done */
+			return;
+		}
+
+		/* Release the Box content */
+		for_each_box_pos(cursor_topleft, &release_from_box);
+
+		/* The cursor position was toggled by the operation */
+		cursor_topleft ^= true;
+
+		/* Move to the next Box */
+		SEND_BUTTON_SEQUENCE(
+			{ BT_R,	DP_NEUTRAL,	SEQ_MASH,	1 },	/* Next Box */
+		);
+	}
+}
+
+
+/*
+ * Position the cursor to the top left Pokémon in the Box menu.
+ */
+void position_box_cursor_topleft(void)
+{
+	/* We hold the D-pad to put the cursor in a known position (mashing it does
+	   not work since it makes the cursor roll around the edges of the screen).
+	   We need to avoir getting the cursor on the Box title since the D-pad
+	   will start changing the selected Box. The screen layout also tend to
+	   make the cursor stuck in random positions if diagonal directions are
+	   used.*/
+
+	SEND_BUTTON_SEQUENCE(
+		{ BT_NONE,	DP_BOTTOM,	SEQ_HOLD,	25 },	/* Bottom row */
+		{ BT_NONE,	DP_LEFT,	SEQ_HOLD,	25 },	/* Last Pokémon */
+		{ BT_NONE,	DP_TOP,		SEQ_MASH,	5  },	/* First team Pokémon */
+		{ BT_NONE,	DP_RIGHT,	SEQ_MASH,	1  },	/* Top/Left Box Pokémon */
+	);
+}
+
+
+/*
+ * Calls a callback after positioning the cursor on each Pokémon in the Box.
+ * The starting position can either be the top left Pokémon or the bottom
+ * right. The ending cursor position will be the reverse of the starting
+ * cursor position.
+ */
+void for_each_box_pos(bool top_left_start, void (*callback)(void))
+{
+	/* Do we go left on even rows (row 0, row 2, etc)? */
+	uint8_t left_on_even = (top_left_start ? 0 : 1);
+
+	/* Which direction to use to move between rows? */
+	enum d_pad_state change_row_dir = (top_left_start ? DP_BOTTOM : DP_TOP);
+
+	for (uint8_t row = 0 ; row < 5 ; row += 1) {
+		for (uint8_t col = 0 ; col < 5 ; col += 1) {
+			enum d_pad_state move_dir;
+
+			callback();
+
+			if ((row % 2) == left_on_even) {
+				move_dir = DP_RIGHT;
+			} else {
+				move_dir = DP_LEFT;
+			}
+
+			SEND_BUTTON_SEQUENCE(
+				{ BT_NONE,	move_dir,	SEQ_MASH,	1 },
+			);
+		}
+
+		callback();
+		if (row < 4) {
+			SEND_BUTTON_SEQUENCE(
+				{ BT_NONE,	change_row_dir,	SEQ_MASH,	1 },
+			);
+		}
+	}
+}
+
+
+/*
+ * Release from the Box the Pokémon on which the cursor is on.
+ */
+void release_from_box(void)
+{
+	SEND_BUTTON_SEQUENCE(
+		{ BT_A,		DP_NEUTRAL,	SEQ_HOLD,	8  },	/* Open menu */
+		{ BT_NONE,	DP_TOP,		SEQ_MASH,	2  },	/* Go to option */
+		{ BT_A,		DP_NEUTRAL,	SEQ_HOLD,	20  },	/* Select option */
+		{ BT_NONE,	DP_TOP,		SEQ_MASH,	1  },	/* Go to Yes */
+		{ BT_A,		DP_NEUTRAL,	SEQ_HOLD,	25  },	/* Validate dialog 1 */
+		{ BT_NONE,	DP_NEUTRAL,	SEQ_HOLD,	1  },	/* Release 1 */
+		{ BT_A,		DP_NEUTRAL,	SEQ_HOLD,	10  },	/* Validate dialog 2 */
+	);
+}