[Keyboard] Added Vitamins Included Rev2 (#6593)
* Fixed pin for RGB * Added support for second revision of vitamins included * Added rev2 config and switched to #pragma once * Switch to quantum.h pincontrol * Fixed left-half check * Moved revision agnostic code to main header file * Moved common build options to main makefile * Referred to rev2 documentation * JTAG is dissabled in keyboard.c now * moved EEHANDS to rev1 config * moved rev2 to use split_common * Updated default keymaps * Changed handedness ifdef to allow user-overrides * Add some space saving defines * Changed to more sane I2C clock * Removed rev2 check in matrix.c as rev2 uses split_common * Removed rev2 check in rev1 only code * Update debounce constant name Co-Authored-By: noroadsleft <18669334+noroadsleft@users.noreply.github.com> * Switch KEYMAP macro to LAYOUT Co-Authored-By: noroadsleft <18669334+noroadsleft@users.noreply.github.com> * Switch kc_keymap macro to layout_kc Co-Authored-By: noroadsleft <18669334+noroadsleft@users.noreply.github.com> * Switch kc_keymap macro to layout_kc Co-Authored-By: noroadsleft <18669334+noroadsleft@users.noreply.github.com> * Add legacy layout macro alias Co-Authored-By: noroadsleft <18669334+noroadsleft@users.noreply.github.com> * Update keyboards/vitamins_included/rev2/config.h Co-Authored-By: noroadsleft <18669334+noroadsleft@users.noreply.github.com> * Split readme into revision specific versions * Updated src to allow LTO * Renamed readmes to lower-case * Switched my keyboards to FEED VID * Fixed markdown lint errors * fixed readme links Co-Authored-By: noroadsleft <18669334+noroadsleft@users.noreply.github.com> * Maintain keymap backwards compatibility Co-Authored-By: Joel Challis <git@zvecr.com>better_chibios_wait
Mikkel Jeppesen
6 years ago
committed by
Drashna Jaelre
parent
a2b855febb
commit
19a85015c2
@ -0,0 +1,12 @@ |
||||
{ |
||||
"keyboard_name": "Vitamins Included", |
||||
"url": "", |
||||
"maintainer": "Duckle29", |
||||
"width": 13, |
||||
"height": 4, |
||||
"layouts": { |
||||
"LAYOUT": { |
||||
"layout": [{"x":0, "y":0}, {"x":1, "y":0}, {"x":2, "y":0}, {"x":3, "y":0}, {"x":4, "y":0}, {"x":5, "y":0}, {"x":7, "y":0}, {"x":8, "y":0}, {"x":9, "y":0}, {"x":10, "y":0}, {"x":11, "y":0}, {"x":12, "y":0}, {"x":0, "y":1}, {"x":1, "y":1}, {"x":2, "y":1}, {"x":3, "y":1}, {"x":4, "y":1}, {"x":5, "y":1}, {"x":7, "y":1}, {"x":8, "y":1}, {"x":9, "y":1}, {"x":10, "y":1}, {"x":11, "y":1}, {"x":12, "y":1}, {"x":0, "y":2}, {"x":1, "y":2}, {"x":2, "y":2}, {"x":3, "y":2}, {"x":4, "y":2}, {"x":5, "y":2}, {"x":7, "y":2}, {"x":8, "y":2}, {"x":9, "y":2}, {"x":10, "y":2}, {"x":11, "y":2}, {"x":12, "y":2}, {"x":0, "y":3}, {"x":1, "y":3}, {"x":2, "y":3}, {"x":3, "y":3}, {"x":4, "y":3}, {"x":5, "y":3}, {"x":7, "y":3}, {"x":8, "y":3}, {"x":9, "y":3}, {"x":10, "y":3}, {"x":11, "y":3}, {"x":12, "y":3}] |
||||
} |
||||
} |
||||
} |
||||
@ -0,0 +1,81 @@ |
||||
# Rev1 |
||||
|
||||
This readme describes the specifics of using the rev1 design |
||||
|
||||
## First Time Setup |
||||
|
||||
Clone the `qmk_firmware` repo and navigate to its top level directory. [Once your build environment is setup](https://docs.qmk.fm/getting_started_build_tools.html), you'll be able to generate the default .hex using the [build/compile instructions](https://docs.qmk.fm/build-compile-instructions) in the docs |
||||
|
||||
If everything worked correctly you will see a file: |
||||
|
||||
```bash |
||||
lets_split_vitamins_rev1_YOUR_KEYMAP_NAME.hex |
||||
``` |
||||
|
||||
If you want, you can flash the hex file to the keyboard right after compilation, by adding `:avrdude` to the end of the make command like so: |
||||
|
||||
```bash |
||||
make lets_split_vitamins/rev1:default:avrdude |
||||
``` |
||||
|
||||
This will both compile the hex, and flash the connected half. |
||||
|
||||
For more information on customizing keymaps, take a look at the primary documentation for [Customizing Your Keymap](/readme.md##customizing-your-keymap) in the main readme.md. |
||||
|
||||
## Entering bootloader |
||||
|
||||
If the keyboard isn't new, and has been flashed before, you need to enter bootloader. |
||||
To enter bootloader, either use the assigned keys on the keymap, or if none have been put in the keymap, quickly short the reset to gnd twice. (Bottom pins of programming header, see image)  |
||||
|
||||
If using the default keymap, there's a reset key-combination on each half: |
||||
***Lower (SW23) and left-shift (SW13)*** on the left half, or |
||||
***Raise(SW44) and Enter(SW42)*** on the right half |
||||
It is recommended to add such reset keys to any custom keymaps. It shouldn't be necesarry to have one on each half, but the default layout has that. |
||||
|
||||
The board exits bootloader mode after 8 seconds, if you haven't started flashing. |
||||
|
||||
## EEPROM |
||||
|
||||
If this is the first time you're flashing the boards, you have to flash EEPROM |
||||
|
||||
0. If your keyboard is plugged in, unplug it |
||||
1. Open a terminal, and navigate to the qmk_firmware folder |
||||
1. Run `ls /dev | grep tty` Note down which ports you see |
||||
1. Plug the keyboard in, if it's new, it should enter bootloader, if it's not new, see **Entering bootloader** on how to enter bootloader mode |
||||
1. Right after entering bootloader, run `ls /dev | grep tty` again. There should be a new tty, this is the bootloader TTY, note it down. If nothing shows see **Entering bootloader** on how to enter bootloader mode |
||||
1. For the left hand side, run `avrdude -c avr109 -p m32u4 -P /dev/ttyS1 -U eeprom:w:"./quantum/split_common/eeprom-lefthand.eep":a` |
||||
Replace ***/dev/ttyS1*** with the port you noted down earlier. If you're on windows using msys2, replace ***/dev/ttyS1*** with COM2, note that the number is one higher than the tty number. |
||||
Do the same For the right hand, but change the file to ***eeprom-righthand.eep*** |
||||
|
||||
Your EEPROM should be flashed :) |
||||
|
||||
In the future, you shouldn't need to flash EEPROM (it will in fact wear the eeprom memory, so don't) |
||||
|
||||
## Flashing |
||||
|
||||
If you haven't flashed EEPROM before, do that first. |
||||
|
||||
To flash keymaps onto the keyboard, use: |
||||
|
||||
```bash |
||||
make lets_split_vitamins/rev1:[KEYMAP]:avrdude |
||||
``` |
||||
|
||||
from the qmk_firmware folder. Default being the default keymap. |
||||
|
||||
## Cases |
||||
|
||||
The keyboard is supplied with some simple plate cases, alternatively a 3D model for the left half is available [here](https://cad.onshape.com/documents/c6e5ae250d1e24fe46c9ef6c/w/d69f7049c0921df3d2b241f9/e/ecc2b176ab52a6d77bc55051). |
||||
|
||||
Alternatively the flat case for the Rev2 works for the rev1 kit as well, however one of the supports collide with a diode. If printed in thermo-plastics this can be heated and pressed to form a recess for the diode. |
||||
|
||||
## WS2812 RGB |
||||
|
||||
If you wish to add RGB LED strips to your board, then the boards have breakouts for these. |
||||
You can either have each halfcontrol it's own strip of LEDs, or, if you're using a TRRS cable, you can have one half control the LEDs in both halves. |
||||
|
||||
To add RGB LEDs to the board, solder the + and - of the >WS2812 headers to the LED strips. Then if you want each half to control it's own set of LEDs seperately, solder the D pad to Din on the strips. |
||||
|
||||
If you instead want to syncronize the halves over a TRRS cable, solder the D pad to Din in the side you want to control the strips, either will work so flip a coin, and then solder the Dout pad to the WS2812> pad on the board. On the other half, solder the WS2812> pad to Din. |
||||
|
||||
 |
||||
@ -1,5 +1,9 @@ |
||||
BACKLIGHT_ENABLE = no
|
||||
AUDIO_ENABLE = yes
|
||||
RGBLIGHT_ENABLE = yes
|
||||
DEBUG_ENABLE = no
|
||||
CONSOLE_ENABLE = no
|
||||
SRC += matrix.c \
|
||||
split_util.c \
|
||||
ssd1306.c
|
||||
|
||||
QUANTUM_LIB_SRC += i2c.c \
|
||||
serial.c \
|
||||
|
||||
CUSTOM_MATRIX = yes
|
||||
BOOTLOADER = caterina
|
||||
|
||||
@ -0,0 +1,81 @@ |
||||
/*
|
||||
Copyright 2012 Jun Wako <wakojun@gmail.com> |
||||
Copyright 2015 Jack Humbert |
||||
Copyright 2019 Mikkel Jeppesen |
||||
|
||||
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" |
||||
|
||||
#define SPLIT_HAND_PIN B4 |
||||
#define SOFT_SERIAL_PIN D0 |
||||
|
||||
/* USB Device descriptor parameter */ |
||||
#define DEVICE_VER 0x0002 |
||||
#define DESCRIPTION A toolless split keyboard for the cheapish makers |
||||
|
||||
/* key matrix size */ |
||||
// Rows are doubled-up
|
||||
#define MATRIX_ROWS 8 |
||||
#define MATRIX_COLS 6 |
||||
|
||||
// wiring of each half
|
||||
#define MATRIX_ROW_PINS { F5, F6, C7, F7 } |
||||
#define MATRIX_COL_PINS { F1, F4, E2, B6, D7, D6} |
||||
|
||||
/* define if matrix has ghost */ |
||||
//#define MATRIX_HAS_GHOST
|
||||
|
||||
/* number of backlight levels */ |
||||
// #define BACKLIGHT_LEVELS 3
|
||||
|
||||
/* 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 |
||||
|
||||
/* ws2812 RGB LED */ |
||||
#define RGB_DI_PIN F0 |
||||
|
||||
#define RGBLED_NUM 12 // Number of LEDs
|
||||
#define RGBLIGHT_ANIMATIONS |
||||
|
||||
/* Audio settings */ |
||||
#ifdef AUDIO_ENABLE |
||||
#define C6_AUDIO // Define this to enable the buzzer
|
||||
#endif |
||||
|
||||
/*
|
||||
* 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
|
||||
@ -0,0 +1,10 @@ |
||||
# Rev2 |
||||
|
||||
Revision 2 is documented [on qmk.fm](https://qmk.fm/keyboards/vitamins_included/) |
||||
|
||||
Key differences between rev1 and rev2: |
||||
|
||||
* rev2 uses qmk-dfu bootloader |
||||
* rev2 uses a USB-C connector |
||||
* rev2 6 WS2812 LEDs factory mounted to each half |
||||
* rev2 has more mounting holes. 1 additional M3, and 4 additional M2.5 holes |
||||
@ -0,0 +1,31 @@ |
||||
#include "rev2.h" |
||||
|
||||
|
||||
#ifdef SSD1306OLED |
||||
void led_set_kb(uint8_t usb_led) { |
||||
// put your keyboard LED indicator (ex: Caps Lock LED) toggling code here
|
||||
led_set_user(usb_led); |
||||
} |
||||
#endif |
||||
|
||||
bool is_keyboard_left(void) { |
||||
#if defined(MASTER_LEFT) |
||||
return is_keyboard_master(); |
||||
#elif defined(MASTER_RIGHT) |
||||
return !is_keyboard_master(); |
||||
#elif defined(SPLIT_HAND_PIN) |
||||
// Test pin SPLIT_HAND_PIN for High/Low, if low it's right hand
|
||||
setPinInputHigh(SPLIT_HAND_PIN); |
||||
bool x = !readPin(SPLIT_HAND_PIN); |
||||
setPinInput(SPLIT_HAND_PIN); |
||||
return x; |
||||
#elif defined(EE_HANDS) |
||||
return eeprom_read_byte(EECONFIG_HANDEDNESS); |
||||
#endif |
||||
|
||||
return is_keyboard_master(); |
||||
} |
||||
|
||||
void matrix_init_kb(void) { |
||||
matrix_init_user(); |
||||
}; |
||||
@ -0,0 +1,2 @@ |
||||
#pragma once |
||||
#include QMK_KEYBOARD_H |
||||
@ -0,0 +1,2 @@ |
||||
SPLIT_KEYBOARD = yes # Rev2 uses split_common
|
||||
BOOTLOADER = qmk-dfu
|
||||
@ -1,76 +1,28 @@ |
||||
SRC += matrix.c \
|
||||
i2c.c \
|
||||
split_util.c \
|
||||
serial.c \
|
||||
ssd1306.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)
|
||||
|
||||
# Bootloader
|
||||
# This definition is optional, and if your keyboard supports multiple bootloaders of
|
||||
# different sizes, comment this out, and the correct address will be loaded
|
||||
# automatically (+60). See bootloader.mk for all options.
|
||||
BOOTLOADER = caterina
|
||||
|
||||
# Interrupt driven control endpoint task(+60)
|
||||
OPT_DEFS += -DINTERRUPT_CONTROL_ENDPOINT
|
||||
|
||||
# Build Options
|
||||
# change to "no" to disable the options, or define them in the Makefile in
|
||||
# the appropriate keymap folder that will get included automatically
|
||||
#
|
||||
AUDIO_ENABLE = yes # Audio output on port C6
|
||||
BACKLIGHT_ENABLE = no # Enable keyboard backlight functionality
|
||||
BLUETOOTH_ENABLE = no # Enable Bluetooth with the Adafruit EZ-Key HID
|
||||
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 = no # Console for debug(+400)
|
||||
COMMAND_ENABLE = no # Commands for debug and configuration
|
||||
NKRO_ENABLE = no # Nkey Rollover - if this doesn't work, see here: https://github.com/tmk/tmk_keyboard/wiki/FAQ#nkro-doesnt-work
|
||||
BACKLIGHT_ENABLE = no # Enable keyboard backlight functionality
|
||||
CONSOLE_ENABLE = no # Console for debug(+400)
|
||||
DEBUG_ENABLE = no # Enable more debug info
|
||||
EXTRAKEY_ENABLE = yes # Audio control and System control(+450)
|
||||
MIDI_ENABLE = no # MIDI controls
|
||||
AUDIO_ENABLE = no # Audio output on port C6
|
||||
MOUSEKEY_ENABLE = no # Mouse keys(+4700)
|
||||
NKRO_ENABLE = no # Nkey Rollover - if this doesn't work, see here: https://github.com/tmk/tmk_keyboard/wiki/FAQ#nkro-doesnt-work
|
||||
RGBLIGHT_ENABLE = yes # Enable WS2812 RGB underlight.
|
||||
UNICODE_ENABLE = no # Unicode
|
||||
BLUETOOTH_ENABLE = no # Enable Bluetooth with the Adafruit EZ-Key HID
|
||||
RGBLIGHT_ENABLE = no # Enable WS2812 RGB underlight.
|
||||
# Do not enable SLEEP_LED_ENABLE. it uses the same timer as BACKLIGHT_ENABLE
|
||||
SLEEP_LED_ENABLE = no # Breathing sleep LED during USB suspend
|
||||
|
||||
CUSTOM_MATRIX = yes
|
||||
|
||||
LAYOUTS = ortho_4x12
|
||||
|
||||
DEFAULT_FOLDER = vitamins_included/rev1
|
||||
DEFAULT_FOLDER = vitamins_included/rev2
|
||||
|
||||
EXTRAFLAGS += -flto
|
||||
LINK_TIME_OPTIMIZATION_ENABLE = yes
|
||||
Loading…
Reference in new issue