There are two different options for mechanical keyboard open source firmware for ANAVI Macro Pad 10, Knobs 3, and Knob 1: KMK and QMK. Both of which have been getting upgrades recently!
KMK is a feature-rich and beginner-friendly open source firmware for mechanical keyboards, written in CircuitPython, which comes preloaded on the Macro Pad 10 and Knobs 1 and 3. The source code is available on GitHub under the GPLv3 license. So… if you have code suggestions to make it better, just open a GitHub pull request. This is exactly what Stefan Misch recently did, by improving the encoder resolution.
ANAVI Macro Pad 10, ANAVI Knobs 3 and ANAVI Knob 1
Huge thanks to Stefan for his valuable contribution to the upstream of KMK! If you own Macro Pad 10, Knobs 3, and Knob 1, please consider upgrading the KMK firmware on your mini mechanical keyboard to get his fix.
In other news: the GitHub pull request that adds support for ANAVI Knobs 3 was finally merged in QMK! QMK stands for Quantum Mechanical Keyboard. It is probably the most popular firmware for mechanical keyboards and supports literally hundreds of devices, including ANAVI Macro Pad 8 and our other mechanical keyboards. The source code is available under GPLv2 license and written in C. Initial support for the Raspberry Pi RP2040 microcontroller in QMK was added in September 2022. We started the porting efforts in October, and shortly after that, patches for ANAVI Macro Pad 10 and Knob 1 were merged. However, it took almost 6 months to merge the GitHub pull request for ANAVI Knobs 3. The long wait is over: now all of our mini mechanical keyboards are supported by QMK!
ANAVI Knobs 3
The community is very important and makes all the difference in any open source project. Thank you for supporting and improving our open source hardware mechanical keyboards!
As part of the covered stretch goals, each kit will include stickers from ANAVI Technology and KiCad, the free and open source CAD software used for designing the printed circuit boards of the keyboards. Furthermore, ANAVI Macro Pad 10 kits will include 32 super-cool emoji stickers. You can stick them on the top or sides of the translucent keycaps. Last but not least, we’ll be publishing various video tutorials to ensure getting started is easy.
One more thing… Recently, our mini mechanical keyboards were featured in an article by CNX Software. This is a very popular website with news and tutorials about embedded systems, makers, and open source hardware. It was started in 2010 by Jean-Luc Aufranc. By the way it is worth keep an eye on CNX Software because there are always news about interesting gadgets!
Meet ANAVI Macro Pad 2! It is an open source, programmable two-key mechanical keypad with backlighting. Each of the keys on ANAVI Macro Pad 2 can be reprogrammed for use as a macro or even as a dedicated shortcut key, making it perfect for a number of applications across various industries.
ANAVI Macro Pad 2
ANAVI Macro Pad 2 runs on a Microchip ATtiny85, which is a reliable, low-cost, 8-bit AVR RISC-based microcontroller. It has a gold-plated printed circuit board, Gateron red mechanical switches, 3mm red LEDs and translucent keycaps.
Gateron red mechanical switches with 3mm LEDs on ANAVI Macro Pad 2
Only free and open source software tools like KiCad, OpenSCAD, and Inkscape were used to design ANAVI Macro Pad 2. Quantum Mechanical Keyboard (QMK) with V-USB is the default open source firmware. Source code and schematics are available on GitHub.
ANAVI Macro Pad 2 with stickers on the translucent keycaps of the mechanical switches
In a previous update we shared the exact steps how to assemble ANAVI Macro Pad 8 Developer Kit. Now let’s have a look at the Maker Kit.
ANAVI Macro Pad 8 Maker Kit Soldering and Assembly Video Tutorial
The maker kit provides the printed circuit board (PCB) and an addressable LED strip. There are also some nice stickers. Other accessories have to be purchased separately. You can use any mechanical switches compatible with Cherry MX plate footprint and 3mm LEDs.
ANAVI Macro Pad 8 Maker Kit Unboxing
Furthermore with the maker kit you can perform a hot-swap upgrade of ANAVI Macro 8. It requires a very specific procedure which was explained in a previous article. If you have this in mind don’t solder anything and have a look at the other video tutorial.
Required tools for soldering of ANAVI Macro Pad 8 Maker Kit
The assembly of ANAVI Macro Pad 8 Maker Kit requires soldering and advanced skills. The following tools are required:
Soldering iron
Scissors
Optionally: screwdriver, tweezers and a keycap puller
It is also a good idea to stay safe and get a smoke absorber while soldering, for example our open source ANAVI Fume Extractor.
Please have a look at the video and follow the steps below if you have ANAVI Macro Pad 8 Maker Kit.
Solder mechanical switches to the PCB
Any type of mechanical switch compatible with Cherry MX plate footprint is suitable for ANAVI Macro Pad 8. The developer kit comes with Gateron mechanical switches. The maker kit allow you to use different brand and color.
Choosing the most appropriate switch for your needs and taste is a matter of personal preference. There are many different brands and colors. For example, the blue mechanical switches are more noisy which could be sometimes fun but also annoying during daily work. The red switches are fast and not very noisy therefore they are often proffered by gamers.
There are two pins on each mechanical switch that must be soldered to the printed circuit board. That makes 16 pins in total. The position of the each pin is very specific and the switch goes into the PCB. One of the pins is for the signal coming from the Microchip ATmega32U4 microcontroller, the other pin is for ground.
Solder 3mm LED
This step is actually optional depending on the the type of the mechanical switch. Some mechanical switches may not have a hole in the plastic enclosure for a 3mm LED.
Each 3mm LED for through-hole soldering has 2 legs. The longer leg is the positive terminal, also known as anode. The shorter leg is negative and also known as cathode.
The shorter leg that indicates the negative terminal must go into the square hole of the PCB. ANAVI Macro Pad 8 has 8 mechanical switches therefore 8 LEDs are required. If you want you can use different color of the LEDs. You can even mix colors.
Solder WS2812B addressable LED strip to the back of the PCB
Using scissors cut a little bit from both ends of the LED strip to make sure it will stretched when placed on the board. However it is tricky, be careful and make sure enough from the pads are available to make a good contact after soldering them.
It is very important to properly set the direction of the WS2812B LED strip. On the LED strip you will notice small arrows indicating the direction. They should point from the microUSB connector towards the other end of the PCB as shown in the video.
If you have successfully completed these 3 steps your ANAVI Macro Pad 8 should look just like a developer kit having all accessories soldered. Therefore the next steps are the same as for both the developer and the maker kit. Explore them at our previous blog post as well as in the user’s manual.
Thank you for using ANAVI Macro Pad 8 and for supporting this entirely open source project!
Out of the box, all kits of ANAVI Macro Pad 8 are powered by the popular open source QMK firmware.
ANAVI Macro Pad 8
QMK stands for Quantum Mechanical Keyboard and it is an open source community centered around developing various computer input devices. The project is hosted in GitHub. More than 1700 developers contributed to this open source firmware over the years. QMK supports more than 2000 keyboards and keypads brands.
Although QMK is very powerful and flexible, it might be a challenge to get used to it if you haven’t used it before. Over the next weeks and months, as part of efforts for increasing the documentation related to ANAVI Macro Pad 8, we will be rolling out updates related to QMK.
QMK Configurator loaded in a web browser with the default keymap for ANAVI Macro Pad 8
QMK offers several options to select, customize and flash a keymap for your keyboard:
Command-line interface – advanced but not very user friendly
QMK Toolbox – application for MacOS and Windows users
QMK Configurator – an online tool used for easily creating firmware files for keyboards supported by QMK.
You can use QMK on MS Windows, MacOS and GNU/Linux distributions. To get started with the QMK firmware please explore this tutorial from the official documentation and install all required software suitable for the operating system on your PC.
KiCad – free software suite for electronic design automation which as used to design ANAVI Macro Pad 8,
Kodi – for the free and open source media player application,
OBS – for the popular open source video recording and live streaming software,
Zoom – for the popular video communication software.
Over the time we plan to extend the list with keymaps for other popular software applications. Please feel free to submit your favorite keymaps for ANAVI Macro Pad 8 to the QMK repository in GitHub!
Compile QMK for ANAVI Macro Pad 8
After installing QMK software on your computer, from the command line you can compile QMK firmware with the default keymap for ANAVI Macro Pad 8 using the following command:
qmk compile -kb anavi/macropad8 -km default
Flash QMK on ANAVI Macro Pad 8
Follow the steps below to flash the compiled QMK firmware to ANAVI Macro Pad 8:
Connect ANAVI Macro Pad 8 to your personal computer with USB to micro USB cable
Execute the following command in a terminal to flash the default keymap:
qmk flash -kb anavi/macropad8 -km default
Press the RESET button on ANAVI Macro Pad 8 when asked:
Detecting USB port, reset your controller now.....
Wait until the firmware flashes successfully:
avrdude done. Thank you.
The heart of ANAVI Macro Pad 8 is Microchip ATmega32U4. It is an 8-bit microcontroller part of the AVR family. QMK relies on avrdude as the utility to download, upload and manipulate the firmware of these microcontroller.
Microchip ATmega32u4 on ANAVI Macro Pad 8
ANAVI Macro Pad 8 is available at our distributors Crowd Supply and Mouser. Please contact us if you are interested in wholesale orders or if you prefer shipping directly from the EU.
Recently we shipped ANAVI Macro Pad 8 kits to Crowd Supply warehouse. Crowd Supply team will start shipping them to you soon to backers of the crowdfunding campaign. Furthermore kits will be available on sale at both Crowd Supply and Mouser.
A fully loaded courier truck with huge quantity of ANAVI Macro Pad 8 kits travelling to the warehouse
ANAVI Macro Pad 8 is an open source, custom-programmable, mini 8-key mechanical keyboard. Fully compatible and running the popular Quantum Mechanical Keyboard (QMK) open source firmware.
ANAVI Macro Pad 8 – the open source hardware 8% (8-key) mechanical keyboard
ANAVI Macro Pad 8 is made in Plovdiv, Bulgaria, EU. Here we write with a Cyrillic alphabet so if you are wondering what is the strange looking text on the parcel’s red labels – it is the word for fragile in Bulgarian 🙂
Fragile in both English and Bulgarian
Keep in mind ANAVI Macro Pad 8 is indeed fragile and please be gentle with the mini OLED display while assembling your kit.
USB to microUSB cable is not included in any of the kits. Pick a cable that suits you best or recycle a cable, for example from an old smartphone. Please be careful when plugging the cable and make sure it doesn’t bend as this may damage the microUSB connector on ANAVI Macro Pad 8.
Huge thanks to all people who supported the project by placing an order during the crowdfunding period at Crowd Supply. If you missed the crowdfunding campaign you can still order ANAVI Macro Pad 8 from our distributors right now!
ANAVI Macro Pad 8 is an open source, programmable, eight-key keypad with backlighting, underlighting, and OLED screen. Following the successful crowdfunding campaign we manufactured the printed circuit boards in a small local factory in Plovdiv, Bulgaria, EU. We would like to explain in detail the whole manufacturing process.
The fabrication includes a procedure called panelization which groups together a number of PCBs on a larger board called a “panel”. In the case of ANAVI Macro Pad 8 the “panel” contains 3 boards. All of them are gold plated through electrolytic nickel-gold process. Gold is very expensive, especially at the moment, but it is still worth it. Gold-plated PCBs have excellent quality with high hardness, wear and oxidation resistance.
A panel with 3 printed circuit boards for ANAVI Macro Pad 8
Sourcing parts in the COVID-19 time is a challenge but we work with trusted and reliable suppliers. We bought Microchip ATmega32U4 microcontrollers from Mouser. They arrived from the warehouse in Texas, USA. Each microcontroller is with TQFP-44 package that requires surface mount technology (SMT). The local factory has already assembled them alongside with all other SMT components.
The assembly of Gateron red mechanical switches and the red 3mm LEDs for all developer kits requires through-hole technology, a.k.a. manual soldering. This is a time consuming process. To simplify the work and to keep the mechanical switches on their places we created this plate that matches the size of the panels.
There are special holes on each mechanical switch for the 3mm LED. After soldering all of them, the leads of the LEDs have to be cut from the back side of the panel.
After all these steps, testing and packaging the developer kit will not require any soldering. However, people who enjoy soldering like me can order a maker kit and experiment with various mechanical switches and 3mm LEDs with different colors. Furthermore, the maker kit allows to perform a hot-swap upgrade as explained in the previous post.
After burning a the same bootloader as in Arduino Leonardo, flashing the open source QMK firmware and testing our mechanical keyboards are ready for packaging!
ANAVI Macro Pad 8 Developer KitANAVI Macro Pad 8 Maker Kit
Hot-swappable mechanical keyboard allows you to replace switches and LEDs on the go without soldering and without even powering off the keyboard. In this short video tutorial I explain how to make hot-swappable any printed circuit board for a mechanical keyboard with footprints for Cherry MX plate switches. Other brands such as Gateron and Kaihl are compatible with the Cherry MX switches so this solutions is universal.
Hot-Swappable Sockets for DIY Mechanical Keyboard
The video has been created with a maker kit of the open source mechanical keypad ANAVI Macro Pad 8. I have customized it by adding holtite sockets to make it hot-swappable.
Required Hardware
Appropriate printed circuit board (for example for ANAVI Macro Pad 8 maker kit)
Mechanical switches
3mm LEDs which are optional depending on the type of the PCB and the switches
ANAVI Macro Pad 8 with holtite sockets for hot-swap of Cherry MX and Gategron mechanical switches
Step 1
Using the tweezers place the holtite sockets into the PCB. The sockets are small so be careful not to lose any of them. Turn on the soldering iron. Heat each socket and gently push it. So we are using a soldering iron but in this case not for soldering. We are just mounting the sockets using its heat.
It looks easier than it is. It took me some time to do it for all switches and LEDs. Each key has 2 holes for the switch and 2 holes for the LED so basically you need 4 sockets with appropriate sizes for each key.
Step 2
Next step is optional and specific for ANAVI Macro Pad 8. The maker kit includes WS2812B addressable LED strip which should be soldered on the back of side of the keyboard. Please note the arrow that indicates the direction of the LED strip and make sure you are placing it properly as shown in the video.
Step 3
Cut the legs of the 3mm LEDs to make sure they will fit well in the hot-swappable holtite sockets that we have already mounted.
Step 4
Assemble the switches, the LEDs and the key caps. Once you are done with steps 1 this is easy because you already have a hot-swappable printed circuit board for your mechanical keyboard.
Custom ANAVI Macro Pad 8 with blue Cherry MX switches and green 3mm LEDs for backlit
By default ANAVI Macro Pad 8 is with Gateron red switches, red LEDs and white translucent keycaps. However, in this case with the hot-swappable version I am experimenting primary with blue Cherry MX switches, green LEDs and dark translucent keycaps. I have purchased several different mechanical switches: Gateron Red, Cherry MX blue and Cherry MX brown. Please note that these particular Cherry MX brown switches in the video do not have slots for the 3mm LEDs.
Although in this video I am using the maker kit of ANAVI Macro Pad 8. The same approach with holtite sockets can be applied on any other PCB for mechanical keyboard with footprint for Cherry MX switches.
After the launch of the crowdfunding campaign we received a lot of positive feedback about ANAVI Macro Pad 8 and great ideas from the community. Based on the recommendations of several backers a new option has been recently added. Now you can order a maker kit with an extra add-on: Gateron red mechanical switches, translucent keycaps and 3mm red LEDs.
Gateron red mechanical switches with 3mm red LEDs and translucent keycaps
Basically with this optional add-on, you can get the same parts as in the developer kit, but not soldered. In some use cases, having all the parts in one package is a convenient option for advanced users with soldering skills. This way they don’t need to purchase separately the keycaps, the LEDs and the switches. Furthermore, they can still make advanced modifications before using them with ANAVI Macro Pad 8.
ANAVI Macro Pad 8 mechanical keyboard/keypad
As part of the stretch goals that the crowdfunding campaign has already met, all kits of ANAVI Macro Pad 8 will also include 32 transparent Emoji stickers to customize further the keycaps!
Translucent keycaps for mechanical keyboard with emoji stickers included in all ANAVI Macro Pad 8 kits
