Macropad

Instructions for Programming the makerspace macropad

If you just made your macropad, you'll need to flash it with the firmware.

1. download the arduino IDE
2. In the arduino IDE, go to tools->boards->board manager. Then search esp32 and install the library made by arduino
3. Then go to tools->manage libraries then install the following:
   1. ArduinoJson
   2. StringSplitter
4. press select board, esp32, and select esp32S2 Dev Module
5. go to the 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).
6. 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.
7. Go to tools->port->then select the one with esp32
8. now press the upload button! (it's the right-facing arrow, in the top left)

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

1. press down key 1 (the left key) and the encoder knob at the same time, until key 1 stops sending keypresses
2. after ~5seconds, pressing key 1 should cause an address to be typed in; specifically 192.168.1.1
3. 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)
4. open any web browser (while connected to this network) and type in the address 192.168.1.1 (or just press key 1)
5. this should take you to the programming page! now, enter in what you want each key to do, and press submit!

A few notes on configuring the keys:

• With the default firmware, the 3 main keys are set up to do basic keyboard functions and the volume knob does media controls. You can't mix and match functionality between these two groups without manually editing the firmware
• to input modifiers (ie. shift, control, alt), you have to use a strange format
  • Shift = KEY_LEFT_SHIFT, Alt = KEY_LEFT_ALT, Control = KEY_LEFT_CTRL
  • put whatever modifiers you want at the start of your macro, and seperate them with "+++" from the rest of your input
    • for example to send "ctrl+shift+t" I would input: KEY_LEFT_CTRL+++KEY_LEFT_SHIFT+++t
    • modifiers must be at the start of the sequence: KEY_LEFT_CTRL+++t+++KEY_LEFT_SHIFT will not work
• 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