{"id":17247439,"url":"https://github.com/x1unix/megadeck","last_synced_at":"2025-07-29T16:32:12.525Z","repository":{"id":86178241,"uuid":"354690066","full_name":"x1unix/megadeck","owner":"x1unix","description":"Custom StreamDeck-like clone using Arduino Pro Micro and RobotDyn keypad","archived":false,"fork":false,"pushed_at":"2021-04-05T07:32:59.000Z","size":196,"stargazers_count":4,"open_issues_count":0,"forks_count":1,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-04-05T15:35:18.622Z","etag":null,"topics":["arduino","streamdeck"],"latest_commit_sha":null,"homepage":"","language":"C++","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/x1unix.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null}},"created_at":"2021-04-05T02:00:31.000Z","updated_at":"2024-03-23T16:34:47.000Z","dependencies_parsed_at":null,"dependency_job_id":"83302dd9-f83a-418f-b786-6c3bf457712f","html_url":"https://github.com/x1unix/megadeck","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/x1unix/megadeck","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/x1unix%2Fmegadeck","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/x1unix%2Fmegadeck/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/x1unix%2Fmegadeck/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/x1unix%2Fmegadeck/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/x1unix","download_url":"https://codeload.github.com/x1unix/megadeck/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/x1unix%2Fmegadeck/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":267718279,"owners_count":24133448,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-07-29T02:00:12.549Z","response_time":2574,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["arduino","streamdeck"],"created_at":"2024-10-15T06:37:49.796Z","updated_at":"2025-07-29T16:32:12.211Z","avatar_url":"https://github.com/x1unix.png","language":"C++","funding_links":[],"categories":[],"sub_categories":[],"readme":"# MegaDeck\n\u003e Custom StreamDeck-like clone using Arduino Pro Micro and RobotDyn keypad\n\n![Preview](images/preview.jpg)\n\nConfigurable keypad that allows to assign custom macros to specified keys, like:\n\n* Type a text\n* Media control (playback, volume)\n* Press a sequence of keys (like ALT+SHIFT to change keyboard layout)\n* etc\n\nWorks on any OS without any drivers.\n\n## Requirements\n\n**Hardware**\n\n* [Arduino Pro Micro](https://learn.sparkfun.com/tutorials/pro-micro--fio-v3-hookup-guide/all)\n* [RobotDyn Keypad 4x4](https://aliexpress.ru/item/32635207928.html?spm=a2g0s.9042311.0.0.18fd33ed5mrU54)\n\n**Software**\n\nIn order to compile the firmware, you need **Visual Studio Code** with *PlatformIO* extension installed.\n\n## Development\n\n### Assembly\n\n**Pins**\n\nThis project heavily relies on interrupt feature, so I recommend to check supported interrupt pin on your board\nbefore project assembly.\n\nDefault keypad output pin is 8, which is defined by `KBD_PIN` constant in `main.cpp`.\n\n**Layout**\n\nIn this project, I used 8x8 keypad grid.\nKeypad button values are defined at [`/include/keypad.h`](/include/keypad.h).\n\nButton values may vary and depend on your board or keypad type.\n\n### Customization\n\nIn order to define custom macros, just modify switch statement in [`main.cpp`](src/main.cpp) and build the project.\n\nSee [NicoHood's HID library](https://github.com/NicoHood/HID/wiki) docs for more information.\n\n**Example**\n\n```cpp\n switch (keyNumber) {\n      case MDKEY_1:\n        Keyboard.add(KEY_LEFT_SHIFT);\n        Keyboard.add(KEY_LEFT_ALT);\n        Keyboard.send();\n        Keyboard.releaseAll();\n        break;\n      case MDKEY_2:\n        Keyboard.println(\"Hello World!\");\n        break;\n      case MDKEY_3:\n        Consumer.write(MEDIA_PLAY_PAUSE);\n        break;\n    }\n```\n\n### Debugging \u0026 Troubleshooting\n\nThis firmware includes a special **Recovery Mode**.\n\nIf you faced some issue with your board (USB decriptior issue, board not flashable),\ntry to start the board in *Recovery mode*.\n\nIn this mode, HID (keyboard) and interrupts functionality which may cause any issues - will be disabled, so you can reflash \nany other sketch to revive your board.\n\n#### How to enter Recovery mode\n\n* Disconnect your Arduino from PC\n* Connect pin 2 to ground (GRD)\n* Connect back a board.\n\nIf you did everything right, you will see next message in serial console:\n\n```\n============= ! RECOVERY MODE ! =============\nUse this mode to reflash the board in case:  \n\n* Board does not respond to commands.        \n* Board's USB device descriptor errors.\n\nGood luck :)\n```\n\nNow, start Arduino IDE and flash any other sketch to replace the MegaDeck firmware.\n\n## Credits\n\n* [NicoHood's HID library](https://github.com/NicoHood/HID/wiki)\n* [EnableInterrupt library](https://github.com/GreyGnome/EnableInterrupt)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fx1unix%2Fmegadeck","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fx1unix%2Fmegadeck","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fx1unix%2Fmegadeck/lists"}