Skip to content

Commit 23becac

Browse files
pierrechevalier83pierrechevalier83
authored
Support all the 0.2 Ferris variants (#12653)
* Support all the 0.2 Ferris variants For the Compact, the High and the Mini, create a new directory so each keyboard may have the correct USB descriptor and a readme with more specific information about it. For the Bling, also add support for the underglow functionality. Change the "MANUFACTURER" string to "Cuddly Keyboards Ltd.", the name of the company I incorporated to sell keyboards, and change the default descriptor from "Ferris the keeb" to "Ferris 0.2" which is more descriptive. I didn't update the 0.1 variants as I don't intend to sell these kits with "Cuddly Keyboards". The firmware is mostly there to support existing users. Update the "hardware availability" to point to my new website: cuddlykeyboards.com. * Add RGB mode toggle to my keymap and to the default keymap * Improve wording in the readme
1 parent 5a59363 commit 23becac

File tree

21 files changed

+288
-11
lines changed

21 files changed

+288
-11
lines changed

‎keyboards/ferris/0_2/bling/bling.c

Lines changed: 77 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,77 @@
1+
/*
2+
Copyright 2021 Pierre Chevalier <[email protected]>
3+
4+
This program is free software: you can redistribute it and/or modify
5+
it under the terms of the GNU General Public License as published by
6+
the Free Software Foundation, either version 2 of the License, or
7+
(at your option) any later version.
8+
9+
This program is distributed in the hope that it will be useful,
10+
but WITHOUT ANY WARRANTY; without even the implied warranty of
11+
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12+
GNU General Public License for more details.
13+
14+
You should have received a copy of the GNU General Public License
15+
along with this program. If not, see <http://www.gnu.org/licenses/>.
16+
*/
17+
#include "quantum.h"
18+
19+
#include "drivers/issi/is31fl3731.h"
20+
21+
/*
22+
| Left || Right |
23+
| | 3 | | 0 || 0 | | 3 | |
24+
| 5 | | | || | | | 6 |
25+
| | | | || | | | |
26+
| | | | 1 || 1 | | | |
27+
| | 4 | | || | | 4 | |
28+
| 6 | | | 2 || 2 | | | 5 |
29+
*/
30+
const is31_led g_is31_leds[DRIVER_LED_TOTAL] = {
31+
/* Refer to IS31 manual for these locations
32+
* driver
33+
* | R location
34+
* | | G location
35+
* | | | B location
36+
* | | | | */
37+
{0, C9_10, C8_10, C7_10}, // Left RGB 5
38+
{0, C9_12, C8_12, C7_12}, // Left RGB 3
39+
{0, C9_15, C8_15, C6_14}, // Left RGB 0
40+
{1, C1_2, C2_2, C4_3}, // Right RGB 0
41+
{1, C1_5, C2_5, C3_5}, // Right RGB 3
42+
{1, C1_8, C2_8, C3_8}, // Right RGB 6
43+
{1, C1_7, C2_7, C3_7}, // Right RGB 5
44+
{1, C1_6, C2_6, C3_6}, // Right RGB 4
45+
{1, C1_3, C2_3, C3_3}, // Right RGB 1
46+
{1, C1_4, C2_4, C3_4}, // Right RGB 2
47+
{0, C9_13, C8_13, C7_13}, // Left RGB 2
48+
{0, C9_14, C8_14, C7_14}, // Left RGB 1
49+
{0, C9_11, C8_11, C7_11}, // Left RGB 4
50+
{0, C9_9, C8_9, C7_9}, // Left RGB 6
51+
};
52+
// clang-format off
53+
led_config_t g_led_config = {
54+
// Key Matrix to LED Index
55+
{
56+
{},
57+
}, {
58+
// LED Index to Physical Position. The unit is roughly milimiters in the real world
59+
// | Left || Right |
60+
// x->| 10 | 32 | 64 || 160 | 192 | 214 |
61+
// y |_____|_____|____||_____|_____|_____|
62+
// 0 | | 1 | 2 || 3 | 4 | |
63+
// 16 | 0 | | || | | 5 |
64+
// 35 | | | 11 || 8 | | |
65+
// 45 | | 12 | || | 7 | |
66+
// 50 | 13 | | 10 || 9 | | 6 |
67+
// 0 1 2 3 4 5
68+
{10, 16}, {32, 0}, {64, 0}, {160, 0}, {192, 0}, {214, 16},
69+
// 6 7 8 9
70+
{214, 50}, {192, 45}, {160, 35}, {160, 50},
71+
// 10 11 12 13
72+
{64, 50}, {64, 35}, {32, 45}, {10, 50},
73+
}, {
74+
// LED Index to Flag
75+
4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4
76+
}
77+
};

‎keyboards/ferris/0_2/bling/config.h

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
/*
2+
Copyright 2021 Pierre Chevalier <[email protected]>
3+
4+
This program is free software: you can redistribute it and/or modify
5+
it under the terms of the GNU General Public License as published by
6+
the Free Software Foundation, either version 2 of the License, or
7+
(at your option) any later version.
8+
9+
This program is distributed in the hope that it will be useful,
10+
but WITHOUT ANY WARRANTY; without even the implied warranty of
11+
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12+
GNU General Public License for more details.
13+
14+
You should have received a copy of the GNU General Public License
15+
along with this program. If not, see <http://www.gnu.org/licenses/>.
16+
*/
17+
18+
#pragma once
19+
20+
#undef PRODUCT_ID
21+
#define PRODUCT_ID 0x0002
22+
#undef PRODUCT
23+
#define PRODUCT Ferris 0.2 - Bling
24+
25+
26+
27+
/* LED Drivers */
28+
#define DRIVER_ADDR_1 0b1110100
29+
#define DRIVER_ADDR_2 0b1110101
30+
#define DRIVER_COUNT 2
31+
#define DRIVER_1_LED_TOTAL 7
32+
#define DRIVER_2_LED_TOTAL 7
33+
#define DRIVER_LED_TOTAL (DRIVER_1_LED_TOTAL + DRIVER_2_LED_TOTAL)
34+

‎keyboards/ferris/0_2/bling/readme.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
# Ferris 0.2 - Bling
2+
3+
![Ferris 0.2 - Bling](https://i.imgur.com/8dmm5Mrh.jpg)
4+
5+
Ferris 0.2 with RGB underglow.
6+
7+
* Keyboard Maintainer: [Pierre Chevalier](https://github.com/pierrechevalier83)
8+
* Hardware Supported:
9+
* Ferris 0.2 - Bling: (STM32F072 MCU on the left, MCP23017 on the right, IS31FL3731 led driver chip on each side)
10+
* Hardware Availability: [Cuddly Keyboards](https://cuddlykeyboards.com)
11+
12+
Make examples for this keyboard (after setting up your build environment):
13+
14+
make ferris/0_2/bling:default
15+
16+
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).

‎keyboards/ferris/0_2/bling/rules.mk

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
RGB_MATRIX_ENABLE = yes
2+
RGB_MATRIX_DRIVER = IS31FL3731

‎keyboards/ferris/0_2/compact/config.h

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
/*
2+
Copyright 2021 Pierre Chevalier <[email protected]>
3+
4+
This program is free software: you can redistribute it and/or modify
5+
it under the terms of the GNU General Public License as published by
6+
the Free Software Foundation, either version 2 of the License, or
7+
(at your option) any later version.
8+
9+
This program is distributed in the hope that it will be useful,
10+
but WITHOUT ANY WARRANTY; without even the implied warranty of
11+
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12+
GNU General Public License for more details.
13+
14+
You should have received a copy of the GNU General Public License
15+
along with this program. If not, see <http://www.gnu.org/licenses/>.
16+
*/
17+
18+
#pragma once
19+
20+
#undef PRODUCT_ID
21+
#define PRODUCT_ID 0x0003
22+
#undef PRODUCT
23+
#define PRODUCT Ferris 0.2 - Compact

‎keyboards/ferris/0_2/compact/readme.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# Ferris 0.2 - Compact
2+
3+
![Ferris 0.2 - Compact, top view](https://i.imgur.com/V2ZLKjih.jpg)
4+
![Ferris 0.2 - Compact, bottom view](https://i.imgur.com/3icP8pzh.jpg)
5+
6+
Ferris 0.2 - Compact with Kailh Choc support and Choc spacing.
7+
8+
* Keyboard Maintainer: [Pierre Chevalier](https://github.com/pierrechevalier83)
9+
* Hardware Supported:
10+
* Ferris 0.2 - Compact: (STM32F072 MCU on the left, MCP23017 on the right)
11+
* Hardware Availability: [Cuddly Keyboards](https://cuddlykeyboards.com)
12+
13+
Make examples for this keyboard (after setting up your build environment):
14+
15+
make ferris/0_2/compact:default
16+
17+
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).

‎keyboards/ferris/0_2/compact/rules.mk

Whitespace-only changes.

‎keyboards/ferris/0_2/config.h

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,8 +21,8 @@ along with this program. If not, see <http://www.gnu.org/licenses/>.
2121
#define VENDOR_ID 0xC2AB
2222
#define PRODUCT_ID 0x0001
2323
#define DEVICE_VER 0x0002
24-
#define MANUFACTURER Pierre
25-
#define PRODUCT Ferris the keeb
24+
#define MANUFACTURER Cuddly Keyboards Ltd.
25+
#define PRODUCT Ferris 0.2
2626

2727
/* key matrix size */
2828
#define MATRIX_ROWS 8

‎keyboards/ferris/0_2/high/config.h

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
/*
2+
Copyright 2021 Pierre Chevalier <[email protected]>
3+
4+
This program is free software: you can redistribute it and/or modify
5+
it under the terms of the GNU General Public License as published by
6+
the Free Software Foundation, either version 2 of the License, or
7+
(at your option) any later version.
8+
9+
This program is distributed in the hope that it will be useful,
10+
but WITHOUT ANY WARRANTY; without even the implied warranty of
11+
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12+
GNU General Public License for more details.
13+
14+
You should have received a copy of the GNU General Public License
15+
along with this program. If not, see <http://www.gnu.org/licenses/>.
16+
*/
17+
18+
#pragma once
19+
20+
#undef PRODUCT_ID
21+
#define PRODUCT_ID 0x0005
22+
#undef PRODUCT
23+
#define PRODUCT Ferris 0.2 - High

‎keyboards/ferris/0_2/high/readme.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# Ferris 0.2 - High
2+
3+
![Ferris 0.2 - High, top view](https://i.imgur.com/aOqVmvph.jpg)
4+
![Ferris 0.2 - High, bottom view](https://i.imgur.com/Nuqy5uJh.jpg)
5+
6+
Ferris 0.2 - High with Cherry MX support.
7+
8+
* Keyboard Maintainer: [Pierre Chevalier](https://github.com/pierrechevalier83)
9+
* Hardware Supported:
10+
* Ferris 0.2 - High: (STM32F072 MCU on the left, MCP23017 on the right)
11+
* Hardware Availability: [Cuddly Keyboards](https://cuddlykeyboards.com)
12+
13+
Make examples for this keyboard (after setting up your build environment):
14+
15+
make ferris/0_2/high:default
16+
17+
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).

‎keyboards/ferris/0_2/high/rules.mk

Whitespace-only changes.

‎keyboards/ferris/0_2/mini/config.h

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
/*
2+
Copyright 2021 Pierre Chevalier <[email protected]>
3+
4+
This program is free software: you can redistribute it and/or modify
5+
it under the terms of the GNU General Public License as published by
6+
the Free Software Foundation, either version 2 of the License, or
7+
(at your option) any later version.
8+
9+
This program is distributed in the hope that it will be useful,
10+
but WITHOUT ANY WARRANTY; without even the implied warranty of
11+
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12+
GNU General Public License for more details.
13+
14+
You should have received a copy of the GNU General Public License
15+
along with this program. If not, see <http://www.gnu.org/licenses/>.
16+
*/
17+
18+
#pragma once
19+
20+
#undef PRODUCT_ID
21+
#define PRODUCT_ID 0x0004
22+
#undef PRODUCT
23+
#define PRODUCT Ferris 0.2 - Mini

‎keyboards/ferris/0_2/mini/readme.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
# Ferris 0.2 - Mini
2+
3+
![Ferris 0.2 - Mini, top view](https://i.imgur.com/s3luptVh.jpg)
4+
![Ferris 0.2 - Mini, bottom view](https://i.imgur.com/D4GxLQvh.jpg)
5+
6+
7+
Ferris 0.2 - Mini with Kailh Choc Mini support and Choc spacing.
8+
9+
* Keyboard Maintainer: [Pierre Chevalier](https://github.com/pierrechevalier83)
10+
* Hardware Supported:
11+
* Ferris 0.2 - Mini: (STM32F072 MCU on the left, MCP23017 on the right)
12+
* Hardware Availability: [Cuddly Keyboards](https://cuddlykeyboards.com)
13+
14+
Make examples for this keyboard (after setting up your build environment):
15+
16+
make ferris/0_2/mini:default
17+
18+
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).

‎keyboards/ferris/0_2/mini/rules.mk

Whitespace-only changes.

‎keyboards/ferris/0_2/readme.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,13 @@
11
# Ferris 0.2
22

3-
![Ferris 0.2 - bling, top view](https://i.imgur.com/LwKlmnzh.jpg)
4-
![Ferris 0.2 - bling, bottom view](https://i.imgur.com/qGnYGVOh.jpg)
3+
![Ferris 0.2 family](https://i.imgur.com/SDVOlyZ.jpg)
54

6-
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)
5+
An STM32F072-based split 34-key column-staggered keyboard named and decorated after the Rust mascot. All PCB files and some thoughts on the design are available on the [project's github page](https://github.com/pierrechevalier83/ferris).
76

87
* Keyboard Maintainer: [Pierre Chevalier](https://github.com/pierrechevalier83)
98
* Hardware Supported:
109
* Ferris 0.2: stm32f072 chip. Comes in 4 variants: bling, mini, high and compact
11-
* Hardware Availability: Pierre Chevalier has been selling keyboard kits (see the #ferris channel in the 40% discord chat). Wider availability is on the horizon.
10+
* Hardware Availability: [Cuddly Keyboards](https://cuddlykeyboards.com)
1211

1312
Make examples for this keyboard (after setting up your build environment):
1413

‎keyboards/ferris/keymaps/default/config.h

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,3 +37,11 @@ along with this program. If not, see <http://www.gnu.org/licenses/>.
3737
#define PERMISSIVE_HOLD
3838
#define IGNORE_MOD_TAP_INTERRUPT
3939
#define TAPPING_FORCE_HOLD
40+
41+
// Underglow configuration
42+
#ifdef RGBLIGHT_ENABLE
43+
#define RGBLIGHT_ANIMATIONS
44+
#define RGBLIGHT_HUE_STEP 8
45+
#define RGBLIGHT_SAT_STEP 8
46+
#define RGBLIGHT_VAL_STEP 8
47+
#endif

‎keyboards/ferris/keymaps/default/keymap.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -50,8 +50,8 @@
5050
"KC_TRNS" , "KC_TRNS" , "KC_TRNS" , "KC_TRNS" , "KC_TRNS",
5151
"KC_TRNS" , "KC_MINS" , "KC_BSLS" , "KC_GRV" , "KC_TRNS",
5252

53-
"KC_TRNS" , "KC_TRNS",
54-
"KC_TRNS" , "KC_TRNS"
53+
"RGB_RMOD" , "KC_TRNS",
54+
"KC_TRNS" , "RGB_MOD"
5555
],
5656
["KC_TRNS" , "KC_COLN" , "KC_LT" , "KC_GT" , "KC_SCLN",
5757
"KC_TRNS" , "KC_TRNS" , "KC_TRNS" , "KC_TRNS" , "KC_TRNS",

‎keyboards/ferris/keymaps/pierrec83/config.h

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,3 +37,11 @@ along with this program. If not, see <http://www.gnu.org/licenses/>.
3737
#define PERMISSIVE_HOLD
3838
#define IGNORE_MOD_TAP_INTERRUPT
3939
#define TAPPING_FORCE_HOLD
40+
41+
// Underglow configuration
42+
#ifdef RGBLIGHT_ENABLE
43+
#define RGBLIGHT_ANIMATIONS
44+
#define RGBLIGHT_HUE_STEP 8
45+
#define RGBLIGHT_SAT_STEP 8
46+
#define RGBLIGHT_VAL_STEP 8
47+
#endif

‎keyboards/ferris/keymaps/pierrec83/keymap.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -50,8 +50,8 @@
5050
"KC_TRNS" , "KC_HOME" , "KC_PGDN" , "KC_END" , "KC_TRNS",
5151
"KC_TRNS" , "KC_TRNS" , "KC_TRNS" , "KC_TRNS" , "KC_TRNS",
5252

53-
"LGUI(KC_LEFT)" , "KC_TRNS",
54-
"KC_TRNS" , "LGUI(KC_RGHT)"
53+
"RGB_RMOD" , "KC_TRNS",
54+
"KC_TRNS" , "RGB_MOD"
5555
],
5656
["KC_TRNS" , "KC_TRNS" , "KC_TRNS" , "KC_TRNS" , "KC_TRNS",
5757
"KC_TRNS" , "KC_UNDS" , "KC_PIPE" , "KC_QUOT" , "KC_TRNS",

‎keyboards/ferris/keymaps/test/config.h

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,3 +18,11 @@ along with this program. If not, see <http://www.gnu.org/licenses/>.
1818
#pragma once
1919

2020
#define DEBUG_MATRIX_SCAN_RATE
21+
22+
// Underglow configuration
23+
#ifdef RGBLIGHT_ENABLE
24+
#define RGBLIGHT_ANIMATIONS
25+
#define RGBLIGHT_HUE_STEP 8
26+
#define RGBLIGHT_SAT_STEP 8
27+
#define RGBLIGHT_VAL_STEP 8
28+
#endif

‎keyboards/ferris/readme.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,12 +9,16 @@ A split 34 keys column staggered keyboard named and decorated after the rustlang
99
* Ferris 0.1 (With atmega32u4 chip. Comes in 4 variants: base, low, high and compact)
1010
* Ferris 0.2 (With stm32f072 chip. Comes in 4 variants: bling, mini, high and compact)
1111
* Ferris sweep (With pro-micro. Comes in a couple of PCB edge cuts shapes, but with identical pinout)
12-
* Hardware Availability: Pierre Chevalier has been selling keyboard kits (see the #ferris channel in the 40% discord chat). Wider availability is on the horizon.
12+
* Hardware Availability: [Cuddly Keyboards](https://cuddlykeyboards.com)
1313

1414
Make examples for this keyboard (after setting up your build environment):
1515

1616
make ferris/0_1:default
1717
make ferris/0_2:default
18+
make ferris/0_2/bling:default
19+
make ferris/0_2/compact:default
20+
make ferris/0_2/mini:default
21+
make ferris/0_2/high:default
1822
make ferris/sweep:default:avrdude-split-right
1923

2024
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 commit comments

Comments
 (0)