{"id":22814475,"url":"https://github.com/dwb/model01-firmware","last_synced_at":"2025-03-30T22:16:49.979Z","repository":{"id":148884945,"uuid":"495164589","full_name":"dwb/Model01-Firmware","owner":"dwb","description":null,"archived":false,"fork":false,"pushed_at":"2023-12-04T17:41:28.000Z","size":123,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-02-06T02:49:59.237Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"C++","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/dwb.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null}},"created_at":"2022-05-22T20:02:13.000Z","updated_at":"2022-05-23T12:45:43.000Z","dependencies_parsed_at":"2023-07-16T21:33:16.977Z","dependency_job_id":null,"html_url":"https://github.com/dwb/Model01-Firmware","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dwb%2FModel01-Firmware","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dwb%2FModel01-Firmware/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dwb%2FModel01-Firmware/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dwb%2FModel01-Firmware/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/dwb","download_url":"https://codeload.github.com/dwb/Model01-Firmware/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246385415,"owners_count":20768672,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-12-12T13:09:02.616Z","updated_at":"2025-03-30T22:16:49.953Z","avatar_url":"https://github.com/dwb.png","language":"C++","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Keyboardio Model 01 Firmware\n\n_The default firmware for the Keyboardio Model 01_\n\n\u003ch3\u003eThis is a quick start guide for folks who are familiar with Arduino and prefer to use the command line. For everyone else:\n\n * [Check out the wiki](https://github.com/keyboardio/Kaleidoscope/wiki/Keyboardio-Model-01-Introduction) for a more in depth introduction to how the Model 01 keyboard and the Kaleidoscope firmware work. \n \n  * If you have questions, [The community forums are happy to help!](https://community.keyboard.io/)\u003c/h3\u003e\n\n# Download and install\n\n## Set up the Arduino IDE\n\nSetup the Arduino IDE on your system. Make sure you install at least version 1.6.10, since older version may not support all required features.\n\n### macOS\n\nOn macOS, install the Arduino IDE using [homebrew](http://brew.sh/) [cask](https://caskroom.github.io/) with `brew cask install arduino` or download the application from [the official website](https://www.arduino.cc/en/Main/Software) and move it to your `/Applications` folder.\n\n\n### Linux\n\nOn Linux, your distribution's package manager probably includes the Arduino IDE, but it may be an out of date version. If your distribution installs a version of Arduino before 1.6.10, you'll need to install the Arduino IDE following the instructions [on the wiki](https://github.com/keyboardio/Kaleidoscope/wiki/Install-Arduino-support-on-Linux).\n\nIf you install Arduino into some place that's /not/ `/usr/local/arduino`, you'll need to set the `$ARDUINO_PATH` environment variable to the directory containing the `arduino` and `arduino-builder` binaries.\n\n## Create and navigate to the Arduino Sketchbook directory\n\n### MacOS\n```sh\nmkdir -p $HOME/Documents/Arduino\ncd $HOME/Documents/Arduino \n```\n\n### Linux\n\n```sh\nmkdir -p $HOME/Arduino\ncd $HOME/Arduino \n```\n\n## Download hardware platform, including library source code \n\n```sh\nmkdir -p hardware/keyboardio\n\n## then clone the hardware definitions to make them available to the arduino environment\ngit clone --recursive https://github.com/keyboardio/Arduino-Boards.git hardware/keyboardio/avr\n````\n\n\n## Download the Model 01 Firmware\n\n```sh\ngit clone https://github.com/keyboardio/Model01-Firmware.git\n```\n\n# Build and flash the firmware\n\nBefore you begin, make sure your Model 01 is connected to your computer.\n\n### Option 1: From the command line\n\n```sh\ncd Model01-Firmware\nmake flash\n```\n\nWhen the builder tells you to hit Enter to continue, hold down \"Prog\" in the top left corner of your keyboard and hit Enter.\n\n### Option 2: From the Arduino IDE\n\n\nOpen the sketch you wish to flash (for example, `Model01-Firmware.ino`).\n\nClick the Upload button or press `Ctrl-U`.\n\nHold down the \"Prog\" key in the top left corner of your keyboard, until the compile finishes and the upload begins.\n\n\n# Start to customize the firmware\n\nYou 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.\n\n\n# Updating the firmware and libraries\n\nFrom time to time, you may want to pull the latest version of this firmware from GitHub. To do that, navigate to the Model01-Firmware directory in your shell and pull the latest code.\n\n```sh\ncd Model01-Firmware\ngit pull\n```\n\nAfter that, you'll want to update the Kaleidoscope libraries.\n\n### MacOS\n```sh\ncd $HOME/Documents/Arduino/hardware/keyboardio/avr\nmake update-submodules\n```\n\n### Linux\n\n```sh\ncd $HOME/Arduino/hardware/keyboardio/avr\nmake update-submodules\n```\n\n\n# Getting help\n\nAs you start to explore customization of your keyboard's firmware, the community at https://community.keyboard.io can often be a valuable resource.\n\n# Thanks!\n\n\u003c3 jesse\n\n[![Build Status](https://travis-ci.org/keyboardio/Model01-Firmware.svg?branch=master)](https://travis-ci.org/keyboardio/Model01-Firmware)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdwb%2Fmodel01-firmware","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdwb%2Fmodel01-firmware","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdwb%2Fmodel01-firmware/lists"}