From 93142bdc8bad31736a57708c50d687cbf250a017 Mon Sep 17 00:00:00 2001 From: Andrew Kannan Date: Tue, 7 Apr 2020 00:42:15 -0400 Subject: [PATCH 1/5] Add revision 1 and revision 2 to ProjectKB Alice PCB --- keyboards/projectkb/alice/alice.c | 12 +-- keyboards/projectkb/alice/readme.md | 2 +- keyboards/projectkb/alice/{ => rev1}/config.h | 3 + keyboards/projectkb/alice/rev1/rules.mk | 22 +++++ keyboards/projectkb/alice/rev2/config.h | 85 +++++++++++++++++++ keyboards/projectkb/alice/rev2/rules.mk | 22 +++++ keyboards/projectkb/alice/rules.mk | 1 + 7 files changed, 140 insertions(+), 7 deletions(-) rename keyboards/projectkb/alice/{ => rev1}/config.h (96%) create mode 100644 keyboards/projectkb/alice/rev1/rules.mk create mode 100644 keyboards/projectkb/alice/rev2/config.h create mode 100644 keyboards/projectkb/alice/rev2/rules.mk diff --git a/keyboards/projectkb/alice/alice.c b/keyboards/projectkb/alice/alice.c index ca0c7da2be2e..b82e2050e397 100644 --- a/keyboards/projectkb/alice/alice.c +++ b/keyboards/projectkb/alice/alice.c @@ -1,17 +1,17 @@ #include "alice.h" void matrix_init_board(void){ - setPinOutput(A0); - setPinOutput(A1); - setPinOutput(A2); + setPinOutput(INDICATOR_PIN_0); + setPinOutput(INDICATOR_PIN_1); + setPinOutput(INDICATOR_PIN_2); } bool led_update_kb(led_t led_state) { bool runDefault = led_update_user(led_state); if (runDefault) { - writePin(A0, !led_state.num_lock); - writePin(A1, !led_state.caps_lock); - writePin(A2, !led_state.scroll_lock); + writePin(INDICATOR_PIN_0, !led_state.num_lock); + writePin(INDICATOR_PIN_1, !led_state.caps_lock); + writePin(INDICATOR_PIN_2, !led_state.scroll_lock); } return runDefault; } diff --git a/keyboards/projectkb/alice/readme.md b/keyboards/projectkb/alice/readme.md index 583ddf592030..193343b315cf 100644 --- a/keyboards/projectkb/alice/readme.md +++ b/keyboards/projectkb/alice/readme.md @@ -7,7 +7,7 @@ Keyboard Maintainer: onefiftynine Hardware Supported: STM32F072CBT6 Make example for this keyboard (after setting up your build environment): - make projectkb/alice:default + make projectkb/alice/rev2:default If you are flashing this keyboard/pcb for the first time: diff --git a/keyboards/projectkb/alice/config.h b/keyboards/projectkb/alice/rev1/config.h similarity index 96% rename from keyboards/projectkb/alice/config.h rename to keyboards/projectkb/alice/rev1/config.h index 11863b807784..549af2928853 100644 --- a/keyboards/projectkb/alice/config.h +++ b/keyboards/projectkb/alice/rev1/config.h @@ -58,6 +58,9 @@ along with this program. If not, see . #define WS2812_SPI SPID2 #define WS2812_SPI_MOSI_PAL_MODE 0 +#define INDICATOR_PIN_0 A0 +#define INDICATOR_PIN_1 A1 +#define INDICATOR_PIN_2 A2 // 2 bits for 4 layout options #define VIA_EEPROM_LAYOUT_OPTIONS_SIZE 2 diff --git a/keyboards/projectkb/alice/rev1/rules.mk b/keyboards/projectkb/alice/rev1/rules.mk new file mode 100644 index 000000000000..0f9d71b89055 --- /dev/null +++ b/keyboards/projectkb/alice/rev1/rules.mk @@ -0,0 +1,22 @@ +# MCU name +MCU = STM32F072 + +# Build Options +# comment out to disable the options. +# + +BOOTMAGIC_ENABLE = lite # Virtual DIP switch configuration +MOUSEKEY_ENABLE = yes # Mouse keys +EXTRAKEY_ENABLE = yes # Audio control and System control +CONSOLE_ENABLE = yes # Console for debug +COMMAND_ENABLE = yes # Commands for debug and configuration +SLEEP_LED_ENABLE = yes # Breathing sleep LED during USB suspend +NKRO_ENABLE = yes # USB Nkey Rollover +CUSTOM_MATRIX = no # Custom matrix file +BACKLIGHT_ENABLE = yes +RGBLIGHT_ENABLE = yes +WS2812_DRIVER = spi + + +# Enter lower-power sleep mode when on the ChibiOS idle thread +OPT_DEFS += -DCORTEX_ENABLE_WFI_IDLE=TRUE diff --git a/keyboards/projectkb/alice/rev2/config.h b/keyboards/projectkb/alice/rev2/config.h new file mode 100644 index 000000000000..eb3332026381 --- /dev/null +++ b/keyboards/projectkb/alice/rev2/config.h @@ -0,0 +1,85 @@ +/* +Copyright 2015 Jun Wako + +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 . +*/ + +#pragma once + +/* USB Device descriptor parameter */ +#define VENDOR_ID 0x0159 +#define PRODUCT_ID 0xA71C +#define DEVICE_VER 0x0001 +#define MANUFACTURER ProjectKB +#define PRODUCT Alice +#define DESCRIPTION ProjectKB Alice + +/* key matrix size */ +#define MATRIX_ROWS 5 +#define MATRIX_COLS 16 + +#define MATRIX_COL_PINS { B1, B0, A7, A1, A5, A4, A3, A10, B9, B8, B7, B6, B5, B4, B3, A15 } +#define MATRIX_ROW_PINS { B2, B10, B11, A2, A0 } +#define DIODE_DIRECTION COL2ROW + +#define BACKLIGHT_PIN A6 +#define BACKLIGHT_PWM_DRIVER PWMD3 +#define BACKLIGHT_PWM_CHANNEL 1 +#define BACKLIGHT_PAL_MODE 1 +#define BACKLIGHT_LEVELS 6 +#define BACKLIGHT_BREATHING +#define BREATHING_PERIOD 6 + +/* define if matrix has ghost */ +//#define MATRIX_HAS_GHOST + +/* Set 0 if debouncing isn't needed */ +#define DEBOUNCE 5 + +/* Mechanical locking support. Use KC_LCAP, KC_LNUM or KC_LSCR instead in keymap */ +#define LOCKING_SUPPORT_ENABLE +/* Locking resynchronize hack */ +#define LOCKING_RESYNC_ENABLE + +#define RGBLIGHT_ANIMATIONS +#define RGB_DI_PIN B15 +#define RGBLED_NUM 14 +#define WS2812_SPI SPID2 +#define WS2812_SPI_MOSI_PAL_MODE 0 + +#define INDICATOR_PIN_0 A9 +#define INDICATOR_PIN_1 A8 +#define INDICATOR_PIN_2 B12 + + +// 2 bits for 4 layout options +#define VIA_EEPROM_LAYOUT_OPTIONS_SIZE 2 + +/* + * Feature disable options + * These options are also useful to firmware size reduction. + */ + +/* disable debug print */ +//#define NO_DEBUG + +/* disable print */ +//#define NO_PRINT + +/* disable action features */ +//#define NO_ACTION_LAYER +//#define NO_ACTION_TAPPING +//#define NO_ACTION_ONESHOT +//#define NO_ACTION_MACRO +//#define NO_ACTION_FUNCTION diff --git a/keyboards/projectkb/alice/rev2/rules.mk b/keyboards/projectkb/alice/rev2/rules.mk new file mode 100644 index 000000000000..0f9d71b89055 --- /dev/null +++ b/keyboards/projectkb/alice/rev2/rules.mk @@ -0,0 +1,22 @@ +# MCU name +MCU = STM32F072 + +# Build Options +# comment out to disable the options. +# + +BOOTMAGIC_ENABLE = lite # Virtual DIP switch configuration +MOUSEKEY_ENABLE = yes # Mouse keys +EXTRAKEY_ENABLE = yes # Audio control and System control +CONSOLE_ENABLE = yes # Console for debug +COMMAND_ENABLE = yes # Commands for debug and configuration +SLEEP_LED_ENABLE = yes # Breathing sleep LED during USB suspend +NKRO_ENABLE = yes # USB Nkey Rollover +CUSTOM_MATRIX = no # Custom matrix file +BACKLIGHT_ENABLE = yes +RGBLIGHT_ENABLE = yes +WS2812_DRIVER = spi + + +# Enter lower-power sleep mode when on the ChibiOS idle thread +OPT_DEFS += -DCORTEX_ENABLE_WFI_IDLE=TRUE diff --git a/keyboards/projectkb/alice/rules.mk b/keyboards/projectkb/alice/rules.mk index 0f9d71b89055..42b5a1086a8e 100644 --- a/keyboards/projectkb/alice/rules.mk +++ b/keyboards/projectkb/alice/rules.mk @@ -17,6 +17,7 @@ BACKLIGHT_ENABLE = yes RGBLIGHT_ENABLE = yes WS2812_DRIVER = spi +DEFAULT_FOLDER = projectkb/alice/rev2 # Enter lower-power sleep mode when on the ChibiOS idle thread OPT_DEFS += -DCORTEX_ENABLE_WFI_IDLE=TRUE From 1fd6764e79a6eb3a5988bd3467a311bdde84bbfc Mon Sep 17 00:00:00 2001 From: Andrew Kannan Date: Sat, 11 Apr 2020 18:19:43 -0400 Subject: [PATCH 2/5] Swap SLEEP LED to no --- keyboards/projectkb/alice/rev1/rules.mk | 2 +- keyboards/projectkb/alice/rev2/rules.mk | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/keyboards/projectkb/alice/rev1/rules.mk b/keyboards/projectkb/alice/rev1/rules.mk index 0f9d71b89055..964b5c58cc60 100644 --- a/keyboards/projectkb/alice/rev1/rules.mk +++ b/keyboards/projectkb/alice/rev1/rules.mk @@ -10,7 +10,7 @@ MOUSEKEY_ENABLE = yes # Mouse keys EXTRAKEY_ENABLE = yes # Audio control and System control CONSOLE_ENABLE = yes # Console for debug COMMAND_ENABLE = yes # Commands for debug and configuration -SLEEP_LED_ENABLE = yes # Breathing sleep LED during USB suspend +SLEEP_LED_ENABLE = no # Breathing sleep LED during USB suspend NKRO_ENABLE = yes # USB Nkey Rollover CUSTOM_MATRIX = no # Custom matrix file BACKLIGHT_ENABLE = yes diff --git a/keyboards/projectkb/alice/rev2/rules.mk b/keyboards/projectkb/alice/rev2/rules.mk index 0f9d71b89055..964b5c58cc60 100644 --- a/keyboards/projectkb/alice/rev2/rules.mk +++ b/keyboards/projectkb/alice/rev2/rules.mk @@ -10,7 +10,7 @@ MOUSEKEY_ENABLE = yes # Mouse keys EXTRAKEY_ENABLE = yes # Audio control and System control CONSOLE_ENABLE = yes # Console for debug COMMAND_ENABLE = yes # Commands for debug and configuration -SLEEP_LED_ENABLE = yes # Breathing sleep LED during USB suspend +SLEEP_LED_ENABLE = no # Breathing sleep LED during USB suspend NKRO_ENABLE = yes # USB Nkey Rollover CUSTOM_MATRIX = no # Custom matrix file BACKLIGHT_ENABLE = yes From 775cb50d2834e7246f7cc5f3d4ba5661ce20d618 Mon Sep 17 00:00:00 2001 From: Andrew Kannan Date: Sun, 12 Apr 2020 11:46:57 -0400 Subject: [PATCH 3/5] Basic root rules.mk --- keyboards/projectkb/alice/rules.mk | 21 --------------------- 1 file changed, 21 deletions(-) diff --git a/keyboards/projectkb/alice/rules.mk b/keyboards/projectkb/alice/rules.mk index 42b5a1086a8e..927ab7abefd3 100644 --- a/keyboards/projectkb/alice/rules.mk +++ b/keyboards/projectkb/alice/rules.mk @@ -1,23 +1,2 @@ -# MCU name -MCU = STM32F072 - -# Build Options -# comment out to disable the options. -# - -BOOTMAGIC_ENABLE = lite # Virtual DIP switch configuration -MOUSEKEY_ENABLE = yes # Mouse keys -EXTRAKEY_ENABLE = yes # Audio control and System control -CONSOLE_ENABLE = yes # Console for debug -COMMAND_ENABLE = yes # Commands for debug and configuration -SLEEP_LED_ENABLE = yes # Breathing sleep LED during USB suspend -NKRO_ENABLE = yes # USB Nkey Rollover -CUSTOM_MATRIX = no # Custom matrix file -BACKLIGHT_ENABLE = yes -RGBLIGHT_ENABLE = yes -WS2812_DRIVER = spi - DEFAULT_FOLDER = projectkb/alice/rev2 -# Enter lower-power sleep mode when on the ChibiOS idle thread -OPT_DEFS += -DCORTEX_ENABLE_WFI_IDLE=TRUE From 8813a155f1a3304ab9235f3ca1d4d660a38990d7 Mon Sep 17 00:00:00 2001 From: Andrew Kannan Date: Mon, 13 Apr 2020 16:18:46 -0400 Subject: [PATCH 4/5] Apply suggestions from code review Co-Authored-By: James Young <18669334+noroadsleft@users.noreply.github.com> --- keyboards/projectkb/alice/rev1/rules.mk | 29 +++++++++++++++---------- keyboards/projectkb/alice/rev2/rules.mk | 29 +++++++++++++++---------- 2 files changed, 34 insertions(+), 24 deletions(-) diff --git a/keyboards/projectkb/alice/rev1/rules.mk b/keyboards/projectkb/alice/rev1/rules.mk index 964b5c58cc60..258444db4555 100644 --- a/keyboards/projectkb/alice/rev1/rules.mk +++ b/keyboards/projectkb/alice/rev1/rules.mk @@ -2,19 +2,24 @@ MCU = STM32F072 # Build Options -# comment out to disable the options. +# 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 = yes # Console for debug -COMMAND_ENABLE = yes # Commands for debug and configuration -SLEEP_LED_ENABLE = no # Breathing sleep LED during USB suspend -NKRO_ENABLE = yes # USB Nkey Rollover -CUSTOM_MATRIX = no # Custom matrix file -BACKLIGHT_ENABLE = yes -RGBLIGHT_ENABLE = yes +BOOTMAGIC_ENABLE = lite # Virtual DIP switch configuration +MOUSEKEY_ENABLE = yes # Mouse keys +EXTRAKEY_ENABLE = yes # Audio control and System control +CONSOLE_ENABLE = yes # Console for debug +COMMAND_ENABLE = yes # 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 = yes # USB Nkey Rollover +BACKLIGHT_ENABLE = yes # Enable keyboard backlight functionality +RGBLIGHT_ENABLE = yes # Enable keyboard RGB underglow +MIDI_ENABLE = no # MIDI support +BLUETOOTH_ENABLE = no # Enable Bluetooth with the Adafruit EZ-Key HID +AUDIO_ENABLE = no # Audio output on port C6 +FAUXCLICKY_ENABLE = no # Use buzzer to emulate clicky switches +HD44780_ENABLE = no # Enable support for HD44780 based LCDs WS2812_DRIVER = spi diff --git a/keyboards/projectkb/alice/rev2/rules.mk b/keyboards/projectkb/alice/rev2/rules.mk index 964b5c58cc60..258444db4555 100644 --- a/keyboards/projectkb/alice/rev2/rules.mk +++ b/keyboards/projectkb/alice/rev2/rules.mk @@ -2,19 +2,24 @@ MCU = STM32F072 # Build Options -# comment out to disable the options. +# 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 = yes # Console for debug -COMMAND_ENABLE = yes # Commands for debug and configuration -SLEEP_LED_ENABLE = no # Breathing sleep LED during USB suspend -NKRO_ENABLE = yes # USB Nkey Rollover -CUSTOM_MATRIX = no # Custom matrix file -BACKLIGHT_ENABLE = yes -RGBLIGHT_ENABLE = yes +BOOTMAGIC_ENABLE = lite # Virtual DIP switch configuration +MOUSEKEY_ENABLE = yes # Mouse keys +EXTRAKEY_ENABLE = yes # Audio control and System control +CONSOLE_ENABLE = yes # Console for debug +COMMAND_ENABLE = yes # 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 = yes # USB Nkey Rollover +BACKLIGHT_ENABLE = yes # Enable keyboard backlight functionality +RGBLIGHT_ENABLE = yes # Enable keyboard RGB underglow +MIDI_ENABLE = no # MIDI support +BLUETOOTH_ENABLE = no # Enable Bluetooth with the Adafruit EZ-Key HID +AUDIO_ENABLE = no # Audio output on port C6 +FAUXCLICKY_ENABLE = no # Use buzzer to emulate clicky switches +HD44780_ENABLE = no # Enable support for HD44780 based LCDs WS2812_DRIVER = spi From 0168f9d9f13a928bcf5bbf266d89f254cda883f4 Mon Sep 17 00:00:00 2001 From: Andrew Kannan Date: Tue, 14 Apr 2020 19:37:38 -0400 Subject: [PATCH 5/5] Update keyboards/projectkb/alice/rules.mk Co-Authored-By: James Young <18669334+noroadsleft@users.noreply.github.com> --- keyboards/projectkb/alice/rules.mk | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/keyboards/projectkb/alice/rules.mk b/keyboards/projectkb/alice/rules.mk index 927ab7abefd3..d6725769928b 100644 --- a/keyboards/projectkb/alice/rules.mk +++ b/keyboards/projectkb/alice/rules.mk @@ -1,2 +1 @@ -DEFAULT_FOLDER = projectkb/alice/rev2 - +DEFAULT_FOLDER = projectkb/alice/rev1