Macropad - Revision history

Johnsonm3: provided steps for platformio based firmware build and reprogramming step

2026-04-03T15:51:44Z

provided steps for platformio based firmware build and reprogramming step

← Older revision		Revision as of 15:51, 3 April 2026
Line 71:		Line 71:
	<u>'''If you just made your macropad, you'll need to flash it with the firmware.'''</u>		<u>'''If you just made your macropad, you'll need to flash it with the firmware.'''</u>

	# download the [https://~~www~~.~~arduino~~.cc/~~en/software arduino IDE~~]		# download the [https://code.visualstudio.com/ Visual Studio Code]
	# In the ~~arduino IDE, go to tools~~-~~>boards->board manager. Then search esp32 and install the library made by arduino~~		# Once installed, click on the extension menu (looks like 3-4 cubes stacked on top of eachother)
	# ~~Then go to tools->manage libraries~~ then install ~~the following:~~		# Search for platformio, then install! Select trust this author. This may take awhile, so be patient
	#~~# ArduinoJson~~		# In the mean time, go to the [https://github.com/Marshall-J2698/Makerpad github page], and download the repo
	~~## StringSplitter~~		#Back in VScode, click the new tab on the left that looks like an ant. you should be greeted with a home screen that has an option for opening an existing project. You want to find this, or a similar option, and use it to open the firmware folder from the repo you just cloned!
	~~# press select board, esp32~~, ~~and select esp32S2 Dev Module~~		#Once you do this, platformio will automatically start installing dependencies! Wait for these to be done, then plug in your board.
	# go to the [https://github.com/Marshall-J2698/Makerpad github page], and download ~~all~~ the ~~files~~. ~~Now~~, open the ~~ino file in~~ the ~~arduino program (~~you ~~may need to do some renaming-the IDE should~~ do this for ~~you).~~		#Hold down the zero button on the esp32 itself (it's the button next to the usb port labeled 0), then press the reset button.
	~~#Now~~ plug in your board~~, and press~~ the ~~two reset buttons that are~~ on the ~~ESP32~~ (~~the purple board) itself; they're located near the usb port. If you're using the makerspace case, there~~'s ~~a hole on~~ the ~~top of the case and~~ next to the usb port~~. Specifically~~, ~~you want to hold the top button for ~2s and~~ then press the ~~other key once~~.		#Now, In the bottom row of VScode, press the right arrow button and wait for it to flash
	#~~Go to tools->port->then select~~ the ~~one with esp32~~		##it may say "failed to upload"; this is usually not a big deal, so long as you saw the flashing progress bar a few seconds prior.
	~~#now~~ press the ~~upload~~ button~~! (~~it~~'s the right-facing arrow~~, in the ~~top left)~~		#You should be good to go!

	'''<u>if you've already made, and flashed the firmware, there are only a few steps to reprogram:</u>'''		'''<u>if you've already made, and flashed the firmware, there are only a few steps to reprogram:</u>'''

	# press ~~down key 1 (~~the ~~left key) and~~ the ~~encoder knob at the same time, until key 1 stops sending keypresses~~		# press the zero button on the esp32. This should stop keys from typing out null when pressed.
	# after ~5seconds, pressing key 1 should cause an address to be typed in; specifically 192.168.1.1		# after ~5seconds, pressing key 1 should cause an address to be typed in; specifically 192.168.1.1
	# Now, go to your wifi settings, and connect to the new network that's appeared (likely named macropad or macropad-config, unless you manually renamed it)		# Now, go to your wifi settings, and connect to the new network that's appeared (likely named macropad or macropad-config, unless you manually renamed it)
			## unless changed, the default password for this network is just "password"
	# open any web browser (while connected to this network) and type in the address 192.168.1.1 (or just press key 1)		# open any web browser (while connected to this network) and type in the address 192.168.1.1 (or just press key 1)
	# this should take you to the programming page! now, enter in what you want each key to do, and press submit!		# this should take you to the programming page! now, enter in what you want each key to do, and press submit!
Line 100:		Line 101:
	*Here's a comprehensive list of every availible special key:		*Here's a comprehensive list of every availible special key:
	**KEY_LEFT_CTRL KEY_LEFT_SHIFT KEY_LEFT_ALT KEY_LEFT_GUI KEY_RIGHT_CTRL KEY_RIGHT_SHIFT KEY_RIGHT_ALT KEY_RIGHT_GUI KEY_UP_ARROW KEY_DOWN_ARROW KEY_LEFT_ARROW KEY_RIGHT_ARROW KEY_MENU KEY_SPACE KEY_BACKSPACE KEY_TAB KEY_RETURN KEY_ESC KEY_INSERT KEY_DELETE KEY_PAGE_UP KEY_PAGE_DOWN KEY_HOME KEY_END KEY_NUM_LOCK KEY_CAPS_LOCK KEY_F1 KEY_F2 KEY_F3 KEY_F4 KEY_F5 KEY_F6 KEY_F7 KEY_F8 KEY_F9 KEY_F10 KEY_F11 KEY_F12 KEY_F13 KEY_F14 KEY_F15 KEY_F16 KEY_F17 KEY_F18 KEY_F19 KEY_F20 KEY_F21 KEY_F22 KEY_F23 KEY_F24 KEY_PRINT_SCREEN KEY_SCROLL_LOCK KEY_PAUSE		**KEY_LEFT_CTRL KEY_LEFT_SHIFT KEY_LEFT_ALT KEY_LEFT_GUI KEY_RIGHT_CTRL KEY_RIGHT_SHIFT KEY_RIGHT_ALT KEY_RIGHT_GUI KEY_UP_ARROW KEY_DOWN_ARROW KEY_LEFT_ARROW KEY_RIGHT_ARROW KEY_MENU KEY_SPACE KEY_BACKSPACE KEY_TAB KEY_RETURN KEY_ESC KEY_INSERT KEY_DELETE KEY_PAGE_UP KEY_PAGE_DOWN KEY_HOME KEY_END KEY_NUM_LOCK KEY_CAPS_LOCK KEY_F1 KEY_F2 KEY_F3 KEY_F4 KEY_F5 KEY_F6 KEY_F7 KEY_F8 KEY_F9 KEY_F10 KEY_F11 KEY_F12 KEY_F13 KEY_F14 KEY_F15 KEY_F16 KEY_F17 KEY_F18 KEY_F19 KEY_F20 KEY_F21 KEY_F22 KEY_F23 KEY_F24 KEY_PRINT_SCREEN KEY_SCROLL_LOCK KEY_PAUSE


			'''<u>Legacy steps for reprogramming</u>''' - As of april 2026, we have moved our firmware to Platformio build system, as it makes for a much more repeatable development and usage experience. If you would like to use the old arduino code and procedure, feel free to look through old commits in the github, and follow the tutorial below.
			# download the [https://www.arduino.cc/en/software arduino IDE]
			# In the arduino IDE, go to tools->boards->board manager. Then search esp32 and install the library made by arduino
			# Then go to tools->manage libraries then install the following:
			## ArduinoJson
			## StringSplitter
			# press select board, esp32, and select esp32S2 Dev Module
			# go to the [https://github.com/Marshall-J2698/Makerpad github page], and download all the files. Now, open the ino file in the arduino program (you may need to do some renaming-the IDE should do this for you).
			#Now plug in your board, and press the two reset buttons that are on the ESP32 (the purple board) itself; they're located near the usb port. If you're using the makerspace case, there's a hole on the top of the case and next to the usb port. Specifically, you want to hold the top button for ~2s and then press the other key once.
			#Go to tools->port->then select the one with esp32
			#now press the upload button! (it's the right-facing arrow, in the top left)

			'''<u>if you've already made, and flashed the firmware, there are only a few steps to reprogram:</u>'''

			# press down key 1 (the left key) and the encoder knob at the same time, until key 1 stops sending keypresses
			# after ~5seconds, pressing key 1 should cause an address to be typed in; specifically 192.168.1.1
			# Now, go to your wifi settings, and connect to the new network that's appeared (likely named macropad or macropad-config, unless you manually renamed it)
			# open any web browser (while connected to this network) and type in the address 192.168.1.1 (or just press key 1)
			# this should take you to the programming page! now, enter in what you want each key to do, and press submit!
	[[Category:Projects]]		[[Category:Projects]]
	[[Category:Soldering]]		[[Category:Soldering]]
	[[Category:Programming]]		[[Category:Programming]]
	[[Category:SimpleProjects]]		[[Category:SimpleProjects]]

Johnsonm3: added as simple project

2025-12-04T16:47:50Z

added as simple project

← Older revision		Revision as of 16:47, 4 December 2025
Line 103:		Line 103:
	[[Category:Soldering]]		[[Category:Soldering]]
	[[Category:Programming]]		[[Category:Programming]]
			[[Category:SimpleProjects]]

GiseleN: edited categories

2025-02-12T23:18:13Z

edited categories

← Older revision		Revision as of 23:18, 12 February 2025
Line 1:		Line 1:
	~~[[Category:Tutorials]]~~

	== Assembly instructions: ==		== Assembly instructions: ==
	Assembly instructions can also be found in a printable form [https://docs.google.com/document/d/1evz1lOS-nTeEMei8WJlVfmJ6C-Dw2esytz5mxuN_9Ek/edit?usp=sharing here]		Assembly instructions can also be found in a printable form [https://docs.google.com/document/d/1evz1lOS-nTeEMei8WJlVfmJ6C-Dw2esytz5mxuN_9Ek/edit?usp=sharing here]

GiseleN: added projects category

2025-02-09T20:30:03Z

added projects category

← Older revision		Revision as of 20:30, 9 February 2025
Line 102:		Line 102:
	*Here's a comprehensive list of every availible special key:		*Here's a comprehensive list of every availible special key:
	**KEY_LEFT_CTRL KEY_LEFT_SHIFT KEY_LEFT_ALT KEY_LEFT_GUI KEY_RIGHT_CTRL KEY_RIGHT_SHIFT KEY_RIGHT_ALT KEY_RIGHT_GUI KEY_UP_ARROW KEY_DOWN_ARROW KEY_LEFT_ARROW KEY_RIGHT_ARROW KEY_MENU KEY_SPACE KEY_BACKSPACE KEY_TAB KEY_RETURN KEY_ESC KEY_INSERT KEY_DELETE KEY_PAGE_UP KEY_PAGE_DOWN KEY_HOME KEY_END KEY_NUM_LOCK KEY_CAPS_LOCK KEY_F1 KEY_F2 KEY_F3 KEY_F4 KEY_F5 KEY_F6 KEY_F7 KEY_F8 KEY_F9 KEY_F10 KEY_F11 KEY_F12 KEY_F13 KEY_F14 KEY_F15 KEY_F16 KEY_F17 KEY_F18 KEY_F19 KEY_F20 KEY_F21 KEY_F22 KEY_F23 KEY_F24 KEY_PRINT_SCREEN KEY_SCROLL_LOCK KEY_PAUSE		**KEY_LEFT_CTRL KEY_LEFT_SHIFT KEY_LEFT_ALT KEY_LEFT_GUI KEY_RIGHT_CTRL KEY_RIGHT_SHIFT KEY_RIGHT_ALT KEY_RIGHT_GUI KEY_UP_ARROW KEY_DOWN_ARROW KEY_LEFT_ARROW KEY_RIGHT_ARROW KEY_MENU KEY_SPACE KEY_BACKSPACE KEY_TAB KEY_RETURN KEY_ESC KEY_INSERT KEY_DELETE KEY_PAGE_UP KEY_PAGE_DOWN KEY_HOME KEY_END KEY_NUM_LOCK KEY_CAPS_LOCK KEY_F1 KEY_F2 KEY_F3 KEY_F4 KEY_F5 KEY_F6 KEY_F7 KEY_F8 KEY_F9 KEY_F10 KEY_F11 KEY_F12 KEY_F13 KEY_F14 KEY_F15 KEY_F16 KEY_F17 KEY_F18 KEY_F19 KEY_F20 KEY_F21 KEY_F22 KEY_F23 KEY_F24 KEY_PRINT_SCREEN KEY_SCROLL_LOCK KEY_PAUSE
			[[Category:Projects]]
			[[Category:Soldering]]
			[[Category:Programming]]

Johnsonm3: updated LED images

2024-05-22T18:34:07Z

updated LED images

← Older revision		Revision as of 18:34, 22 May 2024
Line 55:		Line 55:

	=== Adding LEDs ===		=== Adding LEDs ===
	~~(more photos coming soon)~~

	# To install LEDs, you'll need 3x 1.8mm LEDs and 3x 1000kΩ resistors.		# To install LEDs, you'll need 3x 1.8mm LEDs and 3x 1000kΩ resistors.
	#* ''Note:'' If you're planning on using green LEDs, it's probably better to use 470Ω resistors; otherwise they might be a little dim		#* ''Note:'' If you're planning on using green LEDs, it's probably better to use 470Ω resistors; otherwise they might be a little dim
Line 67:		Line 65:
	##take an LED, and put it through the small hole in the front of your switch, so that it pokes out the two metal holes on the back of the pcb.		##take an LED, and put it through the small hole in the front of your switch, so that it pokes out the two metal holes on the back of the pcb.
	##The longer leg should be facing the left side of the macropad. Look to the resistor image above to see the orientation the LEDs need to be installed.		##The longer leg should be facing the left side of the macropad. Look to the resistor image above to see the orientation the LEDs need to be installed.
			##*[[File:LED orientation.png\|253x253px]]
			##*after installation, it should look like this:
			##*[[File:Installed LED.png]]
			##As before, these can be soldered into place from the back

	== Instructions for Programming the makerspace macropad ==		== Instructions for Programming the makerspace macropad ==

Johnsonm3: formatting change

2024-05-21T02:16:18Z

formatting change

← Older revision		Revision as of 02:16, 21 May 2024
Line 26:		Line 26:


	* We’ll start by installing the switches! Take a switch and align the 4 pins with the holes on the pcb, and press into place. Repeat for all three switches.[[File:~~Switch placement~~.png~~\|center\|thumb~~\|400x400px~~\|This is how switches should be installed into the board! make sure pins aren't bent beforehand~~]]		*
	** Next, we’ll solder these into place [[File:Soldering_switches.png]]		*
			*
			* We’ll start by installing the switches! Take a switch and align the 4 pins with the holes on the pcb, and press into place. Repeat for all three switches. [[File:Switch_placement.png\|400x400px]]
			** Next, we’ll solder these into place
			** [[File:Soldering_switches.png]]
			*** To solder, put a little bit of solder into the hot iron, then rest the tip against both of the components you want to connect. After giving them a moment to heat up, slowly feed solder into the the components, until a cone shaped ring of solder surrounds the component.
			**** It's best to stop adding solder once the joint's sides have a concave shape; adding too much solder can lead to a brittle joint.
	*** For a full soldering tutorial, please watch this [https://www.youtube.com/watch?v=Qps9woUGkvI quick guide]		*** For a full soldering tutorial, please watch this [https://www.youtube.com/watch?v=Qps9woUGkvI quick guide]
	* Next, let’s install the rotary encoder		* Next, let’s install the rotary encoder
Line 43:		Line 49:
	**# To fully connect the controller to the board, you’ll also need to solder the 16 headers on the other side, like so:		**# To fully connect the controller to the board, you’ll also need to solder the 16 headers on the other side, like so:
	*# [[File:Soldering back of controller.png\|390x390px]]		*# [[File:Soldering back of controller.png\|390x390px]]
			*# Once you have all the connections soldered, the legs of the headers (on the back) should be trimmed. However, it's likely best to get firmware up and running beforehand, in case repairs need to be done.
	* Congratulations; that’s all the required soldering to get the board working! LEDs can also be added, but they are optional.		* Congratulations; that’s all the required soldering to get the board working! LEDs can also be added, but they are optional.
	* Now, you can follow the programming guide on the makerspace.cc wiki to get the code up and running!		* Now, you can follow the programming guide on the makerspace.cc wiki to get the code up and running!
Line 57:		Line 64:
	#* Note that direction does not matter for resistor installation		#* Note that direction does not matter for resistor installation
	#** [[File:Resistor installation.png\|433x433px]]		#** [[File:Resistor installation.png\|433x433px]]
			#Now, we'll add the LEDs; take care during this step, as the direction the LED is installed matters. The longer leg of the LED is positive and the shorter negative.
			##take an LED, and put it through the small hole in the front of your switch, so that it pokes out the two metal holes on the back of the pcb.
			##The longer leg should be facing the left side of the macropad. Look to the resistor image above to see the orientation the LEDs need to be installed.

	== Instructions for Programming the makerspace macropad ==		== Instructions for Programming the makerspace macropad ==

Johnsonm3: updated formatting

2024-05-21T01:31:35Z

updated formatting

← Older revision		Revision as of 01:31, 21 May 2024
Line 2:		Line 2:

	== Assembly instructions: ==		== Assembly instructions: ==
	Assembly instructions can be found [https://docs.google.com/document/d/1evz1lOS-nTeEMei8WJlVfmJ6C-Dw2esytz5mxuN_9Ek/edit?usp=sharing here]		Assembly instructions can also be found in a printable form [https://docs.google.com/document/d/1evz1lOS-nTeEMei8WJlVfmJ6C-Dw2esytz5mxuN_9Ek/edit?usp=sharing here]

	Welcome! This guide will show the steps for making a macropad (specifically the macropad rev3) from one of our kits!		Welcome! This guide will show the steps for making a macropad (specifically the macropad rev3) from one of our kits!
Line 25:		Line 25:


	~~=== Assembly ===~~

	* We’ll start by installing the switches! Take a switch and align the 4 pins with the holes on the pcb, and press into place. Repeat for all three switches.[[File:Switch placement.png\|center\|thumb\|400x400px\|This is how switches should be installed into the board! make sure pins aren't bent beforehand]]		* We’ll start by installing the switches! Take a switch and align the 4 pins with the holes on the pcb, and press into place. Repeat for all three switches.[[File:Switch placement.png\|center\|thumb\|400x400px\|This is how switches should be installed into the board! make sure pins aren't bent beforehand]]
	** Next, we’ll solder these into place [[File:~~Soldering switches~~.png~~\|left\|thumb\|Soldering the switches into the circuit board~~]]		** Next, we’ll solder these into place [[File:Soldering_switches.png]]
	*** For a full soldering tutorial, please watch this [https://www.youtube.com/watch?v=Qps9woUGkvI quick guide]		*** For a full soldering tutorial, please watch this [https://www.youtube.com/watch?v=Qps9woUGkvI quick guide]
	* Next, let’s install the rotary encoder~~; this is part 4 on the image~~		* Next, let’s install the rotary encoder
	*# First, make sure to bend all the pins until they’re sticking straight out. They sometimes get bent in shipping :/		*# First, make sure to bend all the pins until they’re sticking straight out. They sometimes get bent in shipping :/
	*# Now, place the encoder into the top left of the pcb. One side has 3 pins and the other has 2, so be sure you’re putting the encoder into the side of the pcb with the correct number of ~~holesBe~~ careful to ensure that the encoder is sticking straight up (perpendicular to the circuit board).		# [[File:Bend pins.png\|412x412px]]
			*# Now, place the encoder into the top left of the pcb. One side has 3 pins and the other has 2, so be sure you’re putting the encoder into the side of the pcb with the correct number of holes. Be careful to ensure that the encoder is sticking straight up (perpendicular to the circuit board).
			# [[File:Seating the encoder.png\|321x321px]]
	*# Now, we can solder all 7 pins on the back of the encoder in place, just as we did for the switches!		*# Now, we can solder all 7 pins on the back of the encoder in place, just as we did for the switches!
	* At this point, we’re ready to solder in the controller. Start by putting 2 headers into the top right of the circuit board with the “long side” down.		* At this point, we’re ready to solder in the controller. Start by putting 2 headers into the top right of the circuit board with the “long side” down.
	*# Now, you can place the controller itself (the purple board) onto these headers. '''Make sure that the usb port faces away from the encoder!''' It should look like this:		** [[File:Putting in headers.png\|362x362px]]
	*# Now, solder all 16 points on this side. It should look something like this: '''''(though your board will have switches)'''''		**# Now, you can place the controller itself (the purple board) onto these headers. '''Make sure that the usb port faces away from the encoder!''' It should look like this:
	*# To fully connect the controller to the board, you’ll also need to solder the 16 headers on the other side, like so:		*# [[File:Controller in place.png\|285x285px]]
			**# Now, solder all 16 points on this side. It should look something like this: '''''(though your board will have switches)'''''
			*# [[File:Soldered from top.png\|417x417px]]
			**# To fully connect the controller to the board, you’ll also need to solder the 16 headers on the other side, like so:
			*# [[File:Soldering back of controller.png\|390x390px]]
	* Congratulations; that’s all the required soldering to get the board working! LEDs can also be added, but they are optional.		* Congratulations; that’s all the required soldering to get the board working! LEDs can also be added, but they are optional.
	* Now, you can follow the programming guide on the makerspace.cc wiki to get the code up and running!		* Now, you can follow the programming guide on the makerspace.cc wiki to get the code up and running!
	*# If you’d like to tweak or optimize the code, feel free! The source code can be found here.		** If you’d like to tweak or optimize the code, feel free! The source code can be found [https://github.com/Marshall-J2698/Makerpad here].

			=== Adding LEDs ===
			(more photos coming soon)

			# To install LEDs, you'll need 3x 1.8mm LEDs and 3x 1000kΩ resistors.
			#* ''Note:'' If you're planning on using green LEDs, it's probably better to use 470Ω resistors; otherwise they might be a little dim
			# Start by bending the resistors to a U-shape; they should look like this
			#* [[File:Bend the resistors.png]]
			# Then install them into the holes next to each switch and solder them into place.
			#* Note that direction does not matter for resistor installation
			#** [[File:Resistor installation.png\|433x433px]]

	== Instructions for Programming the makerspace macropad ==		== Instructions for Programming the makerspace macropad ==

Johnsonm3: /* Assembly instructions: */

2024-05-17T20:59:02Z

Assembly instructions:

@@ Line 3: / Line 3: @@
 == Assembly instructions: ==
 Assembly instructions can be found [https://docs.google.com/document/d/1evz1lOS-nTeEMei8WJlVfmJ6C-Dw2esytz5mxuN_9Ek/edit?usp=sharing here]
 == Instructions for Programming the makerspace macropad ==

Johnsonm3: /* Instructions for Programming the makerspace macropad */

2024-05-17T19:57:51Z

Instructions for Programming the makerspace macropad

← Older revision		Revision as of 19:57, 17 May 2024
Line 1:		Line 1:
	[[Category:Tutorials]]		[[Category:Tutorials]]

			== Assembly instructions: ==
			Assembly instructions can be found [https://docs.google.com/document/d/1evz1lOS-nTeEMei8WJlVfmJ6C-Dw2esytz5mxuN_9Ek/edit?usp=sharing here]

	== Instructions for Programming the makerspace macropad ==		== Instructions for Programming the makerspace macropad ==
	<u>'''If you just made your macropad, you'll need to flash it with the firmware.'''</u>		<u>'''If you just made your macropad, you'll need to flash it with the firmware.'''</u>

Muraharin: /* Instructions for Programming the makerspace macropad */

2024-02-23T19:24:05Z

Instructions for Programming the makerspace macropad

← Older revision		Revision as of 19:24, 23 February 2024
Line 3:		Line 3:
	<u>'''If you just made your macropad, you'll need to flash it with the firmware.'''</u>		<u>'''If you just made your macropad, you'll need to flash it with the firmware.'''</u>

	# download the arduino IDE		# download the [https://www.arduino.cc/en/software arduino IDE]
	# In the arduino IDE, go to tools->boards->board manager. Then search esp32 and install the library made by arduino		# In the arduino IDE, go to tools->boards->board manager. Then search esp32 and install the library made by arduino
	# Then go to tools->manage libraries then install the following:		# Then go to tools->manage libraries then install the following: