WARNING: these instructions are by no means complete, feel free to ask in the Discord Server if you encounter any problems. As we are still in early test stages.
Checkout the docker build script provided by
If you want the executable instead of compiling it yourself, download it here. Windows and Linux versions are available. Otherwise, follow the steps below:
- Install the latest stable
rusttoolchain using rustup
- Also install Visual Studio Community edition including the C/C++ module to prevent errors while compiling
- Download or Clone the AnnePro2-Tools project.
- Compile the tool using
cargo build --release
- The compiled tool should be in
./target/release/annepro2_tools(In later I will refer to this as
Hint: If you are on windows, I recommend completing this step using WSL. YMMV
Manually compiling the QMK firmware is emphasized because this is what you modify to customize the keyboard.
- Clone our fork of the QMK firmware by using the command below. (Install Git if needed)
git clone https://github.com/OpenAnnePro/qmk_firmware.git annepro-qmk --recursive --depth 1
- Obtain the
gcc-arm-none-eabitoolchain so you can build the project.
- To compile the firmware type
# For C15 Revision make annepro2/c15 # For C18 Revision make annepro2/c18
This should complete without any error. And you should be able to see a file named
annepro2_c15(18)_default.binin your directory. This is a compiled keymap profile. This will be flashed on your keyboard later. You can also see additional default and other user-made keymaps in the same directory. You can choose to flash one of these instead. For specific information on their differences, check their keymap.c file in
annepro2_c15(18)_default.bin has the exact same mapping as the default Obinskit, but with no caps-lock and layer indicators.
annepro2_c15(18)_default-full-caps.bin is the same as previous, but the keyboard changes to red LEDs to indicate caps-lock.
annepro2_c15(18)_default-layer-indicators.bin has the caps-lock indicator and it changes the LEDs to indicate what layer you’re on.
Check the customization page for more information on these keymaps and customizing your own keymap
- Put the keyboard into DFU/IAP mode by unplugging the keyboard, then holding ESC while plugging it back in.
- Run annepro2_tools with the firmware you just built.
Please substitute with the correct paths and correct bin file if you chose another keymap profile
If you have the C18 revision, you must specify the interface number.
annepro2_tools annepro2_c18_default.bin -i=[[interface_number]]
Replace [[interface number]] with the keyboard’s interface number.
If the tool reports can’t find device please double check you have the keyboard in IAP mode.
Interface number can be found by running the tool without the -i flag:
The tool lists the usb devices with their information. Search for the device with the
0x04d9:8009 vid pid pair:
HID Dev: 04d9:8009 if: [[interface_number]] Some("USB-HID IAP"). This is the keyboard.
If the tool doesn’t list the keyboard please double check you have the keyboard in IAP mode.
If you want the binary instead of compiling it yourself, download it here. Otherwise, follow the steps below:
Building the shine firmware is very similar to the QMK firmware.
- Checkout the repository using
git clone https://github.com/OpenAnnePro/annepro2-shine.git --recursive
- Build using
# for C15 make C15 # for C18 make C18 # for both make
- If built without error you can find the binary in
build/directory. You will flash the .bin file using annepro2 tools.
# --boot automatically restarts the keyboard into normal mode. Remove it if you are going to flash something else next. # for C15 annepro2_tools --boot -t led build/annepro2-shine-C15.bin # for C18 annepro2_tools --boot -t led build/annepro2-shine-C18.bin
With QMK installed, you can now easily switch to IAP mode by pressing
LSHIFT + RSHIFT + B. This will be useful for customizing your keyboard. Remember, you can always use the QMK docs for more info. Enjoy!
Having to type the previous commands to flash the firmware can be annoying and you might want a simple script that does it for you. The scripts below assume you have the script and firmware files in the same directory as the annepro2_tools.exe executable. They flash both the main firmware and annepro2-shine and automatically restarts the keyboard. Modify and change the filenames as needed.
Paste this script into a .bat file.
@ECHO OFF .\annepro2_tools.exe .\annepro2_c18_default.bin .\annepro2_tools.exe --boot -t led .\annepro2-shine-C18.bin pause
Paste this script into a .sh file. If preferred, make it executable by calling
chmod +x nameOfScriptFile.sh in the terminal.
#!/bin/sh ./annepro2_tools ./annepro2_c18_default.bin ./annepro2_tools --boot -t led ./annepro2-shine-C18.bin