https://github.com/mchilli/macropad
This is an Adafruit MacroPad script that allows you to manage your macros via a WebUI
https://github.com/mchilli/macropad
adafruit adafruit-macropad circuitpython macropad macropad-hotkeys macros rp2040
Last synced: 2 months ago
JSON representation
This is an Adafruit MacroPad script that allows you to manage your macros via a WebUI
- Host: GitHub
- URL: https://github.com/mchilli/macropad
- Owner: mchilli
- License: gpl-3.0
- Created: 2023-10-09T03:36:58.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-09-18T10:45:04.000Z (7 months ago)
- Last Synced: 2024-09-27T09:22:34.860Z (7 months ago)
- Topics: adafruit, adafruit-macropad, circuitpython, macropad, macropad-hotkeys, macros, rp2040
- Language: JavaScript
- Homepage: https://mchilli.github.io/macropad/
- Size: 1.77 MB
- Stars: 23
- Watchers: 3
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-macropad - Manage your MacroPad via a WebUI
README
# MacroPad by MCHilli
This is an [Adafruit MacroPad](https://www.adafruit.com/product/5128) script that allows you to manage your macros via a [**WebUI**](https://mchilli.github.io/macropad/).
---
#### Features:
- Make groups to organize your macros
- Groups can store more macros or groups
- Define encoder macros for different groups
- Choose colors for every single macro or group
- Up to about **400** key configs, depending on the size of the macros
- Save your configurations locally by downloading it as a JSON file
- Device settings:
- Choose a keyboard layout suitable for your language
- Set a display timeout to prevent burn-in
- Use a Unicode Font **(increases the font loading time)**
- Flip the rotation of the device by 180 degrees
- Adjust the LCD and LED brightness
#### Installation:
Flash circuitpython on to your macropad, following this [guide](https://learn.adafruit.com/adafruit-macropad-rp2040/circuitpython).
Then just extract the content of "[macropad-circuitpython-x.x.zip](https://github.com/mchilli/macropad/releases/latest/)" to your device.
Now just configure your macropad over the [WebUI](https://mchilli.github.io/macropad/):
`Connect` → select `MacroPad by MCHilli` → Create Macros → `Upload`
If you are happy with your configuration don't forget to `Store`! Otherwise your macros will not be saved on your MacroPad and will also not appear after rebooting your device!
#### Other Informations:
Your can enable the USB storage either by pressing the yellow blinking key (top, left) when plugging the device, enable it through the WebUI under "reboot" or you can set a macro with the device function "enable_usb".
To play **mono** audio files such as .mp3 or .wav, place them on the macropad and define the path to the file in the WebUI. The available files are listed in the macro after the connection has been established. Keep in mind that the macropad is blocked during playback. So make sure that the sound files are not too long!
#### Ideas:
- Further translations for the WebUI. If you want to help me there is a template.json in the "lang" folder
- You tell me, feel free to contribute
---
#### Browser limitation:
The script use the [Web Serial API](https://developer.mozilla.org/en-US/docs/Web/API/Web_Serial_API) for communication. The only browsers that currently support this API are _Chrome_, _Edge_ and _Opera_, so unfortunately you'll have to use one of them.
#### Used libraries and icons:
- [SortableJS](https://github.com/SortableJS/Sortable)
- [Font Awesome](https://fontawesome.com/)