diff options
| author | Alby Barber <alby@albybarber.com> | 2020-10-29 04:15:38 -0400 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-10-29 01:15:38 -0700 |
| commit | f487b726cd31f51f652f0c498e9767118faeff10 (patch) | |
| tree | 2dc68a5904508b30b5884eb1953ada8148f8a5eb /keyboards/littlealby | |
| parent | 5cecc1ea1ec8df3b74d01f96336dee2c2f5c6f4e (diff) | |
| download | qmk_firmware-f487b726cd31f51f652f0c498e9767118faeff10.tar.gz qmk_firmware-f487b726cd31f51f652f0c498e9767118faeff10.zip | |
[Keyboard] Adding Little Alby the Arduino Keyboard (#10713)
* Adding little Alby keyboard
* Adding readme and expanding programs
* Updating readme
* adding spirit guide
* changes based on review
* Updating config name and readme
* Update keyboards/littlealby/mute/rules.mk
Update tabbing
Co-authored-by: Ryan <fauxpark@gmail.com>
* Update keyboards/littlealby/mute/rules.mk
Remove other boards
Co-authored-by: Ryan <fauxpark@gmail.com>
* Changes based on review
* Update keyboards/littlealby/mute/config.h
Co-authored-by: Ryan <fauxpark@gmail.com>
* Update keyboards/littlealby/mute/rules.mk
Co-authored-by: Ryan <fauxpark@gmail.com>
* Update keyboards/littlealby/readme.md
Co-authored-by: Ryan <fauxpark@gmail.com>
* Update keyboards/littlealby/readme.md
Co-authored-by: Ryan <fauxpark@gmail.com>
* Update keyboards/littlealby/mute/config.h
Co-authored-by: Ryan <fauxpark@gmail.com>
* Adding unique vendor and Product IDs
* Update keyboards/littlealby/mute/config.h
Co-authored-by: Ryan <fauxpark@gmail.com>
* 0x4D55 = MU
* Adding default map
Co-authored-by: Alby Barber <albybarber@gmail.com>
Co-authored-by: Ryan <fauxpark@gmail.com>
Diffstat (limited to 'keyboards/littlealby')
| -rw-r--r-- | keyboards/littlealby/mute/config.h | 45 | ||||
| -rw-r--r-- | keyboards/littlealby/mute/info.json | 13 | ||||
| -rw-r--r-- | keyboards/littlealby/mute/keymaps/default/keymap.c | 23 | ||||
| -rw-r--r-- | keyboards/littlealby/mute/keymaps/default/readme.md | 8 | ||||
| -rw-r--r-- | keyboards/littlealby/mute/keymaps/g_meet/keymap.c | 23 | ||||
| -rw-r--r-- | keyboards/littlealby/mute/keymaps/g_meet/readme.md | 8 | ||||
| -rw-r--r-- | keyboards/littlealby/mute/keymaps/ms_teams/keymap.c | 23 | ||||
| -rw-r--r-- | keyboards/littlealby/mute/keymaps/ms_teams/readme.md | 8 | ||||
| -rw-r--r-- | keyboards/littlealby/mute/keymaps/zoom/keymap.c | 23 | ||||
| -rw-r--r-- | keyboards/littlealby/mute/keymaps/zoom/readme.md | 8 | ||||
| -rw-r--r-- | keyboards/littlealby/mute/mute.c | 16 | ||||
| -rw-r--r-- | keyboards/littlealby/mute/mute.h | 24 | ||||
| -rw-r--r-- | keyboards/littlealby/mute/rules.mk | 22 | ||||
| -rw-r--r-- | keyboards/littlealby/readme.md | 34 |
14 files changed, 278 insertions, 0 deletions
diff --git a/keyboards/littlealby/mute/config.h b/keyboards/littlealby/mute/config.h new file mode 100644 index 000000000..302b02a24 --- /dev/null +++ b/keyboards/littlealby/mute/config.h | |||
| @@ -0,0 +1,45 @@ | |||
| 1 | /* Copyright 2019 albybarber | ||
| 2 | * | ||
| 3 | * This program is free software: you can redistribute it and/or modify | ||
| 4 | * it under the terms of the GNU General Public License as published by | ||
| 5 | * the Free Software Foundation, either version 2 of the License, or | ||
| 6 | * (at your option) any later version. | ||
| 7 | * | ||
| 8 | * This program is distributed in the hope that it will be useful, | ||
| 9 | * but WITHOUT ANY WARRANTY; without even the implied warranty of | ||
| 10 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | ||
| 11 | * GNU General Public License for more details. | ||
| 12 | * | ||
| 13 | * You should have received a copy of the GNU General Public License | ||
| 14 | * along with this program. If not, see <http://www.gnu.org/licenses/>. | ||
| 15 | */ | ||
| 16 | #pragma once | ||
| 17 | #include "config_common.h" | ||
| 18 | |||
| 19 | /* USB Device descriptor parameter */ | ||
| 20 | #define VENDOR_ID 0x4142 // "AB" | ||
| 21 | #define PRODUCT_ID 0x4D55 // "MU" | ||
| 22 | #define DEVICE_VER 0x0001 | ||
| 23 | #define MANUFACTURER Little Alby | ||
| 24 | #define PRODUCT Mute | ||
| 25 | |||
| 26 | #define USB_MAX_POWER_CONSUMPTION 100 | ||
| 27 | |||
| 28 | /* key matrix size */ | ||
| 29 | #define MATRIX_ROWS 1 | ||
| 30 | #define MATRIX_COLS 1 | ||
| 31 | |||
| 32 | /* Default pinout */ | ||
| 33 | /* See arduino micro pinout: https://content.arduino.cc/assets/Pinout-Micro_latest.png | ||
| 34 | * for pins e.g. | ||
| 35 | * PB5 = digital pin 9 / analog pin 9 | ||
| 36 | */ | ||
| 37 | #define DIRECT_PINS { \ | ||
| 38 | {B5} \ | ||
| 39 | } | ||
| 40 | #define UNUSED_PINS | ||
| 41 | |||
| 42 | #ifdef RGBLIGHT_ENABLE | ||
| 43 | #define RGB_DI_PIN B6 | ||
| 44 | #define RGBLED_NUM 1 | ||
| 45 | #endif | ||
diff --git a/keyboards/littlealby/mute/info.json b/keyboards/littlealby/mute/info.json new file mode 100644 index 000000000..47a936d29 --- /dev/null +++ b/keyboards/littlealby/mute/info.json | |||
| @@ -0,0 +1,13 @@ | |||
| 1 | { | ||
| 2 | "keyboard_name": "Little Alby", | ||
| 3 | "keyboard_folder": "mute", | ||
| 4 | "url": "", | ||
| 5 | "maintainer": "albybarber", | ||
| 6 | "width": 1, | ||
| 7 | "height": 1, | ||
| 8 | "layouts": { | ||
| 9 | "LAYOUT": { | ||
| 10 | "layout": [ {"x": 0, "y": 0 }] | ||
| 11 | } | ||
| 12 | } | ||
| 13 | } | ||
diff --git a/keyboards/littlealby/mute/keymaps/default/keymap.c b/keyboards/littlealby/mute/keymaps/default/keymap.c new file mode 100644 index 000000000..c6cf9836e --- /dev/null +++ b/keyboards/littlealby/mute/keymaps/default/keymap.c | |||
| @@ -0,0 +1,23 @@ | |||
| 1 | /* Copyright 2019 albybarber | ||
| 2 | * | ||
| 3 | * This program is free software: you can redistribute it and/or modify | ||
| 4 | * it under the terms of the GNU General Public License as published by | ||
| 5 | * the Free Software Foundation, either version 2 of the License, or | ||
| 6 | * (at your option) any later version. | ||
| 7 | * | ||
| 8 | * This program is distributed in the hope that it will be useful, | ||
| 9 | * but WITHOUT ANY WARRANTY; without even the implied warranty of | ||
| 10 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | ||
| 11 | * GNU General Public License for more details. | ||
| 12 | * | ||
| 13 | * You should have received a copy of the GNU General Public License | ||
| 14 | * along with this program. If not, see <http://www.gnu.org/licenses/>. | ||
| 15 | */ | ||
| 16 | |||
| 17 | #include QMK_KEYBOARD_H | ||
| 18 | |||
| 19 | const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = { | ||
| 20 | [0] = LAYOUT( | ||
| 21 | SGUI(KC_A) | ||
| 22 | ) | ||
| 23 | }; | ||
diff --git a/keyboards/littlealby/mute/keymaps/default/readme.md b/keyboards/littlealby/mute/keymaps/default/readme.md new file mode 100644 index 000000000..9ff489505 --- /dev/null +++ b/keyboards/littlealby/mute/keymaps/default/readme.md | |||
| @@ -0,0 +1,8 @@ | |||
| 1 | # Default keymap for arduino micro for Zoom | ||
| 2 | |||
| 3 | Default for Mute is to use ```PB5 / digital pin 9 / analog pin 9``` | ||
| 4 | |||
| 5 | Key commands that are emulated for Zoom is `CTL + SHIFT + W` | ||
| 6 | |||
| 7 | ## Example pinout | ||
| 8 |  | ||
diff --git a/keyboards/littlealby/mute/keymaps/g_meet/keymap.c b/keyboards/littlealby/mute/keymaps/g_meet/keymap.c new file mode 100644 index 000000000..38624a01a --- /dev/null +++ b/keyboards/littlealby/mute/keymaps/g_meet/keymap.c | |||
| @@ -0,0 +1,23 @@ | |||
| 1 | /* Copyright 2019 albybarber | ||
| 2 | * | ||
| 3 | * This program is free software: you can redistribute it and/or modify | ||
| 4 | * it under the terms of the GNU General Public License as published by | ||
| 5 | * the Free Software Foundation, either version 2 of the License, or | ||
| 6 | * (at your option) any later version. | ||
| 7 | * | ||
| 8 | * This program is distributed in the hope that it will be useful, | ||
| 9 | * but WITHOUT ANY WARRANTY; without even the implied warranty of | ||
| 10 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | ||
| 11 | * GNU General Public License for more details. | ||
| 12 | * | ||
| 13 | * You should have received a copy of the GNU General Public License | ||
| 14 | * along with this program. If not, see <http://www.gnu.org/licenses/>. | ||
| 15 | */ | ||
| 16 | |||
| 17 | #include QMK_KEYBOARD_H | ||
| 18 | |||
| 19 | const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = { | ||
| 20 | [0] = LAYOUT( | ||
| 21 | RCTL(KC_D) | ||
| 22 | ) | ||
| 23 | }; | ||
diff --git a/keyboards/littlealby/mute/keymaps/g_meet/readme.md b/keyboards/littlealby/mute/keymaps/g_meet/readme.md new file mode 100644 index 000000000..24732c67a --- /dev/null +++ b/keyboards/littlealby/mute/keymaps/g_meet/readme.md | |||
| @@ -0,0 +1,8 @@ | |||
| 1 | # Default keymap for arduino micro for Google Meet | ||
| 2 | |||
| 3 | Default for Mute is to use ```PB5 / digital pin 9 / analog pin 9``` | ||
| 4 | |||
| 5 | Key commands that are emulated for google meet is `CTL + d` | ||
| 6 | |||
| 7 | ## Example pinout | ||
| 8 |  | ||
diff --git a/keyboards/littlealby/mute/keymaps/ms_teams/keymap.c b/keyboards/littlealby/mute/keymaps/ms_teams/keymap.c new file mode 100644 index 000000000..bb2cf1147 --- /dev/null +++ b/keyboards/littlealby/mute/keymaps/ms_teams/keymap.c | |||
| @@ -0,0 +1,23 @@ | |||
| 1 | /* Copyright 2019 albybarber | ||
| 2 | * | ||
| 3 | * This program is free software: you can redistribute it and/or modify | ||
| 4 | * it under the terms of the GNU General Public License as published by | ||
| 5 | * the Free Software Foundation, either version 2 of the License, or | ||
| 6 | * (at your option) any later version. | ||
| 7 | * | ||
| 8 | * This program is distributed in the hope that it will be useful, | ||
| 9 | * but WITHOUT ANY WARRANTY; without even the implied warranty of | ||
| 10 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | ||
| 11 | * GNU General Public License for more details. | ||
| 12 | * | ||
| 13 | * You should have received a copy of the GNU General Public License | ||
| 14 | * along with this program. If not, see <http://www.gnu.org/licenses/>. | ||
| 15 | */ | ||
| 16 | |||
| 17 | #include QMK_KEYBOARD_H | ||
| 18 | |||
| 19 | const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = { | ||
| 20 | [0] = LAYOUT( | ||
| 21 | SGUI(KC_M) | ||
| 22 | ) | ||
| 23 | }; | ||
diff --git a/keyboards/littlealby/mute/keymaps/ms_teams/readme.md b/keyboards/littlealby/mute/keymaps/ms_teams/readme.md new file mode 100644 index 000000000..a58743862 --- /dev/null +++ b/keyboards/littlealby/mute/keymaps/ms_teams/readme.md | |||
| @@ -0,0 +1,8 @@ | |||
| 1 | # Default keymap for arduino micro for Microsoft teams | ||
| 2 | |||
| 3 | Default for Mute is to use ```PB5 / digital pin 9 / analog pin 9``` | ||
| 4 | |||
| 5 | Key commands that are emulated for Microsoft teams is `CTL + SHIFT + M` | ||
| 6 | |||
| 7 | ## Example pinout | ||
| 8 |  | ||
diff --git a/keyboards/littlealby/mute/keymaps/zoom/keymap.c b/keyboards/littlealby/mute/keymaps/zoom/keymap.c new file mode 100644 index 000000000..c6cf9836e --- /dev/null +++ b/keyboards/littlealby/mute/keymaps/zoom/keymap.c | |||
| @@ -0,0 +1,23 @@ | |||
| 1 | /* Copyright 2019 albybarber | ||
| 2 | * | ||
| 3 | * This program is free software: you can redistribute it and/or modify | ||
| 4 | * it under the terms of the GNU General Public License as published by | ||
| 5 | * the Free Software Foundation, either version 2 of the License, or | ||
| 6 | * (at your option) any later version. | ||
| 7 | * | ||
| 8 | * This program is distributed in the hope that it will be useful, | ||
| 9 | * but WITHOUT ANY WARRANTY; without even the implied warranty of | ||
| 10 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | ||
| 11 | * GNU General Public License for more details. | ||
| 12 | * | ||
| 13 | * You should have received a copy of the GNU General Public License | ||
| 14 | * along with this program. If not, see <http://www.gnu.org/licenses/>. | ||
| 15 | */ | ||
| 16 | |||
| 17 | #include QMK_KEYBOARD_H | ||
| 18 | |||
| 19 | const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = { | ||
| 20 | [0] = LAYOUT( | ||
| 21 | SGUI(KC_A) | ||
| 22 | ) | ||
| 23 | }; | ||
diff --git a/keyboards/littlealby/mute/keymaps/zoom/readme.md b/keyboards/littlealby/mute/keymaps/zoom/readme.md new file mode 100644 index 000000000..9ff489505 --- /dev/null +++ b/keyboards/littlealby/mute/keymaps/zoom/readme.md | |||
| @@ -0,0 +1,8 @@ | |||
| 1 | # Default keymap for arduino micro for Zoom | ||
| 2 | |||
| 3 | Default for Mute is to use ```PB5 / digital pin 9 / analog pin 9``` | ||
| 4 | |||
| 5 | Key commands that are emulated for Zoom is `CTL + SHIFT + W` | ||
| 6 | |||
| 7 | ## Example pinout | ||
| 8 |  | ||
diff --git a/keyboards/littlealby/mute/mute.c b/keyboards/littlealby/mute/mute.c new file mode 100644 index 000000000..4a207b8f3 --- /dev/null +++ b/keyboards/littlealby/mute/mute.c | |||
| @@ -0,0 +1,16 @@ | |||
| 1 | /* Copyright 2019 albybatber | ||
| 2 | * | ||
| 3 | * This program is free software: you can redistribute it and/or modify | ||
| 4 | * it under the terms of the GNU General Public License as published by | ||
| 5 | * the Free Software Foundation, either version 2 of the License, or | ||
| 6 | * (at your option) any later version. | ||
| 7 | * | ||
| 8 | * This program is distributed in the hope that it will be useful, | ||
| 9 | * but WITHOUT ANY WARRANTY; without even the implied warranty of | ||
| 10 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | ||
| 11 | * GNU General Public License for more details. | ||
| 12 | * | ||
| 13 | * You should have received a copy of the GNU General Public License | ||
| 14 | * along with this program. If not, see <http://www.gnu.org/licenses/>. | ||
| 15 | */ | ||
| 16 | #include "mute.h" | ||
diff --git a/keyboards/littlealby/mute/mute.h b/keyboards/littlealby/mute/mute.h new file mode 100644 index 000000000..ea8acd815 --- /dev/null +++ b/keyboards/littlealby/mute/mute.h | |||
| @@ -0,0 +1,24 @@ | |||
| 1 | /* Copyright 2019 albybarber | ||
| 2 | * | ||
| 3 | * This program is free software: you can redistribute it and/or modify | ||
| 4 | * it under the terms of the GNU General Public License as published by | ||
| 5 | * the Free Software Foundation, either version 2 of the License, or | ||
| 6 | * (at your option) any later version. | ||
| 7 | * | ||
| 8 | * This program is distributed in the hope that it will be useful, | ||
| 9 | * but WITHOUT ANY WARRANTY; without even the implied warranty of | ||
| 10 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | ||
| 11 | * GNU General Public License for more details. | ||
| 12 | * | ||
| 13 | * You should have received a copy of the GNU General Public License | ||
| 14 | * along with this program. If not, see <http://www.gnu.org/licenses/>. | ||
| 15 | */ | ||
| 16 | #pragma once | ||
| 17 | |||
| 18 | #include "quantum.h" | ||
| 19 | |||
| 20 | #define LAYOUT( \ | ||
| 21 | K00 \ | ||
| 22 | ) { \ | ||
| 23 | { K00 } \ | ||
| 24 | } | ||
diff --git a/keyboards/littlealby/mute/rules.mk b/keyboards/littlealby/mute/rules.mk new file mode 100644 index 000000000..0ea77b055 --- /dev/null +++ b/keyboards/littlealby/mute/rules.mk | |||
| @@ -0,0 +1,22 @@ | |||
| 1 | # MCU name | ||
| 2 | MCU = atmega32u4 | ||
| 3 | |||
| 4 | # Bootloader selection | ||
| 5 | BOOTLOADER = caterina | ||
| 6 | |||
| 7 | # Build Options | ||
| 8 | # change yes to no to disable | ||
| 9 | # | ||
| 10 | BOOTMAGIC_ENABLE = no # Virtual DIP switch configuration | ||
| 11 | MOUSEKEY_ENABLE = no # Mouse keys | ||
| 12 | EXTRAKEY_ENABLE = yes # Audio control and System control | ||
| 13 | CONSOLE_ENABLE = no # Console for debug | ||
| 14 | COMMAND_ENABLE = no # Commands for debug and configuration | ||
| 15 | # Do not enable SLEEP_LED_ENABLE. it uses the same timer as BACKLIGHT_ENABLE | ||
| 16 | SLEEP_LED_ENABLE = no # Breathing sleep LED during USB suspend | ||
| 17 | # if this doesn't work, see here: https://github.com/tmk/tmk_keyboard/wiki/FAQ#nkro-doesnt-work | ||
| 18 | NKRO_ENABLE = no # USB Nkey Rollover | ||
| 19 | BACKLIGHT_ENABLE = no # Enable keyboard backlight functionality | ||
| 20 | RGBLIGHT_ENABLE = yes # Enable keyboard RGB underglow | ||
| 21 | BLUETOOTH_ENABLE = no # Enable Bluetooth | ||
| 22 | AUDIO_ENABLE = no # Audio output | ||
diff --git a/keyboards/littlealby/readme.md b/keyboards/littlealby/readme.md new file mode 100644 index 000000000..039b09a58 --- /dev/null +++ b/keyboards/littlealby/readme.md | |||
| @@ -0,0 +1,34 @@ | |||
| 1 | # Little Alby | ||
| 2 | |||
| 3 | Little Alby is a keyboard library using QMK used to create Arduino based keyboards. | ||
| 4 | |||
| 5 | ## Keyboard Layouts | ||
| 6 | |||
| 7 | [Mute:](keyboards/littlealby/mute) | ||
| 8 | A single button layout that can be used as a mute audio keyboard shortcut for popular video conferencing programs e.g. [Zoom](keyboards/littlealby/mute/keymaps/zoom/readme.md), [Microsoft teams](keyboards/littlealby/mute/keymaps/ms_teams/readme.md), [Google meet](keyboards/littlealby/mute/keymaps/g_meet/readme.md) | ||
| 9 | |||
| 10 | |||
| 11 | ## Arduino Micro pinout | ||
| 12 |  | ||
| 13 | |||
| 14 | Keyboard Maintainer: [albybarber](https://github.com/albybarber) | ||
| 15 | |||
| 16 | Keyboard Maintainers spirit guide : [Olivia](https://github.com/olivia) | ||
| 17 | |||
| 18 | Hardware: | ||
| 19 | * [ARDUINO MICRO - 5v](https://store.arduino.cc/usa/arduino-micro) or [Pro Micro - 5V/16MHz](https://www.sparkfun.com/products/12640) | ||
| 20 | |||
| 21 | ## Building Code | ||
| 22 | Make example for this keyboard (after setting up your build environment): | ||
| 23 | |||
| 24 | make littlealby/mute:default | ||
| 25 | |||
| 26 | // Builds for specific programs | ||
| 27 | make littlealby/mute:zoom | ||
| 28 | make littlealby/mute:ms_teams | ||
| 29 | make littlealby/mute:g_meet | ||
| 30 | |||
| 31 | 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). | ||
| 32 | |||
| 33 | ## Credits | ||
| 34 | + [2% Milk by spaceman - heavly inspired by](https://github.com/qmk/qmk_firmware/tree/master/keyboards/spaceman/2_milk) | ||
