dekunukem / duckypad

Do-It-All Mechanical Macropad

duckyPad: Do-It-All Mechanical Macropad

Get duckyPad | Official Discord | Getting Started | Table of Contents

---

duckyPad is a 15-key mechanical macropad that helps consolidate & speed up workflow by automating keyboard (and mouse!) inputs.

duckyPad has all the goodies of a high-end mechanical keyboard:

• Mechanical switches
• Hot-swap
• RGB
• USB-C
• Open-source

More crucially, it also features innovations such as:

• OLED screen showing what each key does
• Sophisticated multi-line scripting with duckyScript
• 32 profiles of 15 keys, 480 macros total.
• Automatic profile switching based on active window.
• microSD card storage, move between devices without losing macros.
• No driver needed, works out-of-box on anything that supports USB keyboards.

When pressed, each key execute duckyScript to automate keyboard actions.

It can be as simple as shortcuts like Control + C, or as complex as launching applications, managing livestreams, or even creating root backdoors or grabbing passwords. It's all up to you!

Get a duckyPad!

duckyPad is now available on Tindie, feel free to grab one there!

And thanks to the interest and support from the amazing people like you, the Kickstarter campaign has been a great success!

Join Our Discord!

Feel free to join our Official Discord for discussions, questions, sharing scripts, and latest updates!

Highlights

• 15 Mechanical Switches
• Hot-Swap Sockets
• Per-Key RGB Lighting
• OLED Screen showing profile and key names.
• Powerful multi-line scripting with duckyScript
• 32 profiles of 15 keys, 480 macros total.
• Automatic profile switching based on active window
• microSD storage
• USB-C Connector
• Works with all major OSs, no driver needed.
• Multiple keyboard layouts (French, Belgium, German, Dvorak, etc)
• Fully Open Source!

Showcase

By automating frequently-used actions with duckyPad, you can streamline and speed up your everyday routine.

Here are a few examples:

Launching Applications

You can set up duckyPad to open your favourite app with the press of a button:

Managing Livestreams

With the press of a key, you can switch scenes, start/stop stream, start/stop recording, play ads, and a lot more!

Security Research

With the ability to automate keyboard inputs, it is possible to take over an entire computer with the push of a button.

This is known as BadUSB attack, and it was the original purpose of USB Rubber Ducky.

But of course, it's up to you to decide what to do!

Photoshop / CAD

You can put all your shortcuts in one place, resulting in a more efficient workflow:

One-finger Twitch Chat

Switching Profiles

With all the potential usages, duckyPad supports up to 32 profiles.

Simply press the +/- button to switch between them, or use the profile autoswitcher to switch automatically based on current active window.

... and more!

Those are just some examples! You can use duckyPad to do whatever you want!

Features

Mechanical Switches

duckyPad is compatible with Cherry MX-style mechanical switches (3 or 5-pin).

duckyPad comes with Gateron Green or Kalih BOX Navy switches, both of which are firm and clicky.

Of course, you can also install your own switches!

Keycaps

By default, duckyPad comes with blank translucent ABS R4 keycaps:

Of course, you can also install your own!

Hot-swap Sockets

duckyPad supports hot-swapping with Kailh sockets.

You can install/remove the switches by hand, no soldering needed.

Per-key RGB backlight

Each key on duckyPad has its own RGB backlight. You can assign unique colours to suit your needs.

OLED screen

duckyPad has an OLED screen. It displays current profile and key names, so you know what each key does at a glance.

• 1.3-inch blue OLED display
• High contrast with true OLED black
• 128 x 64 resolution
• Burn-in prevention

duckyScript

duckyPad uses duckyScript for keyboard automation. It was originally developed for USB Rubber Ducky.

duckyScript is powerful but also easy and straightforward to write.

A simple example look like this:

CONTROL SHIFT ESC

Now when you press a key on duckyPad, it will bring up the Task Manager, no need for memorising and pressing a 3-key combo.

Of course, duckyScript can do much more!

Here is a more complex multi-line example that open up notepad, types "Hello world", and increases text size:

WINDOWS R
DELAY 400
STRING notepad
ENTER
DELAY 400

STRING Hello World!
CONTROL +
REPEAT 10

Companion App

duckyPad comes with a companion app for Windows 10, macOS, and Linux. You can use it to:

• Manage profiles
• Manage key names, colours, and arrangements.
• Write, debug, and test-run duckyScript.
• Change, save, and backup configurations.

But more importantly, duckyPad app respects your privacy:

• Fully open-source
• No need to create an account
• No data collection whatsoever
• No internet connection required
• You don’t even have to use it! You can set up your duckyPad manually.

USB-C and Device Compatibility

duckyPad uses USB-C connector for maximum device compatibility.

You can use duckyPad out-of-box on pretty much anything that supports USB keyboards, no driver needed. Examples include:

• PC
• Mac
• Linux
• Raspberry Pi
• iPhone / iPad
• Android phones and tablets
• Chromebooks
• Game consoles

duckyPad’s firmware can also be easily updated via USB-C for new features and bug fixes.

Keyboard Layouts

duckyPad supports multiple keyboard layouts:

• English (US)
• French
• Belgium
• German
• Dvorak
• ...and more user-created layouts!

Dimensions

Click me for vector files of front and back plates.

Click me for dimensions drawings.

I want one!

duckyPad is now available on Tindie!, feel free to grab one there!

Also consider joining our discord for latest updates and discussions.

Press Kit / More Photos

Click me to download some high-resolution photos of duckyPad, feel free to share them.

Getting started

Please see the instruction manual on how to use your duckyPad.

Making one yourself

Please see this guide.

Derivatives

A number of projects are based on duckyPad, they are listed here!

• simonCor ported this project to a STM32F4 black pill, with hand-soldered connections and 3D-printed case, very neat!

• headslash is working on Frankenduck, with redesigned PCB, 3D-printed case, and extra switches.

Table of Contents

Main page

Getting Started Guide

Kit Assembly Guide

Using duckyScript | duckyScript 3 Info

Common issues / Troubleshooting

Firmware Updates and Version History

Make Your Own Keymap

Build a duckyPad Yourself

Kickstarter Backer Acknowledgments

Questions or Comments?

Please feel free to open an issue, ask in the official duckyPad discord, DM me on discord dekuNukem#6998, or email [e-mail] for inquires.

duckypad's Issues

Extend duckyscript for numpad keys

For one application I'm using, it would be useful to be able to send numpad digits as well as the regular digits (which I've been doing with e.g. STRING 1.
In https://github.com/keyboardio/Chrysalis this is keyCode 30 vs keyCode 89.
Would it be possible to add to the list of modifier keys NUMPAD_1 etc?
Thanks!

Single key port doesn't work (not bent pins)

I have a single key that doesn't work on the DuckyPad I recently received.

I double/triple checked for bent pins and swapped keys even. Decided to by-pass the whole "switch" and jump the contacts with a wire. I verified the working keys work with the contact jump method but the single key does not work that way.

Any insight on where to begin the next phase of debugging would be apricated.

Feature Request: onKeyDown and onKeyUp Functionality

Being able to control how long keys are held down and when they are released would be incredibly useful for automating actions in games, where you typically need to hold down a key to get things done.

This is the only feature that I found was missing from DuckyScript that was present on other mainstream keyboards with macro functionality.

The DEFAULTCHARDELAY command does this to some extent, but isn't capable of holding a key as a toggle, which could be implemented with onKeyDown, onKeyUp, and the existing LOOP function.

Switching profiles from DuckyScript

I'd be interested in having a DuckyScript command that switches profiles. This would be useful for a setup with "menu" profiles, where keys can be used to quickly jump between profiles.

duckypad configurator 0.13 Linux compatibility

Hi i just tried the configurator on linux.

It almost works. The only problem is, that you use the color name "SystemButtonFace".

This is not available on Linux. Therefore the only thing you have to be linux compatible is either replace by e.g. "grey" or use a os switch on linux.

Regards

switch plate thickness

Hi, I'm trying to build a kbord, how thick material should I use when making the switch plate?

And I noticed that you changed the model of oled in version 2, but the new model was not described in the bom, which made me buy the wrong oled. After I got the parts, I found there was a problem, and I didn't know the information of the new oled until I came back to see issues. So I hope to add a description of the new oled in the bom so that the people behind will not make mistakes again. Thank you.

Bug in dpkm_german.txt

Hi,
I had some issues with the character ö and the german keyboard layout. It seems to be a little bug in line 260 of the dpkb_german.txt.

duckyPad/sample_profiles/keymaps/dpkm_German.txt

Line 260 in 5889e75

0xf6 0x5012 // ö

The correct duckcode for 0xf6 should be 0x0033, as it is a standad character of the german keyboard layout.
May you'd like to update it in the next version.

And by the way, thanks for this really cool project!

Edit
Some typos

Config App on macOS

On macOS you use 'WINDOWS' for 'cmd' key and 'ALT' for 'Option'.

However, in the config app, neither of these trigger the correct key when tested. If the scripts are saved and the script triggered from the pad itself, it works fine.

So this is just the config apps test feature. May be worth adding a note to the readme to that effect. Certainly not the end of the world!

LOOP not running ENTER after all cases exhausted

Here is my test loop:

LOOP0:
STRING first action
STRING FOO
DELAY 500
ENTER
SWCOLOR 128 0 0

LOOP1:
STRING second action
STRING BAR
DELAY 500
ENTER
SWCOLOR 0 128 0

The first LOOP0 and LOOP1 run correctly and swap color.
After the first "loop" no ENTER are inputed.
The SWCOLOR is runned however.

output:

first actionFOO
second actionBAR
first actionFOOsecond actionBARfirst actionFOOsecond actionBAR

The script was saved from configurator 0.9.0 on windows and tested on Windows 10 and MacOS 11.1.

Dimming the Lights

Is it possible to dim the lights on the duckyPad?

Difficulty updating firmware on Mac

Similar to #45, but I am using the correct path.

$ dfu-util --device ,0483:df11 -a 0 -D ~/Downloads/duckypad_v0.16.0.dfu
dfu-util 0.10

Copyright 2005-2009 Weston Schmidt, Harald Welte and OpenMoko Inc.
Copyright 2010-2020 Tormod Volden and Stefan Schmidt
This program is Free Software and has ABSOLUTELY NO WARRANTY
Please report bugs to http://sourceforge.net/p/dfu-util/tickets/

dfu-util: No DFU capable USB device available

I followed the DFU boot instructions. But the dfu-util doesn't see it at the address in the command provided. I don't know how to find it.

When I boot normally, there is no attached ducky, so I don't know where to direct the configurator to test any change. Am I supposed to do this with the micro sd reader? the leds respond when I press keys, but even characters like numbers and letters do not type. I would like to update the firmware to see if that fixes it.

difficulty updating firmware on mac

I have tried to follow the guide but I have been unable to get the new firmware working and would really appreciate some help.
I have used Brew to download by running 'brew install dfu-util' in terminal. That appeared to work. I have downloaded the new firmware to the desktop and to the micro sd card. When I past the command into terminal for the update I get the following error message:
dfu-util: Could not open file /path/to/duckypad_firmware.dfu for reading: No such file or directory

Should i be saving the new firmware to somewhere different? Any ideas?

Thank you

HOLD key to switch profile and return to current on release

I'd like to turn one of my keys in a profile into a modifier key of sorts. What I'd like to do is to turn the bottom right button into a press and hold button that then switches to a new profile that returns to the original profile on release. Additionally, while I'm holding that modifier key I'd like to press another key from that new loaded profile and have it do its intended action.

My use case:
First profile has a set of window resize options (pretty much all filled). The next profile is an extension of the first, but can move windows to other screens, etc. Pressing the -/+ has been pretty inefficient for this type of use case.

Added bonus if this profile switch could be hidden from the menu screen and/or from the -/+ buttons. Ie. it can only be accessed by pressing the modifier key on the profile, but still editable in the duckypad configurator that includes a hidden input field.

Build details

Hi, i would like to try to build kbord. As i can see, version described in readme is different from current version of the board. So i have a few questions:

• Is current version of the board is working, or i should use version from specific commit?
• I noticed that now usb type-c used instead of micro, is there any other changes in BOM?
• I'm not a big fan of rgb, will the board work if i will just not solder them?

WS2812B footprint is not WS2812B compatible

Ran into this issue while trying to use the WS2812B LEDs:

The WS2812B 3535 footprint used in the design is only pin-compatible with SK6812MINI.
WS2812B 3535, WS2812B 5050, and SK6812 5050 share a common pinout, while the SK6812MINI is flipped.

WS2812B 5050 schematic: https://cdn-shop.adafruit.com/datasheets/WS2812B.pdf
WS2812B 3535 schematic: http://www.normandled.com/upload/201607/WS2812B%20Mini%203535%20LED%20Datasheet.pdf
SK6812 3535 schametic: https://cdn-shop.adafruit.com/product-files/2686/SK6812MINI_REV.01-1-2.pdf

some more details here: adafruit/Adafruit-Eagle-Library#42

p.s. Thanks for posting this great design!

Support for OpenRGB, possible feature request

I have been exploring OpenRGB for past few weeks after I found about it and I was wondering if it would be possible to add support for it in OpenRGB.

I know it's generally the other way around, you add support for the device to OpenRGB so I'm fine if you will decide this should go as feature request to OpenRGB, but I'm just wondering :)

As far as I've read (will test when I get the device) we could use QMK with DuckyPad and that supposed to work with OpenRGB? Anyone tried it?

Maybe we could collaborate somehow with OpenRGB to make DuckyPad supported out of the box?

Kind regards,
Michal

Instructions for flashing duckypad on macOS/linux etc

The duckypad can now be flashed from macOS using http://dfu-util.sourceforge.net/ which can be installed using https://brew.sh/

$ brew install dfu-util

hold DFU button & connect duckypad, then run:

$ dfu-util --device ,0483:df11 -a 0 -D /path/to/duckypad_v0.8.0.dfu

DuckyPad config v0.12.0 win10 failed to start

v0.11.0 working great, v0.12.0 doesn't start at all.

MENU sends wrong key codes

I assigned MENU to a key, but the expected context menu didn't work. I checked on Linux the key codes using showkey --scancodes

• On press: 0x1d 0x38 0x36 0xe0 0x38
• On release: 0x9d 0xb8 0xb6 0xe0 0xb8

I checked with another keyboard, and the menu key there results in the following key codes:

• On press: 0xe0 0x5d
• On release: 0xe0 0xdd

I also checked with libinput debug-events:

The menu key don the duckypad gave:

-event5   KEYBOARD_KEY     +22.833s	*** (-1) pressed
 event5   KEYBOARD_KEY     +22.833s	*** (-1) pressed
 event5   KEYBOARD_KEY     +22.833s	*** (-1) pressed
 event5   KEYBOARD_KEY     +22.833s	KEY_RIGHTALT (100) pressed
 event5   KEYBOARD_KEY     +22.977s	*** (-1) released
 event5   KEYBOARD_KEY     +22.977s	*** (-1) released
 event5   KEYBOARD_KEY     +22.977s	*** (-1) released
 event5   KEYBOARD_KEY     +22.977s	KEY_RIGHTALT (100) released

the real keyboard:

-event10  KEYBOARD_KEY     +27.588s	KEY_COMPOSE (127) pressed
 event10  KEYBOARD_KEY     +27.775s	KEY_COMPOSE (127) released

which brand and reference of smd oven you use in your project?

Dear @dekuNukem

which brand and reference of smd oven you use in your project?

Best Regards,
Youssef

HOLD multiple keys at the same time

Would it be possible to HOLD multiple keys at the same time?

My usecase is to use the pad as an OBS deck.
However when OBS is out of focus the input delay miss fire hotkeys and make it unreliable.

Inputing the hotkey by hand on the keyboard works so a more "natural/human" holding could work.

By using HOLD not the intended way it works once then will run the last HOLD.

HOLD CTRL
HOLD SHIFT
HOLD ALT
HOLD BACKSPACE

Doesnt turn on

I was leaving my macropad to chill and then it suddenly turned off. I tried plugging the USB-C connector to different slots and they all produced the same results. TLDR; it wont turn on.

Unexpected error

After fighting with the cheaper ST-link V2 i bought the proper one and can connect to the board. I see the memory of the STM32 and it is all blank, but when ever I try to program it i get a "unexpected error" and the board resets.

problems with the hex files?

Feature request: Editting the config while the SD card is in the duckypad

I would like to edit the configuration of the duckypad while the duckypad is connected to the computer.

This would save a lot of time: removing the card, putting the card in the reader, putting the reader in the laptop/computer, opening the configurator or config files, editting & saving, unmounting, removing the reader, removing the card from the reader, putting the card back in the duckypad and connecting the duckypad.

If all the physical work could be skipped by editting directly on the duckypad, it would be a lot easier. it might be possible to do this by putting the duckypad instead of on keyboard mode into disk mode. the original hak4 rubber ducky had a firmware update that allowed this. Maybe something similar could be done with the duckypad.

Option to put mechanical switches for the - and + button

The small switches are functional, but it could be awesome to be able to put mechanical switches too.

Rotary Encoders does not work.

I could not get rotary encoders to work. I believe its software related. Any help?

configurator unusable on high res displays?

configurator looks like this

Seems like lot of hard coded pixel values in the code. Adding size to these dimensions:

THIS_VERSION_NUMBER = '0.9.0'
MAIN_WINDOW_WIDTH = 800    # increase to 1500 eg
MAIN_WINDOW_HEIGHT = 600
MAIN_COLOUM_HEIGHT = 533

doesn't help.

LOOP: Lost of counter increment after waking up from sleep mode

Hey @dekuNukem

I received my DuckyPad from the Kickstarter campaigna few days ago and I am really excited. I only noticed one small problem:

Currently I using the experimental LOOP function to track if the button was pressed the first time or the second time. To trigger different actions each time.
Unfortunately I noticed that after the DuckyPad was in sleep mode, the counter for the loop starts again at 0 and does not keep the last value.

Is it possible to reload or keeping the old counter value for the loop after waking up?

Internationalization

duckyPad works fine - as long as you have an english keyboard layout. The problem is briefly discussed here: #5

The problem is, that the OS assumes a keyboard layout (and that the USB HID spec not just allows UTF-8). Therefore when e.g. a german keyboard layout is set, the scancodes are interpreted differently.

The keyboard firmware QMK has already a solution in place for this, see https://github.com/qmk/qmk_firmware/blob/master/quantum/keymap_extras/

It is a bit clumsy because then it is necessary to configure the layout used in the firmware but IMHO it is the most practicable solution.
I suggest to modify keyboard.c/.h and to port the QMK solution to duckyPad.

Any comments on that? Others already working on that?

Switching profile based on focused application

Hi, really cool project!

Wanted to ask if it is possible to switch the selected profile based on the active application?

A use case example:

As a programmer, I want duckyPad to be able to switch to a specific profile for VSCode snippets when I switch to VSCode, so that I can instantly have access to the macros that I need to insert snippets

More switches?

Hi, really apperatiate your work, adding OLED for displaying profile is fatastic.
But 15key is just not enough when using as a numpad. 4x5 should be a proper balace between minimal and functionality.
Do you consider adding more keys in the future version?
thanks

How to load firmware

In the video you show some jumpers on the header and a loading bar. Could you elaborate? I have build one and I've hit a wall on how to load anything on the chip. This is the first time I've programmed a chip outside of some Atmegas and I just use a arduino board with a socket.

User contributed scripts

Hey,
I just received my DuckyPad, it's awesome, thanks!

Is there a list of user contributed scripts? It would be nice to have somewhere where a list can be compiled so that we can get inspiration

Temporary layer keys

Would it be possible to add something that behaves like GOTO_PROFILE but it returns to the original layer after the next (subsequent) key press? This would let us emulate having something like QMK layers so that we could quickly switch between different groups of shortcuts for complicated apps that have a lot of shortcuts.

I'm thinking something like my IDE with a ton of complicated hotkeys. I would have a primary profile with the most common shortcuts, and on that maybe the bottom row of keys are mapped to swap to different profiles with more specialized commands. I could press a swap key and it would shift to the specialized profile, then I press the command I want and it would return to the original layer. This would be a very powerful addition, I think.

I know you're busy and thank you for all the work thus far!

Keys using HOLD getting stuck on

Having some issues with the HOLD functionality - if I hold for a brief period it works great, if I hold for a longer time it appears to key wedged on. It doesn't seem to be a mechanical issue - unplugging & replugging the duckypad resets it and the key is no longer held on. Using firmware 0.8.0.

EDIT: also happening with firmware 0.9.0

DuckyPad doesn't turn on almost all the time

My duckypad decided to just randomly turn off today and it won't turn back on. I unplugged it and plugged it back in, nada. I've tried a bunch of different cables but no luck. Except, it did flicker on for a second but then went back to not working again

EDIT - The macropad randomly decided to turn on while i had it sitting around plugged in but as soon as i tried to hit something, it blacked out again. After some more time, I figured out that the macropad only works when the cable is at a very very very very very very specific angle and I can't nail it. Might be a problem with the usb c port

I would like to order PCB's for this project

I'm trying to order PCB's so I can build this myself. I went to order through OSH Park but it says someone else owns the project files and has not shared them. Would you be able to share them so I can order them for print?

Thanks

One Key Doesn't Work

Middle key of the second row doesn't work.
Tested different profiles, no difference.

Please advise.

Purchase kit or maybe online bill of materials

Neat project!

Not a big fan of the LEDs but love the design.

Any chance of selling some kits with everything needed to make one?

I’d not - perhaps one of those fancy online sites where you could enter the bill of materials and people then links to a cart to buy the parts from somewhere?

Thanks!

Duckypad Configuration Tool thoroughly hangs windows explorer session it is launched from

I launch it and nothing happens. The windows explorer session it is launched in is totally locked up until I reboot my PC. I am using windows 10.

Any ideas please?

My Mac reboots when I open Configurator 0.10.0

My Macbook pro runs Mojave 10.14.6, and every time I try to open the Configurator 0.10.0, my Mac reboots. I've tried downloading the file again, but the same thing happened when I tried opening the Configurator.

SW color compatibility PC

Hi,

Is it possible to add coloroption to the PC configurator for the up and down key.
Python programming is a bit out of my leage, i got the code working in the STM, all i need is an output in the config file like:

SWCOLOR_16 255 255 255
SWCOLOR_17 255 255 255

i tried myself but failed miserably and should have taken a copy of my sd card first -_-

Link to BOM 404's

Please fix link or re-upload BOM.

MIDI controller?

Can the firmware be modified to make this a MIDI controller, sending MIDI over USB instead of keypresses?

Firmware Makefile?

I was wanting to make some firmware changes to clean up a few tiny things I noticed, but I don't
seem to be able to find a Makefile at the root of the firmware tree that would allow me to build
the code again.

Is it just not checked in? Any hints on how to rebuild the code would be appreciated.

kbord does not work if 3.3V pin not connected to STLink

I had a board made, flashed it using the instructions and I get nothing from connecting it to USB C, but if I connect the 3.3V Stlink pin, it works fine. What could be going on here?

DuckyPad configuration tool -> Windows button

The button in the config tool called WIN does add WIN to the key config.
It then says their is something wrong with the code, and in the docs is said that I need to type WINDOWS to send the windows key.

So I thing the button in the app can be called the same but should output WINDOWS.

ducky configurator 0.4.0 crashes on 10.14

Version 0.4.0 works fine on 10.15, but on 10.14 gives you a screen of static & logs out the current user. I haven't yet been able to dig out any logs, but will try & do so when possible....

DuckyConfigurator hangs when saving configuration files

When saving the data for the duckypad configuration on SD card, the DuckyConfigurator program hangs for quite a long time, up to half a minute. After this very long duration of saving configuration files, it returns back to normal. This happens even when the amount of 'pages' in the duckypad is very low (4-6).

Expected behaviour: Still functioning application during saving / Quicker saving of files

WIN10 home "Unknown USB Device"

Hallo,
after the update yesterday, windows doesn't like the duckypad anymore. In device manager the pad will be (not) recocgnized
as "Unknown USB Device (Device descriptor request failed)"
OS-Info
Version 2004
OS build 19041.867
Experience Windows feature experience pack 120.2212.551.0

Duckypad FW 0.16.0

Any ideas how to get it back to work ?
Thanks in advance