Git Product home page Git Product logo

menelaus's Introduction

Menelaus

A firmware for the Atreus keyboard, written in Microscheme.

See this article about how it works.

Features

  • 6KRO (6 simultaneous keys, plus modifiers)
  • Software debouncing
  • Multiple layers, momentary and sticky (limited only by memory)
  • Combo keys (a single keystroke can send a modifier and a non-modifier)
  • Bind arbitrary Scheme functions to a key
  • ~300 lines of code

Usage

This requires avrdude for uploading to the controller on the keyboard; install with your package manager of choice.

Replace /dev/ttyACM0 with the path your OS assigns to the USB bootloader of the microcontroller (on Mac OS X sometimes it is /dev/cu.usbmodem1411 or similar):

$ make upload USB=/dev/ttyACM0

By default you get the "multidvorak" layout, but you can also build a qwerty layout:

$ cp qwerty.scm layout.scm
$ make upload USB=/dev/ttyACM0

Or edit layout.scm to your liking; you can see a list of available keycodes in keycodes.scm.

Development

The firmware can also be run on a PC rather than on the microcontroller in the keyboard using test.rkt which loads it up into Racket and simulates the GPIO functions with a test harness:

$ make test
racket test.rkt
..........................

Known bugs

The reset function has no effect; hard-reset (shorting the RST and GND pins with a wire) must be used to flash the firmware.

License

Copyright © 2014-2020 Phil Hagelberg and contributors

Released under the GNU GPL version 3.

Uses PJRC USB Keyboard library which is Copyright © 2009 PJRC.COM, LLC and released under the MIT/X11 license.

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.