Giter VIP home page Giter VIP logo

cphbrt / reactor Goto Github PK

View Code? Open in Web Editor NEW

This project forked from zsa/reactor

0.0 0.0 0.0 19.53 MB

Reactor is the firmware generator part of Fusion

License: MIT License

Ruby 0.01% Liquid 0.01% Makefile 0.39% C 85.21% C++ 9.26% Shell 0.01% Objective-C 0.09% Assembly 3.50% Logos 0.02% Python 0.66% JavaScript 0.01% HTML 0.56% CSS 0.01% XSLT 0.04% C# 0.02% Arduino 0.21% SourcePawn 0.03%

reactor's Introduction

Reactor

Reactor is the firmware generator part of Fusion.

It takes the JSON's exported by the Fusion project and process them in to ready-to-be-downloaded firmware.

Reactor uses the awesome qmk_firmware by Jack Humbert. The firmware is included through a git subtree. To update the firmware, check out updating the firmware.

General process

  • Take JSON input
  • Generate a .c template file based on the JSON and the liquid template. Name it something unique
  • Create a hex file by compiling that c file. Name it something unique too
  • Read .hex file and return it

Local development

You can run the tests with be guard - which will watch for changes in ruby files and run whenever they do.

Testing is done in ruby 2.2.2

Updating the firmware

The qmk_firmware is included in this repository as a git subtree. Any changes to qmk_firmware should be made to the qmk_firmware repository not this repository.

To update the subtree from the qmk_firmware repository, pull the updates from qmk_firmware into this repository.

If you don't have the remote and the subtree setup:

  1. Add the remote for qmk_firmware

    git remote add -f qmk_firmware [email protected]:jackhumbert/qmk_firmware.git

  2. Add the subtree

    git subtree add --prefix lib/firmware qmk_firmware master --squash

If you have the remote and subtree setup:

  1. Fetch the updates

    git fetch qmk_firmware master

  2. Update the subtree

    git subtree pull --prefix lib/firmware qmk_firmware master --squash

Read more about git subtrees here

Compiling firmware

Linux

Using the instructions from the teensy loader build environment:

sudo apt-get install gcc-avr binutils-avr avr-libc

Mac OSX

Using homebrew it's easy to compile the firmware:

brew tap osx-cross/avr
brew install avr-libc

Next cd into the appropriate folder of the qmk_firmware, say keyboard/ergodox_ez

cd keyboard/ergodox_ez

Then run make for the default keymap, or

make KEYMAP="yourown"

for your own keymap. This requires a files keymap_yourown.c in the subfolder keymaps. You should end up with a ergodox_ez.hex file, which you can use with the Teensy loader or Teensy GUI

reactor's People

Contributors

sethherr avatar tdegrunt 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.