Giter Club home page Giter Club logo

costar_keyboard's Introduction

Firmwares for keyboard controllers

Custom firmwares to replace stock Costar controllers allowing you to program your keyboard.

Firmwares include:

  • The Frosty Flake (for Cooler Master Quick Fire Rapid)
  • The Kitten Paw (for Filco Majestouch full size)
  • The Black Petal (for Rosewill full size)
  • The Pegasus Hoof (for Filco Majestouch Tenkeyless)

For more information, please see the Costar replacement controllers page on the Deskthority Wiki.

Intentions

One goal of this project is to make a keyboard firmware for ATmega32U2 based daughter boards as simple (within reason) as possible. It is supposed to be a first introduction to how a keyboard works.

Features will be limited to the following topics:

  • Basic keyboard (nothing mouse or other devices)
  • Simplified layout definitions
  • Timer interrupt matrix scans
  • Basic de-bouncing
  • PWM control for LEDs

For more advanced features there are other keyboard firmwares already way ahead of this project. If you want to contribute by increasing clarity, understandability or simplicity, please do. Also feel free to fork, clone or copy selected parts to diverge however you like from the constraints of this project.

Other keyboard firmwares

Some other noteworthy keyboard firmware projects are:

Forks from this project:

Compiling firmwares

In order to compile firmwares, avr-gcc is required. Please ensure you have it installed before moving to next step.

You need to select the correct MODEL and LAYOUT variables in the Makefile

MODEL = [flake|paw|hoof|petal]
LAYOUT = [ANSI_ISO_JIS|DVORAK]
MCU = atmega32u2
F_CPU = 16000000
B_LOADER = \"jmp\ 0x7000\"

Then run the make command in a terminal. Always run a make clean first.

$ make clean && make

If the process is successful, you would find binary firmware with extension .hex inside the binaries folder.

Flashing the controller

Make sure you install dfu-programmer first.

$ dfu-programmer atmega32u2 erase
$ dfu-programmer atmega32u2 flash binaries/[flake|paw|hoof|petal]_ANSI_ISO_JIS.hex
$ dfu-programmer atmega32u2 start

License

costar_keyboard is free software released under the MIT license.

See the COPYING.MIT file or http://opensource.org/licenses/MIT for more details.

Some files distributed as part of costar_keyboard are licensed under different licenses:

  • portions of Makefile: Public domain (by Eric B. Weddington, Jörg Wunsch et al.);
  • lib/keycode.h: GPL v2 or later (by Jun Wako);
  • lib/usb_keyboard_debug.c: MIT (by PJRC.COM, LLC).

costar_keyboard's People

Contributors

bathroomepiphanies avatar gioele avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.