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

14 files changed, 572 insertions, 0 deletions

diff --git a/keyboards/model01/config.h b/keyboards/model01/config.h
new file mode 100644
index 000000000..796653f45
--- /dev/null
+++ b/keyboards/model01/config.h
@@ -0,0 +1,35 @@
+/*
+Copyright 2018 James Laird-Wah
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation, either version 2 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program.  If not, see <http://www.gnu.org/licenses/>.
+*/
+
+#pragma once
+
+#include <config_common.h>
+
+/* USB Device descriptor parameter */
+#define VENDOR_ID       0x1209
+#define PRODUCT_ID      0x2301
+#define DEVICE_VER      0x0001
+#define MANUFACTURER    Keyboardio
+#define PRODUCT         Model 01
+#define DESCRIPTION     (QMK)
+
+/* key matrix size; rows are doubled for split */
+#define MATRIX_ROWS 8
+#define MATRIX_COLS 8
+
+/* The scanners already debounce for us */
+#define DEBOUNCING_DELAY 0
diff --git a/keyboards/model01/info.json b/keyboards/model01/info.json
new file mode 100644
index 000000000..daf51492d
--- /dev/null
+++ b/keyboards/model01/info.json
@@ -0,0 +1,4 @@
+{
+  "keyboard_name": "model01",
+  "url": "https://keyboard.io"
+}
diff --git a/keyboards/model01/keymaps/default/config.h b/keyboards/model01/keymaps/default/config.h
new file mode 100644
index 000000000..8ab9d8b02
--- /dev/null
+++ b/keyboards/model01/keymaps/default/config.h
@@ -0,0 +1,19 @@
+/* Copyright 2018 James Laird-Wah
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+#pragma once
+
+/* place overrides here */
diff --git a/keyboards/model01/keymaps/default/keymap.c b/keyboards/model01/keymaps/default/keymap.c
new file mode 100644
index 000000000..cdc050cd9
--- /dev/null
+++ b/keyboards/model01/keymaps/default/keymap.c
@@ -0,0 +1,93 @@
+/* Copyright 2018 James Laird-Wah
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+#include QMK_KEYBOARD_H
+
+/* layer constants */
+enum {
+  DEF = 0,
+  NUM,
+  FUN,
+};
+
+
+const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
+[DEF] = LAYOUT(
+  RESET  , KC_1   , KC_2   , KC_3   , KC_4   , KC_5   ,                      KC_6   , KC_7   , KC_8   , KC_9   , KC_0   , TG(NUM),
+  KC_GRV , KC_Q   , KC_W   , KC_E   , KC_R   , KC_T   , _______,    _______, KC_Y   , KC_U   , KC_I   , KC_O   , KC_P   , KC_EQL ,
+  KC_PGUP, KC_A   , KC_S   , KC_D   , KC_F   , KC_G   , KC_TAB ,    KC_ENT , KC_H   , KC_J   , KC_K   , KC_L   , KC_SCLN, KC_QUOT,
+  KC_PGDN, KC_Z   , KC_X   , KC_C   , KC_V   , KC_B   , KC_ESC ,    _______, KC_N   , KC_M   , KC_COMM, KC_DOT , KC_SLSH, KC_MINS,
+                                         KC_LCTL,                                 KC_RCTL,
+                                            KC_BSPC,                           KC_SPC ,
+                                               KC_LGUI,                     KC_RALT,
+                                                  KC_LSFT,               KC_RSFT,
+                                      MO(FUN),                                        MO(FUN)
+  ),
+[NUM] = LAYOUT(
+  _______, _______, _______, _______, _______, _______,                      _______, KC_P7  , KC_P8  , KC_P9  , KC_PMNS, _______,
+  _______, _______, _______, _______, _______, _______, _______,    _______, _______, KC_P4  , KC_P5  , KC_P6  , KC_PPLS, _______,
+  _______, _______, _______, _______, _______, _______, _______,    _______, _______, KC_P1  , KC_P2  , KC_P3  , KC_PEQL, _______,
+  _______, _______, _______, _______, _______, _______, _______,    _______, _______, KC_P0  , KC_PDOT, KC_PAST, KC_PSLS, KC_PENT,
+                                         _______,                                 _______,
+                                            _______,                           _______,
+                                               _______,                     _______,
+                                                  _______,               _______,
+                                      _______,                                        _______
+  ),
+[FUN] = LAYOUT(
+  _______, KC_F1  , KC_F2  , KC_F3  , KC_F4  , KC_F5  ,                      KC_F6  , KC_F7  , KC_F8  , KC_F9  , KC_F10 , KC_F11 ,
+  KC_TAB , _______, KC_MS_U, _______, KC_BTN3, _______, _______,    KC_MPRV, KC_MNXT, KC_LCBR, KC_RCBR, KC_LBRC, KC_RBRC, KC_F12 ,
+  KC_HOME, KC_MS_L, KC_MS_D, KC_MS_R, KC_BTN1, _______, _______,    KC_MPLY, KC_LEFT, KC_DOWN, KC_UP  , KC_RGHT, _______, _______,
+  KC_END , KC_PSCR, KC_INS , _______, KC_BTN2, _______, _______,    _______, KC_MUTE, KC_VOLD, KC_VOLU, _______, KC_BSLS, KC_PIPE,
+                                         _______,                                 _______,
+                                            KC_DEL ,                           KC_ENT ,
+                                               _______,                     _______,
+                                                  _______,               _______,
+                                      _______,                                        _______
+  )
+};
+
+/* template for new layouts:
+LAYOUT(
+  _______, _______, _______, _______, _______, _______,                      _______, _______, _______, _______, _______, _______,
+  _______, _______, _______, _______, _______, _______, _______,    _______, _______, _______, _______, _______, _______, _______,
+  _______, _______, _______, _______, _______, _______, _______,    _______, _______, _______, _______, _______, _______, _______,
+  _______, _______, _______, _______, _______, _______, _______,    _______, _______, _______, _______, _______, _______, _______,
+                                         _______,                                 _______,
+                                            _______,                           _______,
+                                               _______,                     _______,
+                                                  _______,               _______,
+                                      _______,                                        _______
+  )
+*/
+
+uint32_t layer_state_set_user(uint32_t state) {
+  switch (biton32(state)) {
+    case DEF:
+      set_all_leds_to(0,0,0);
+      break;
+    case NUM:
+      /* highlight the numpad keys when numlock is on */
+      for (int i=44; i<=60; i++) {
+        set_led_to(i, 128,0,0);
+      }
+      set_led_to(63, 128, 0, 0);
+      break;
+  }
+
+  return state;
+}
+
+/* vim: set ts=2 sw=2 et: */
diff --git a/keyboards/model01/keymaps/default/readme.md b/keyboards/model01/keymaps/default/readme.md
new file mode 100644
index 000000000..740515a26
--- /dev/null
+++ b/keyboards/model01/keymaps/default/readme.md
@@ -0,0 +1,3 @@
+# The default keymap for Keyboardio's Model01
+
+This implements all of their default keymap, except for mouse warping.
diff --git a/keyboards/model01/keymaps/default/rules.mk b/keyboards/model01/keymaps/default/rules.mk
new file mode 100644
index 000000000..4d1abd88a
--- /dev/null
+++ b/keyboards/model01/keymaps/default/rules.mk
@@ -0,0 +1,2 @@
+# used by default keymap
+MOUSEKEY_ENABLE = yes       # Mouse keys(+4700)
diff --git a/keyboards/model01/leds.c b/keyboards/model01/leds.c
new file mode 100644
index 000000000..b80a749a7
--- /dev/null
+++ b/keyboards/model01/leds.c
@@ -0,0 +1,57 @@
+/* Copyright 2018 James Laird-Wah
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+#include <quantum.h>
+#include <i2c_master.h>
+#include <led_tables.h>
+#include "model01.h"
+
+#define I2C_TIMEOUT     1000
+
+#define LINCOR(i) pgm_read_byte(&CIE1931_CURVE[i])
+
+int set_all_leds_to_raw(uint8_t r, uint8_t g, uint8_t b) {
+  uint8_t buf[] = {
+    TWI_CMD_LED_SET_ALL_TO,
+    b, g, r
+  };
+  int ret = 0;
+  ret |= i2c_transmit(I2C_ADDR(LEFT), buf, sizeof(buf), I2C_TIMEOUT);
+  ret |= i2c_transmit(I2C_ADDR(RIGHT), buf, sizeof(buf), I2C_TIMEOUT);
+  _delay_us(10);
+  return ret;
+}
+
+int set_all_leds_to(uint8_t r, uint8_t g, uint8_t b) {
+  return set_all_leds_to_raw(LINCOR(r), LINCOR(g), LINCOR(b));
+}
+
+int set_led_to_raw(uint8_t led, uint8_t r, uint8_t g, uint8_t b) {
+  uint8_t buf[] = {
+    TWI_CMD_LED_SET_ONE_TO,
+    led & 0x1f,
+    b, g, r
+  };
+  int hand = (led >= 32) ? RIGHT : LEFT;
+  int ret = i2c_transmit(I2C_ADDR(hand), buf, sizeof(buf), I2C_TIMEOUT);
+  _delay_us(10);
+  return ret;
+}
+
+int set_led_to(uint8_t led, uint8_t r, uint8_t g, uint8_t b) {
+  return set_led_to_raw(led, LINCOR(r), LINCOR(g), LINCOR(b));
+}
+
+/* vim: set ts=2 sw=2 et: */
diff --git a/keyboards/model01/leds.h b/keyboards/model01/leds.h
new file mode 100644
index 000000000..0aac781dd
--- /dev/null
+++ b/keyboards/model01/leds.h
@@ -0,0 +1,25 @@
+/* Copyright 2018 James Laird-Wah
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+#pragma once
+
+#include <quantum.h>
+
+int set_all_leds_to(uint8_t r, uint8_t g, uint8_t b);
+int set_led_to(uint8_t led, uint8_t r, uint8_t g, uint8_t b);
+
+/* Raw (gamma uncorrected) LED values */
+int set_all_leds_to_raw(uint8_t r, uint8_t g, uint8_t b);
+int set_led_to_raw(uint8_t led, uint8_t r, uint8_t g, uint8_t b);
diff --git a/keyboards/model01/matrix.c b/keyboards/model01/matrix.c
new file mode 100644
index 000000000..f1f9024c7
--- /dev/null
+++ b/keyboards/model01/matrix.c
@@ -0,0 +1,94 @@
+/* Copyright 2018 James Laird-Wah
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+#include <quantum.h>
+#include <i2c_master.h>
+#include <string.h>
+#include "model01.h"
+
+/* If no key events have occurred, the scanners will time out on reads.
+ * So we don't want to be too permissive here. */
+#define I2C_TIMEOUT     10
+
+static matrix_row_t rows[MATRIX_ROWS];
+#define ROWS_PER_HAND (MATRIX_ROWS / 2)
+
+inline
+uint8_t matrix_rows(void) {
+  return MATRIX_ROWS;
+}
+
+inline
+uint8_t matrix_cols(void) {
+  return MATRIX_COLS;
+}
+
+static int i2c_read_hand(int hand) {
+  uint8_t buf[5];
+  i2c_status_t ret = i2c_receive(I2C_ADDR(hand), buf, sizeof(buf), I2C_TIMEOUT);
+  if (ret != I2C_STATUS_SUCCESS)
+    return 1;
+
+  if (buf[0] != TWI_REPLY_KEYDATA)
+    return 2;
+
+  int start_row = hand ? ROWS_PER_HAND : 0;
+  uint8_t *out = &rows[start_row];
+  memcpy(out, &buf[1], 4);
+  return 0;
+}
+
+static int i2c_set_keyscan_interval(int hand, int delay) {
+  uint8_t buf[] = {TWI_CMD_KEYSCAN_INTERVAL, delay};
+  i2c_status_t ret = i2c_transmit(I2C_ADDR(hand), buf, sizeof(buf), I2C_TIMEOUT);
+  return ret;
+}
+
+void matrix_init(void) {
+  /* Ensure scanner power is on - else right hand will not work */
+  DDRC |= _BV(7);
+  PORTC |= _BV(7);
+
+  i2c_init();
+  i2c_set_keyscan_interval(LEFT, 2);
+  i2c_set_keyscan_interval(RIGHT, 2);
+  memset(rows, 0, sizeof(rows));
+
+  matrix_init_quantum();
+}
+
+uint8_t matrix_scan(void) {
+  uint8_t ret = 0;
+  ret |= i2c_read_hand(LEFT);
+  ret |= i2c_read_hand(RIGHT);
+  matrix_scan_quantum();
+  return ret;
+}
+
+inline
+matrix_row_t matrix_get_row(uint8_t row) {
+  return rows[row];
+}
+
+void matrix_print(void) {
+  print("\nr/c 0123456789ABCDEF\n");
+  for (uint8_t row = 0; row < MATRIX_ROWS; row++) {
+    phex(row); print(": ");
+    pbin_reverse16(matrix_get_row(row));
+    print("\n");
+  }
+}
+
+/* vim: set ts=2 sw=2 et: */
diff --git a/keyboards/model01/model01.c b/keyboards/model01/model01.c
new file mode 100644
index 000000000..29615ca86
--- /dev/null
+++ b/keyboards/model01/model01.c
@@ -0,0 +1,38 @@
+/* Copyright 2018 James Laird-Wah
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+#include <quantum.h>
+#include <i2c_master.h>
+#include <string.h>
+#include "model01.h"
+
+void matrix_init_kb(void) {
+  /* the bootloader can leave LEDs on, so */
+  set_all_leds_to(0, 0, 0);
+  matrix_init_user();
+}
+
+void matrix_scan_kb(void) {
+  matrix_scan_user();
+}
+
+__attribute__ ((weak))
+void matrix_scan_user(void) {
+}
+
+__attribute__ ((weak))
+void matrix_init_user(void) {
+}
+
diff --git a/keyboards/model01/model01.h b/keyboards/model01/model01.h
new file mode 100644
index 000000000..a83e33cd8
--- /dev/null
+++ b/keyboards/model01/model01.h
@@ -0,0 +1,50 @@
+/* Copyright 2018 James Laird-Wah
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+#pragma once
+
+#include <quantum.h>
+
+#define LAYOUT( \
+  L07, L06, L05, L04, L03, L02,                    R05, R04, R03, R02, R01, R00, \
+  L17, L16, L15, L14, L13, L12, L01,          R06, R15, R14, R13, R12, R11, R10, \
+  L27, L26, L25, L24, L23, L22, L11,          R16, R25, R24, R23, R22, R21, R20, \
+  L37, L36, L35, L34, L33, L32, L21,          R26, R35, R34, R33, R32, R31, R30, \
+                           L00,                    R07,                          \
+                              L10,              R17,                             \
+                                 L20,        R27,                                \
+                                    L30,  R37,                                   \
+                           L31,                    R36                           \
+  ) { \
+      {L00, L01, L02, L03, L04, L05, L06, L07}, \
+      {L10, L11, L12, L13, L14, L15, L16, L17}, \
+      {L20, L21, L22, L23, L24, L25, L26, L27}, \
+      {L30, L31, L32, L33, L34, L35, L36, L37}, \
+      {R00, R01, R02, R03, R04, R05, R06, R07}, \
+      {R10, R11, R12, R13, R14, R15, R16, R17}, \
+      {R20, R21, R22, R23, R24, R25, R26, R27}, \
+      {R30, R31, R32, R33, R34, R35, R36, R37} \
+  }
+
+#include "wire-protocol-constants.h"
+#define I2C_ADDR_LEFT   (0x58 << 1)
+#define I2C_ADDR_RIGHT  (I2C_ADDR_LEFT + 6)
+#define I2C_ADDR(hand)  ((hand) ? I2C_ADDR_RIGHT : I2C_ADDR_LEFT)
+#define LEFT            0
+#define RIGHT           1
+
+#include "leds.h"
+
+/* vim: set ts=2 sw=2 et: */
diff --git a/keyboards/model01/readme.md b/keyboards/model01/readme.md
new file mode 100644
index 000000000..34bd291e2
--- /dev/null
+++ b/keyboards/model01/readme.md
@@ -0,0 +1,37 @@
+# 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.
diff --git a/keyboards/model01/rules.mk b/keyboards/model01/rules.mk
new file mode 100644
index 000000000..cab7065ff
--- /dev/null
+++ b/keyboards/model01/rules.mk
@@ -0,0 +1,62 @@
+SRC += i2c_master.c \
+	   leds.c \
+	   matrix.c
+
+# MCU name
+MCU = atmega32u4
+
+# Processor frequency.
+#     This will define a symbol, F_CPU, in all source code files equal to the
+#     processor frequency in Hz. You can then use this symbol in your source code to
+#     calculate timings. Do NOT tack on a 'UL' at the end, this will be done
+#     automatically to create a 32-bit value in your source code.
+#
+#     This will be an integer division of F_USB below, as it is sourced by
+#     F_USB after it has run through any CPU prescalers. Note that this value
+#     does not *change* the processor frequency - it should merely be updated to
+#     reflect the processor speed set externally so that the code can use accurate
+#     software delays.
+F_CPU = 16000000
+
+
+#
+# LUFA specific
+#
+# Target architecture (see library "Board Types" documentation).
+ARCH = AVR8
+
+# Input clock frequency.
+#     This will define a symbol, F_USB, in all source code files equal to the
+#     input clock frequency (before any prescaling is performed) in Hz. This value may
+#     differ from F_CPU if prescaling is used on the latter, and is required as the
+#     raw input clock is fed directly to the PLL sections of the AVR for high speed
+#     clock generation for the USB and other AVR subsections. Do NOT tack on a 'UL'
+#     at the end, this will be done automatically to create a 32-bit value in your
+#     source code.
+#
+#     If no clock division is performed on the input clock inside the AVR (via the
+#     CPU clock adjust registers or the clock division fuses), this will be equal to F_CPU.
+F_USB = $(F_CPU)
+
+# Interrupt driven control endpoint task(+60)
+OPT_DEFS += -DINTERRUPT_CONTROL_ENDPOINT
+
+BOOTLOADER = caterina
+
+# Build Options
+#   change yes to no to disable
+#
+BOOTMAGIC_ENABLE = no      # Virtual DIP switch configuration(+1000)
+MOUSEKEY_ENABLE = no       # Mouse keys(+4700)
+EXTRAKEY_ENABLE = yes       # Audio control and System control(+450)
+CONSOLE_ENABLE = yes        # Console for debug(+400)
+COMMAND_ENABLE = no        # Commands for debug and configuration
+# Do not enable SLEEP_LED_ENABLE. it uses the same timer as BACKLIGHT_ENABLE
+SLEEP_LED_ENABLE = no       # Breathing sleep LED during USB suspend
+# if this doesn't work, see here: https://github.com/tmk/tmk_keyboard/wiki/FAQ#nkro-doesnt-work
+NKRO_ENABLE = no            # USB Nkey Rollover
+MIDI_ENABLE = no            # MIDI support (+2400 to 4200, depending on config)
+UNICODE_ENABLE = no         # Unicode
+
+CUSTOM_MATRIX = yes
+CIE1931_CURVE = yes
diff --git a/keyboards/model01/wire-protocol-constants.h b/keyboards/model01/wire-protocol-constants.h
new file mode 100644
index 000000000..90a528582
--- /dev/null
+++ b/keyboards/model01/wire-protocol-constants.h
@@ -0,0 +1,53 @@
+/*
+ * This file is taken from the KeyboardioScanner module:
+ * https://github.com/keyboardio/KeyboardioScanner/blob/master/wire-protocol-constants.h
+ *
+ * Copyright (C) 2015-2018  Keyboard.io, Inc
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+#pragma once
+
+#define TWI_CMD_NONE 0x00
+#define TWI_CMD_VERSION 0x01
+#define TWI_CMD_KEYSCAN_INTERVAL 0x02
+#define TWI_CMD_LED_SET_ALL_TO 0x03
+#define TWI_CMD_LED_SET_ONE_TO 0x04
+#define TWI_CMD_COLS_USE_PULLUPS 0x05
+#define TWI_CMD_LED_SPI_FREQUENCY 0x06
+
+#define LED_SPI_FREQUENCY_4MHZ      0x07
+#define LED_SPI_FREQUENCY_2MHZ      0x06
+#define LED_SPI_FREQUENCY_1MHZ      0x05
+#define LED_SPI_FREQUENCY_512KHZ    0x04
+#define LED_SPI_FREQUENCY_256KHZ    0x03
+#define LED_SPI_FREQUENCY_128KHZ    0x02
+#define LED_SPI_FREQUENCY_64KHZ     0x01
+#define LED_SPI_OFF                 0x00
+
+
+// 512KHZ seems to be the sweet spot in early testing
+// so make it the default
+#define LED_SPI_FREQUENCY_DEFAULT LED_SPI_FREQUENCY_512KHZ
+
+
+#define TWI_CMD_LED_BASE 0x80
+
+#define TWI_REPLY_NONE 0x00
+#define TWI_REPLY_KEYDATA 0x01