@ -0,0 +1,17 @@ | |||
# Ferris 0.1 | |||
![Ferris 0.1 - base, top view](https://i.imgur.com/s6nTn0Ch.jpg) | |||
![Ferris 0.1 - base, bottom view](https://i.imgur.com/Ymlac2Ah.jpg) | |||
An atmega32u4 based split 34 keys column staggered keyboard named and decorated after the rustlang mascott. All PCB files and some thoughts on the design are available on the [project's github page](https://github.com/pierrechevalier83/ferris) | |||
* Keyboard Maintainer: [Pierre Chevalier](https://github.com/pierrechevalier83) | |||
* Hardware Supported: | |||
* Ferris 0.1: atmega32u4 chip. Comes in 4 variants: base, low, high and compact | |||
* Hardware Availability: Pierre Chevalier has been selling keyboard kits (see the #ferris channel in the 40% discord chat). Wider availability is on the horizon. | |||
Make examples for this keyboard (after setting up your build environment): | |||
make ferris/0_1: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). |
@ -0,0 +1,17 @@ | |||
/* | |||
Copyright 2020 Pierre Chevalier <pierrechevalier83@gmail.com> | |||
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 "0_2.h" |
@ -0,0 +1,43 @@ | |||
/* | |||
Copyright 2020 Pierre Chevalier <pierrechevalier83@gmail.com> | |||
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" | |||
// clang-format off | |||
/* left hand right hand */ | |||
#define LAYOUT(\ | |||
K0_0, K0_1, K0_2, K0_3, K0_4, K0_5, K0_6, K0_7, K0_8, K0_9,\ | |||
K1_0, K1_1, K1_2, K1_3, K1_4, K1_5, K1_6, K1_7, K1_8, K1_9,\ | |||
K2_0, K2_1, K2_2, K2_3, K2_4, K2_5, K2_6, K2_7, K2_8, K2_9,\ | |||
K3_3, K3_4, K3_5, K3_6)\ | |||
/* matrix positions */\ | |||
{\ | |||
{K0_0, K0_1, K0_2, K0_3, K0_4},\ | |||
{K1_0, K1_1, K1_2, K1_3, K1_4},\ | |||
{K2_0, K2_1, K2_2, K2_3, K2_4},\ | |||
{KC_NO, KC_NO, KC_NO, K3_3, K3_4},\ | |||
\ | |||
{K0_5, K0_6, K0_7, K0_8, K0_9},\ | |||
{K1_5, K1_6, K1_7, K1_8, K1_9},\ | |||
{K2_5, K2_6, K2_7, K2_8, K2_9},\ | |||
{K3_5, K3_6, KC_NO, KC_NO, KC_NO}\ | |||
} | |||
// clang-format on |
@ -0,0 +1,40 @@ | |||
/* Copyright 2020 QMK | |||
* | |||
* 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/>. | |||
*/ | |||
/* | |||
* This file was auto-generated by: | |||
* `qmk chibios-confmigrate -i keyboards/ferris/0_2/chconf.h -r platforms/chibios/common/configs/chconf.h` | |||
*/ | |||
#pragma once | |||
#define CH_CFG_ST_FREQUENCY 10000 | |||
#define CH_CFG_OPTIMIZE_SPEED FALSE | |||
#define CH_CFG_USE_REGISTRY TRUE | |||
#define CH_CFG_USE_WAITEXIT TRUE | |||
#define CH_CFG_USE_CONDVARS TRUE | |||
#define CH_CFG_USE_CONDVARS_TIMEOUT FALSE | |||
#define CH_CFG_USE_MESSAGES TRUE | |||
#define CH_CFG_USE_MAILBOXES TRUE | |||
#include_next <chconf.h> |
@ -0,0 +1,80 @@ | |||
/* | |||
Copyright 2020 Pierre Chevalier <pierrechevalier83@gmail.com> | |||
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 | |||
/* USB Device descriptor parameter */ | |||
#define VENDOR_ID 0xC2AB | |||
#define PRODUCT_ID 0x0001 | |||
#define DEVICE_VER 0x0002 | |||
#define MANUFACTURER Pierre | |||
#define PRODUCT Ferris the keeb | |||
/* key matrix size */ | |||
#define MATRIX_ROWS 8 | |||
#define MATRIX_COLS 10 | |||
#define MATRIX_ROWS_PER_SIDE (MATRIX_ROWS / 2) | |||
#define MATRIX_COLS_PER_SIDE (MATRIX_COLS / 2) | |||
#define UNUSED_MCU 24 | |||
#define UNUSED_MCP 7 | |||
// wiring | |||
#define MATRIX_ROW_PINS_MCU \ | |||
{ B7, B6, B5, A2 } | |||
#define MATRIX_COL_PINS_MCU \ | |||
{ B8, B4, B3, A15, A14 } | |||
#define UNUSED_PINS_MCU \ | |||
{ A0, A1, A3, A4, A5, A6, A7, A8, A9, A10, A13, B0, B1, B2, B9, B12, B13, B14, B15, C13, C14, C15, F0, F1 } | |||
#define MATRIX_ROW_PINS_MCP \ | |||
{ B0, B1, B2, B3 } | |||
#define MATRIX_COL_PINS_MCP \ | |||
{ A0, A1, A2, A3, A4 } | |||
#define UNUSED_PINS_MCP \ | |||
{ B4, B5, B6, B7, A5, A6, A7 } | |||
#define MATRIX_ROW_PINS \ | |||
{ B7, B6, B5, A2, A0, A0, A0, A0 } | |||
#define MATRIX_COL_PINS \ | |||
{ B8, B4, B3, A15, A14, A1, A1, A1, A1, A1 } | |||
#define UNUSED_PINS \ | |||
{ A3, A4, A5, A6, A7, A8, A9, A10, A13, B0, B1, B2, B9, B12, B13, B14, B15, C13, C14, C15, F0, F1 } | |||
/* COL2ROW, ROW2COL*/ | |||
#define DIODE_DIRECTION COL2ROW | |||
/* define if matrix has ghost (lacks anti-ghosting diodes) */ | |||
//#define MATRIX_HAS_GHOST | |||
/* Debounce reduces chatter (unintended double-presses) - set 0 if debouncing is not needed */ | |||
#define DEBOUNCE 5 | |||
/* i2c settings */ | |||
#define I2C_DRIVER I2CD2 | |||
#define I2C1_SCL_BANK GPIOB | |||
#define I2C1_SCL 10 | |||
#define I2C1_SDA_BANK GPIOB | |||
#define I2C1_SDA 11 | |||
#define I2C1_TIMINGR_PRESC 2U | |||
#define I2C1_TIMINGR_SCLDEL 1U | |||
#define I2C1_TIMINGR_SDADEL 0U | |||
#define I2C1_TIMINGR_SCLH 9U | |||
#define I2C1_TIMINGR_SCLL 26U | |||
#define I2C1_SCL_PAL_MODE 1 | |||
#define I2C1_SDA_PAL_MODE 1 |
@ -0,0 +1,30 @@ | |||
/* Copyright 2020 QMK | |||
* | |||
* 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/>. | |||
*/ | |||
/* | |||
* This file was auto-generated by: | |||
* `qmk chibios-confmigrate -i keyboards/ferris/0_2/halconf.h -r platforms/chibios/common/configs/halconf.h` | |||
*/ | |||
#pragma once | |||
#define HAL_USE_I2C TRUE | |||
#define HAL_USE_PWM TRUE | |||
#define HAL_USE_SPI TRUE | |||
#include_next <halconf.h> |
@ -0,0 +1,255 @@ | |||
/* | |||
Copyright 2013 Oleg Kostyuk <cub.uanic@gmail.com> | |||
2020 Pierre Chevalier <pierrechevalier83@gmail.com> | |||
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/>. | |||
*/ | |||
/* | |||
* This code was heavily inspired by the ergodox_ez keymap, and modernized | |||
* to take advantage of the quantum.h microcontroller agnostics gpio control | |||
* abstractions and use the macros defined in config.h for the wiring as opposed | |||
* to repeating that information all over the place. | |||
*/ | |||
#include QMK_KEYBOARD_H | |||
#include "i2c_master.h" | |||
#include <print.h> | |||
extern i2c_status_t mcp23017_status; | |||
#define MCP23017_I2C_TIMEOUT 1000 | |||
#define I2C_WRITE 0x00 | |||
#define I2C_READ 0x01 | |||
// For a better understanding of the i2c protocol, this is a good read: | |||
// https://www.robot-electronics.co.uk/i2c-tutorial | |||
// I2C address: | |||
// See the datasheet, section 3.3.1 on addressing I2C devices and figure 3-6 for an | |||
// illustration | |||
// http://ww1.microchip.com/downloads/en/devicedoc/20001952c.pdf | |||
// All address pins of the mcp23017 are connected to the ground on the ferris | |||
// | 0 | 1 | 0 | 0 | A2 | A1 | A0 | | |||
// | 0 | 1 | 0 | 0 | 0 | 0 | 0 | | |||
#define I2C_ADDR 0b0100000 | |||
#define I2C_ADDR_WRITE ((I2C_ADDR << 1) | I2C_WRITE) | |||
#define I2C_ADDR_READ ((I2C_ADDR << 1) | I2C_READ) | |||
// Register addresses | |||
// See https://github.com/adafruit/Adafruit-MCP23017-Arduino-Library/blob/master/Adafruit_MCP23017.h | |||
#define IODIRA 0x00 // i/o direction register | |||
#define IODIRB 0x01 | |||
#define GPPUA 0x0C // GPIO pull-up resistor register | |||
#define GPPUB 0x0D | |||
#define MCP23017_GPIOA 0x12 // general purpose i/o port register (write modifies OLAT) | |||
#define MCP23017_GPIOB 0x13 | |||
#define OLATA 0x14 // output latch register | |||
#define OLATB 0x15 | |||
bool i2c_initialized = 0; | |||
i2c_status_t mcp23017_status = I2C_ADDR; | |||
#define I2C2_SCL_BANK GPIOB | |||
#define I2C2_SCL 10 | |||
#define I2C2_SDA_BANK GPIOB | |||
#define I2C2_SDA 11 | |||
uint8_t init_mcp23017(void) { | |||
print("init mcp23017\n"); | |||
mcp23017_status = I2C_ADDR; | |||
// I2C subsystem | |||
if (i2c_initialized == 0) { | |||
i2c_init(); // on pins D(1,0) | |||
i2c_initialized = true; | |||
wait_ms(MCP23017_I2C_TIMEOUT); | |||
} | |||
// set pin direction | |||
// - unused : input : 1 | |||
// - input : input : 1 | |||
// - driving : output : 0 | |||
// This means: we will read all the bits on GPIOA | |||
// This means: we will write to the pins 0-4 on GPIOB (in select_rows) | |||
uint8_t buf[] = {IODIRA, 0b11111111, 0b11110000}; | |||
print("before transmit\n"); | |||
mcp23017_status = i2c_transmit(I2C_ADDR_WRITE, buf, sizeof(buf), MCP23017_I2C_TIMEOUT); | |||
uprintf("after transmit %i\n", mcp23017_status); | |||
if (!mcp23017_status) { | |||
// set pull-up | |||
// - unused : on : 1 | |||
// - input : on : 1 | |||
// - driving : off : 0 | |||
// This means: we will read all the bits on GPIOA | |||
// This means: we will write to the pins 0-4 on GPIOB (in select_rows) | |||
uint8_t pullup_buf[] = {GPPUA, 0b11111111, 0b11110000}; | |||
mcp23017_status = i2c_transmit(I2C_ADDR_WRITE, pullup_buf, sizeof(pullup_buf), MCP23017_I2C_TIMEOUT); | |||
uprintf("after transmit2 %i\n", mcp23017_status); | |||
} | |||
return mcp23017_status; | |||
} | |||
/* matrix state(1:on, 0:off) */ | |||
static matrix_row_t matrix[MATRIX_ROWS]; // debounced values | |||
static matrix_row_t read_cols(uint8_t row); | |||
static void unselect_row(uint8_t row); | |||
static void unselect_rows(void); | |||
static void unselect_cols(void); | |||
static void select_row(uint8_t row); | |||
static uint8_t mcp23017_reset_loop; | |||
static void init_mcu_pins(void) { | |||
unselect_rows(); | |||
unselect_cols(); | |||
} | |||
void matrix_init_custom(void) { | |||
debug_enable = true; | |||
debug_matrix = true; | |||
dprint("matrix_init_custom\n"); | |||
// initialize row and col | |||
init_mcu_pins(); | |||
mcp23017_status = init_mcp23017(); | |||
// initialize matrix state: all keys off | |||
for (uint8_t i = 0; i < MATRIX_ROWS; i++) { | |||
matrix[i] = 0; | |||
} | |||
} | |||
// Reads and stores a row, returning | |||
// whether a change occurred. | |||
static inline bool store_matrix_row(matrix_row_t current_matrix[], uint8_t index) { | |||
matrix_row_t temp = read_cols(index); | |||
if (current_matrix[index] != temp) { | |||
current_matrix[index] = temp; | |||
return true; | |||
} | |||
return false; | |||
} | |||
bool matrix_scan_custom(matrix_row_t current_matrix[]) { | |||
if (mcp23017_status) { // if there was an error | |||
if (++mcp23017_reset_loop == 0) { | |||
// if (++mcp23017_reset_loop >= 1300) { | |||
// since mcp23017_reset_loop is 8 bit - we'll try to reset once in 255 matrix scans | |||
// this will be approx bit more frequent than once per second | |||
print("trying to reset mcp23017\n"); | |||
mcp23017_status = init_mcp23017(); | |||
if (mcp23017_status) { | |||
print("right side not responding\n"); | |||
} else { | |||
print("right side attached\n"); | |||
} | |||
} | |||
} | |||
bool changed = false; | |||
for (uint8_t i = 0; i < MATRIX_ROWS_PER_SIDE; i++) { | |||
// select rows from left and right hands | |||
uint8_t left_index = i; | |||
uint8_t right_index = i + MATRIX_ROWS_PER_SIDE; | |||
changed |= store_matrix_row(current_matrix, left_index); | |||
changed |= store_matrix_row(current_matrix, right_index); | |||
unselect_rows(); | |||
} | |||
return changed; | |||
} | |||
static matrix_row_t read_cols(uint8_t row) { | |||
select_row(row); | |||
if (row < MATRIX_ROWS_PER_SIDE) { | |||
pin_t matrix_col_pins_mcu[MATRIX_COLS_PER_SIDE] = MATRIX_COL_PINS_MCU; | |||
matrix_row_t current_row_value = 0; | |||
matrix_io_delay(); | |||
// For each col... | |||
for (uint8_t col_index = 0; col_index < MATRIX_COLS_PER_SIDE; col_index++) { | |||
// Select the col pin to read (active low) | |||
uint8_t pin_state = readPin(matrix_col_pins_mcu[col_index]); | |||
// Populate the matrix row with the state of the col pin | |||
current_row_value |= pin_state ? 0 : (MATRIX_ROW_SHIFTER << col_index); | |||
} | |||
unselect_row(row); | |||
return current_row_value; | |||
} else { | |||
// we don't need a 30us delay anymore, because selecting a | |||
// right-hand row requires more than 30us for i2c. | |||
if (mcp23017_status) { // if there was an error | |||
return 0; | |||
} else { | |||
uint8_t buf[] = {MCP23017_GPIOA}; | |||
mcp23017_status = i2c_transmit(I2C_ADDR_WRITE, buf, sizeof(buf), MCP23017_I2C_TIMEOUT); | |||
// We read all the pins on GPIOA. | |||
// The initial state was all ones and any depressed key at a given column for the currently selected row will have its bit flipped to zero. | |||
// The return value is a row as represented in the generic matrix code were the rightmost bits represent the lower columns and zeroes represent non-depressed keys while ones represent depressed keys. | |||
// Since the pins connected to eact columns are sequential, and counting from zero up (col 5 -> GPIOA0, col 6 -> GPIOA1 and so on), the only transformation needed is a bitwise not to swap all zeroes and ones. | |||
uint8_t data[] = {0}; | |||
if (!mcp23017_status) { | |||
mcp23017_status = i2c_receive(I2C_ADDR_READ, data, sizeof(data), MCP23017_I2C_TIMEOUT); | |||
data[0] = ~(data[0]); | |||
} | |||
return data[0]; | |||
} | |||
} | |||
} | |||
static void unselect_row(uint8_t row) { | |||
pin_t matrix_row_pins_mcu[MATRIX_ROWS_PER_SIDE] = MATRIX_ROW_PINS_MCU; | |||
setPinInputHigh(matrix_row_pins_mcu[row]); | |||
} | |||
static void unselect_rows(void) { | |||
// no need to unselect on mcp23017, because the select step sets all | |||
// the other row bits high, and it's not changing to a different | |||
// direction | |||
// unselect rows on microcontroller | |||
pin_t matrix_row_pins_mcu[MATRIX_ROWS_PER_SIDE] = MATRIX_ROW_PINS_MCU; | |||
for (int pin_index = 0; pin_index < MATRIX_ROWS_PER_SIDE; pin_index++) { | |||
pin_t pin = matrix_row_pins_mcu[pin_index]; | |||
setPinInputHigh(pin); | |||
} | |||
} | |||
static void unselect_cols(void) { | |||
pin_t matrix_col_pins_mcu[MATRIX_COLS_PER_SIDE] = MATRIX_COL_PINS_MCU; | |||
for (int pin_index = 0; pin_index < MATRIX_COLS_PER_SIDE; pin_index++) { | |||
pin_t pin = matrix_col_pins_mcu[pin_index]; | |||
setPinInputHigh(pin); | |||
} | |||
} | |||
static void select_row(uint8_t row) { | |||
if (row < MATRIX_ROWS_PER_SIDE) { | |||
// select on MCU | |||
pin_t matrix_row_pins_mcu[MATRIX_ROWS_PER_SIDE] = MATRIX_ROW_PINS_MCU; | |||
pin_t pin = matrix_row_pins_mcu[row]; | |||
setPinOutput(pin); | |||
writePinLow(pin); | |||
} else { | |||
// select on mcp23017 | |||
if (mcp23017_status) { // if there was an error | |||
// do nothing | |||
} else { | |||
// Select the desired row by writing a byte for the entire GPIOB bus where only the bit representing the row we want to select is a zero (write instruction) and every other bit is a one. | |||
// Note that the row - MATRIX_ROWS_PER_SIDE reflects the fact that being on the right hand, the columns are numbered from MATRIX_ROWS_PER_SIDE to MATRIX_ROWS, but the pins we want to write to are indexed from zero up on the GPIOB bus. | |||
uint8_t buf[] = {MCP23017_GPIOB, 0xFF & ~(1 << (row - MATRIX_ROWS_PER_SIDE))}; | |||
mcp23017_status = i2c_transmit(I2C_ADDR_WRITE, buf, sizeof(buf), I2C_TIMEOUT); | |||
} | |||
} | |||
} |
@ -0,0 +1,36 @@ | |||
/* Copyright 2020 QMK | |||
* | |||
* 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/>. | |||
*/ | |||
/* | |||
* This file was auto-generated by: | |||
* `qmk chibios-confmigrate -i keyboards/ferris/0_2/mcuconf.h -r platforms/chibios/GENERIC_STM32_F072XB/configs/mcuconf.h` | |||
*/ | |||
#pragma once | |||
#include_next <mcuconf.h> | |||
#undef STM32_I2C_USE_I2C2 | |||
#define STM32_I2C_USE_I2C2 TRUE | |||
#undef STM32_I2C_USE_DMA | |||
#define STM32_I2C_USE_DMA FALSE | |||
#undef STM32_PWM_USE_TIM3 | |||
#define STM32_PWM_USE_TIM3 TRUE | |||
#undef STM32_SPI_USE_SPI2 | |||
#define STM32_SPI_USE_SPI2 TRUE |
@ -0,0 +1,17 @@ | |||
# Ferris 0.2 | |||
![Ferris 0.2 - bling, top view](https://i.imgur.com/LwKlmnzh.jpg) | |||
![Ferris 0.2 - bling, bottom view](https://i.imgur.com/qGnYGVOh.jpg) | |||
An stm32f072 based split 34 keys column staggered keyboard named and decorated after the rustlang mascott. All PCB files and some thoughts on the design are available on the [project's github page](https://github.com/pierrechevalier83/ferris) | |||
* Keyboard Maintainer: [Pierre Chevalier](https://github.com/pierrechevalier83) | |||
* Hardware Supported: | |||
* Ferris 0.2: stm32f072 chip. Comes in 4 variants: bling, mini, high and compact | |||
* Hardware Availability: Pierre Chevalier has been selling keyboard kits (see the #ferris channel in the 40% discord chat). Wider availability is on the horizon. | |||
Make examples for this keyboard (after setting up your build environment): | |||
make ferris/0_2: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). |
@ -0,0 +1,25 @@ | |||
# MCU name | |||
MCU = STM32F072 | |||
# change yes to no to disable | |||
# | |||
BOOTMAGIC_ENABLE = lite # Virtual DIP switch configuration | |||
MOUSEKEY_ENABLE = yes # Mouse keys | |||
EXTRAKEY_ENABLE = yes # Audio control and System control | |||
CONSOLE_ENABLE = no # Console for debug | |||
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 | |||
BACKLIGHT_ENABLE = no # Enable keyboard backlight functionality | |||
RGBLIGHT_ENABLE = no # Enable keyboard RGB underglow | |||
BLUETOOTH_ENABLE = no # Enable Bluetooth | |||
AUDIO_ENABLE = no # Audio output | |||
UNICODE_ENABLE = yes | |||
CUSTOM_MATRIX = lite | |||
NO_USB_STARTUP_CHECK = yes | |||
LTO_ENABLE = no | |||
SRC += matrix.c | |||
QUANTUM_LIB_SRC += i2c_master.c |
@ -0,0 +1,20 @@ | |||
/* | |||
Copyright 2021 Pierre Chevalier <pierrechevalier83@gmail.com> | |||
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 | |||
#define DEBUG_MATRIX_SCAN_RATE |
@ -0,0 +1,13 @@ | |||
#include QMK_KEYBOARD_H | |||
void matrix_init_user(void) { | |||
debug_enable=true; | |||
debug_matrix=true; | |||
//debug_keyboard=true; | |||
//debug_mouse=true; | |||
} | |||
const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = { | |||
[0] = LAYOUT(KC_Q, KC_W, KC_E, KC_R, KC_T, KC_Y, KC_U, KC_I, KC_O, KC_P, KC_A, KC_S, KC_D, KC_F, KC_G, KC_H, KC_J, KC_K, KC_L, KC_SCLN, KC_Z, KC_X, KC_C, KC_V, KC_B, KC_N, KC_M, KC_COMM, KC_DOT, KC_SLSH, KC_P0, DEBUG, KC_P2, KC_P3) | |||
}; | |||
@ -0,0 +1,5 @@ | |||
# A test keymap for the Ferris keyboard | |||
This keymap is not intended to be used to use the Ferris as a usable keyboard, but rather it is meant to be a very simple keymap used to test the hardware works properly. It can also be used to test firmware being written for new versions with a minimum amount of complexity coming from the keymap itself. | |||
The keymap is composed of a single qwerty layer with a unique digit bound to each non-alpha key. |
@ -0,0 +1 @@ | |||
CONSOLE_ENABLE = yes |
@ -1,19 +1,20 @@ | |||
# Ferris | |||
![Ferris, top view](https://imgur.com/V4QuaGs.jpg) | |||
![Ferris, bottom view](https://i.imgur.com/7DJYME8.jpg) | |||
![Ferris, familly pic](https://i.imgur.com/TCjkquRh.jpeg) | |||
A split 34 keys column staggered keyboard named and decorated after the rustlang mascott. All PCB files and some thoughts on the design are available on the [project's github page](https://github.com/pierrechevalier83/ferris) | |||
* Keyboard Maintainer: [Pierre Chevalier](https://github.com/pierrechevalier83) | |||
* Hardware Supported: | |||
* Ferris 0.1 (With atmega32u4 chip. Comes in 4 variants: base, low, high and compact) | |||
* Ferris 0.2 (With stm32f072 chip. Comes in 4 variants: bling, mini, high and compact) | |||
* Ferris sweep (With pro-micro. Comes in a couple of PCB edge cuts shapes, but with identical pinout) | |||
* Hardware Availability: Pierre Chevalier has been selling keyboard kits (see the #ferris channel in the 40% discord chat). Wider availability is on the horizon. | |||
Make examples for this keyboard (after setting up your build environment): | |||
make ferris/0_1:default | |||
make ferris/0_2:default | |||
make ferris/sweep:default:avrdude-split-right | |||
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). |
@ -0,0 +1,18 @@ | |||
# Ferris sweep | |||
![Ferris sweep, top view](https://i.imgur.com/5qCZUv6h.jpg) | |||
![Ferris sweep, bottom view](https://i.imgur.com/ZC47CJth.jpg) | |||
A version of the Ferris keyboard that uses a daughterboard, designed by the fantastic @davidphilipbarr with some input from @pierrechevalier83 for the copper pad. All PCB files are available on the [project's github page](https://github.com/davidphilipbarr/Sweep) | |||
* Keyboard Maintainer: [Pierre Chevalier](https://github.com/pierrechevalier83) | |||
* Hardware Supported: | |||
* Ferris sweep (With pro-micro. Comes in a couple of PCB edge cuts shapes, but with identical pinout) | |||
* Hardware Availability: @iamnotyourbroom in the 40% discord chat server may have some spares for you. | |||
Make examples for this keyboard (after setting up your build environment): | |||
make ferris/sweep:default:avrdude-split-left | |||
make ferris/sweep:default:avrdude-split-right | |||
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). |