qmk_firmware/keyboards/model01/readme.md

# Keyboardio Model 01

A split keyboard.

Keyboard Maintainer: QMK Community  
Hardware Supported: Keyboardio Model 01  
Hardware Availability: [Keyboardio](https://shop.keyboard.io)  

Make example for this keyboard (after setting up your build environment):

    make model01:default

See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) and the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information.
Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs).

## Programming the Keyboard

To program the keyboard, if you have avrdude installed:

    make model01:default:avrdude

When prompted to reset your keyboard, press the prog key at upper left. If the
keyboard does not reset, you can hold the prog key while plugging it into your
computer. The prog key will light up red in programming mode.

## Features

This implements the standard keymap, including mousekeys.

It doesn't do cursor warping - QMK does not support absolute mouse positioning.

LED support is limited. Gamma compensation and the high speed batch update
functions supported by the hardware are not implemented. The high current power
switch is also not implemented, so if you try and turn all the LEDs on at full
brightness, something may conk out.

Hotplugging the two halves works but is not extensively tested.
Keyboard: add Keyboardio Model 01 (#3900) * Keyboard: add Keyboardio Model01 This port implements key scanning and everything in their default keymap. It doesn't implement mouse warping; QMK can't do that (yet). LED control is mostly not implemented. The ability to set all LEDs is included because they can get stuck on coming from the bootloader otherwise. Single LED control is also implemented for numpad indication. The scanners also support batch LED transfer which is what you'd need if you wanted to do fast effects. Gamma correction is also not implemented, but is present in the original firmware. The necessary info for further implementation is in the KeyboardioScanner module for Kaleidoscope. To install on your keyboard: make model01:avrdude When prompted, hold the "prog" key on the keyboard to put it into programming mode. This can also be achieved by holding the "prog" key while plugging in the keyboard. This works even if the firmware is corrupt or missing. Hot plugging the halves seems to work fine, but there is no explicit support for eg. making sure the matrix scan rate is reconfigured. * model01: clean up includes and include guards Uses #pragma once everywhere. * model01: split LED and matrix code This makes space if someone wants to implement better LED support later on, the keyboard is a lot more capable than the current code. * model01: separate I2C timeouts for matrix vs. LED If the scanners have no data they don't ACK reads and just time out. So we want a pretty short timeout to keep scan rates high. Meanwhile the LED transfers might take longer - I don't know though, so here we are conservative. * model01: implement better LED control - gamma correction from the manufacturer's firmware - suitable delays to allow back to back LED writes - this is fast enough to write the whole keyboard without noticeable delay, in my experience - minor bug fix: RHS Fn key was not addressable * model01: add license to wire-protocol-constants.h * model01: replace gamma LUT The original was of unclear license origin. This one is functionally identical and includes a generator should people wish to adjust it. * model01: use the already-present CIE1931 lightness curve ...rather than baking in another gamma curve. It's said that CIE1931 is the right thing to be using rather than gamma. OK. Let it be so. * model01: call matrix_init_user() from matrix_init_kb() * model01: remove inapplicable config options from rules.mk * model01: readme.md: update build environment links 2018-09-17 22:49:20 +00:00			`# Keyboardio Model 01`

			`A split keyboard.`

			`Keyboard Maintainer: QMK Community`
			`Hardware Supported: Keyboardio Model 01`
			`Hardware Availability: [Keyboardio](https://shop.keyboard.io)`

			`Make example for this keyboard (after setting up your build environment):`

			`make model01:default`

			`See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) and the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information.`
			`Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs).`

			`## Programming the Keyboard`

			`To program the keyboard, if you have avrdude installed:`

			`make model01:default:avrdude`

			`When prompted to reset your keyboard, press the prog key at upper left. If the`
			`keyboard does not reset, you can hold the prog key while plugging it into your`
			`computer. The prog key will light up red in programming mode.`

			`## Features`

			`This implements the standard keymap, including mousekeys.`

			`It doesn't do cursor warping - QMK does not support absolute mouse positioning.`

			`LED support is limited. Gamma compensation and the high speed batch update`
			`functions supported by the hardware are not implemented. The high current power`
			`switch is also not implemented, so if you try and turn all the LEDs on at full`
			`brightness, something may conk out.`

			`Hotplugging the two halves works but is not extensively tested.`