Git Product home page Git Product logo

model01-firmware's Introduction

Keyboardio Model 01 Firmware

The default firmware for the Keyboardio Model 01

This is a quick start guide for folks who are familiar with Arduino and prefer to use the command line. For everyone else:

Download and install

Set up the Arduino IDE

Setup the Arduino IDE on your system. Make sure you install at least version 1.8.11, since older version may not support all required features.

Out of the box, Arduino does not include support for Kaleidoscope keyboards. To be able to build and install new firmware on your keyboard, you will need to teach Arduino about Kaleidoscope.

You can find instructions for setting up the Arduino IDE and adding support for Kaleidoscope on the Kaleidoscope wiki

Once that's done, you're ready to download the Model 01's firmware source code.

Download the Model 01 Firmware

git clone https://github.com/keyboardio/Model01-Firmware.git

Build and flash the firmware

Before you begin, make sure your Model 01 is connected to your computer.

Option 1: From the command line

cd Model01-Firmware
make flash

When the builder tells you to hit Enter to continue, hold down "Prog" in the top left corner of your keyboard and hit Enter.

Option 2: From the Arduino IDE

Open the sketch you wish to flash (for example, Model01-Firmware.ino).

Make sure that you've picked the Model 01 from the Boards list in the tools menu.

Click the Upload button or press Ctrl-U.

Hold down the "Prog" key in the top left corner of your keyboard, until the compile finishes and the upload begins.

Start to customize the firmware

You can customize your keyboard's key layout and LED effects by modifying the Model01-Firmware.ino file in the same directory as this README. Model01-Firmware.ino is a computer program written in 'Arduino C'. You can find documentation about Arduino C at https://arduino.cc.

You can also find Kaleidoscope-specific documentation on our wiki.

Getting help

As you start to explore customization of your keyboard's firmware, the community at https://community.keyboard.io can often be a valuable resource.

Thanks!

<3 jesse

Build Status

model01-firmware's People

Contributors

ackintosh avatar afreakk avatar algernon avatar aoeu avatar ashitakalax avatar blovett avatar cdisselkoen avatar danbernier avatar gedankenexperimenter avatar hustvedt avatar jennigma avatar jimt avatar malsyned avatar martinakcsilla avatar numist avatar obra avatar ryansb avatar tretuna avatar tych0 avatar wesq3 avatar

Watchers

 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.