Skip to content
/ anne-key Public
forked from ah-/anne-key

Firmware for Anne Pro Keyboard written in Rust

License

Notifications You must be signed in to change notification settings

zer09/anne-key

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

78 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Firmware for Anne Pro Keyboard written in Rust

Travis Build Status

This is an alternative firmware for the Anne Pro Keyboard, with the goal of being more stable than the original firmware and adding extra features.

Status

This project is still under heavy development and probably not quite ready yet to serve as your only keyboard.

Working today:

  • Basic keyboard functionality
  • Bluetooth (as a keyboard)
  • LED control (switching on/off, changing themes)
  • USB charging
  • Drop in replacement as a simple firmware update

Not yet implemented:

  • USB
  • Bluetooth communication with the Anne Pro App
  • Media controls / special keys
  • Uploading custom lighting settings
  • Uploading custom keymaps
  • Power Management
  • BT setup mode with LEDs etc.

Community

We hang out in the Anne Pro discord. Please observe the Rust Code of Conduct within our community.

Documentation

There is some documentation on hardware here.

Flashing

You can find the latest build on the Releases page. Download anne-key.dfu.

Then you can either follow the obins firmware update steps (click Update manual) or use dfu-util.

dfu-util

First you'll need to install dfu-util.

To flash your Anne Pro connect via USB, then hold down the Esc button, press the little reset switch on the back and finally release Esc.

Now your keyboard is in DfuSe mode. It should show up in dfu-util:

$ dfu-util -l
dfu-util 0.9

...

Found DFU: [0483:df11] ver=0200, devnum=23, cfg=1, intf=0, path="20-2", alt=2, name="@BluetoothFlash  /0x1c000000/14*256 a,192*256 g", serial="057C37553731"
Found DFU: [0483:df11] ver=0200, devnum=23, cfg=1, intf=0, path="20-2", alt=1, name="@Internal Flash  /0x0c000000/64*256 a,192*256 g", serial="057C37553731"
Found DFU: [0483:df11] ver=0200, devnum=23, cfg=1, intf=0, path="20-2", alt=0, name="@Internal Flash  /0x08000000/64*256 a,192*256 g", serial="057C37553731"

Then you can flash your keyboard firmware:

$ dfu-util --alt 0 --intf 0 --download anne-key.dfu

...

file contains 1 DFU images
parsing DFU image 1
image for alternate setting 0, (1 elements, total size = 5104)
parsing element 1, address = 0x08004000, size = 5096
Download        [=========================] 100%         5096 bytes
Download done.
done parsing DfuSe file

And that's it. Press the reset button again to exit the bootloader and return to normal keyboard mode and you're done!

If you want to return to the original firmware you can flash the original firmware with:

$ dfu-util --alt 0 --intf 0 --download "anne pro key 1.4.dfu"

About

Firmware for Anne Pro Keyboard written in Rust

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Rust 92.4%
  • Python 6.1%
  • Shell 1.2%
  • Other 0.3%