diff options
| -rw-r--r-- | keyboards/atreus/readme.md | 21 | ||||
| -rw-r--r-- | keyboards/atreus/rules.mk | 77 |
2 files changed, 54 insertions, 44 deletions
diff --git a/keyboards/atreus/readme.md b/keyboards/atreus/readme.md index 50901ee32..5cd797da9 100644 --- a/keyboards/atreus/readme.md +++ b/keyboards/atreus/readme.md | |||
| @@ -1,21 +1,24 @@ | |||
| 1 | Atreus | 1 | Atreus |
| 2 | === | 2 | ====== |
| 3 | 3 | ||
| 4 | A small mechanical keyboard that is based around the shape of the human hand. | 4 | A small mechanical keyboard that is based around the shape of the human hand. |
| 5 | 5 | ||
| 6 | These configuration files are specifically for the Atreus keyboards created by Phil Hagelberg (@technomancy). This keyboard is available in two variants: one powered by a Teensy 2, (usually hand-wired) one powered by an A-Star. (usually using a PCB) This repository currently assumes that you have an A-Star powered Atreus. If you are using a Teensy2, specify that by adding `TEENSY2=yes` to your `make` commands. | ||
| 7 | |||
| 8 | Keyboard Maintainer: [Phil Hagelberg](https://github.com/technomancy) | 6 | Keyboard Maintainer: [Phil Hagelberg](https://github.com/technomancy) |
| 9 | Hardware Supported: Atreus, PCB-based or hand-wired | 7 | Hardware Supported: Atreus, PCB-based or hand-wired |
| 10 | Hardware Availability: https://atreus.technomancy.us | 8 | Hardware Availability: https://atreus.technomancy.us |
| 11 | 9 | ||
| 12 | Make example for this keyboard (after setting up your build environment): | 10 | These configuration files are specifically for the Atreus keyboards created by Phil Hagelberg (@technomancy). This keyboard is available in two variants: one powered by a Teensy 2 (usually hand-wired), one powered by an A-Star (usually using a PCB). You will need to use different `make` commands depending on the variant you have; see examples below. |
| 11 | |||
| 12 | A-Star:\ | ||
| 13 | `make atreus:default:avrdude` | ||
| 13 | 14 | ||
| 14 | make atreus:default:avrdude | 15 | Teensy:\ |
| 16 | `make TEENSY2=yes atreus:default:teensy` | ||
| 17 | |||
| 18 | If your keyboard layout is a mirror image of what you expected (i.e. you do not get QWERTY on the left but YTREWQ on the right), then you have an A-Star powered Atreus (older than March 2016) with PCB labels facing *down* instead of up. Specify that by adding `PCBDOWN=yes` to your `make` commands, e.g. | ||
| 15 | 19 | ||
| 16 | Unlike the TMK firmware, this command should be run from the root of | 20 | `make PCBDOWN=yes atreus:default:avrdude` |
| 17 | the repository, not the directory containing this readme. | ||
| 18 | 21 | ||
| 19 | If your keyboard layout is a mirror image of what you expected (i.e. you do not get QWERTY on the left but YTREWQ on the right), then you have an A-Star powered Atreus (older than March 2016) with PCB labels facing *down* instead of up. Specify that by adding `PCBDOWN=yes` to your `make` commands. | 22 | *Unlike the TMK firmware, these commands should be run from the root of the repository, not the directory containing this readme.* |
| 20 | 23 | ||
| 21 | See [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) then the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. | 24 | See [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools), then the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. |
diff --git a/keyboards/atreus/rules.mk b/keyboards/atreus/rules.mk index 2488fd5e8..eda77404a 100644 --- a/keyboards/atreus/rules.mk +++ b/keyboards/atreus/rules.mk | |||
| @@ -1,19 +1,4 @@ | |||
| 1 | |||
| 2 | |||
| 3 | ifdef TEENSY2 | ||
| 4 | OPT_DEFS += -DATREUS_TEENSY2 | ||
| 5 | ATREUS_UPLOAD_COMMAND = teensy_loader_cli -w -mmcu=$(MCU) $(TARGET).hex | ||
| 6 | else | ||
| 7 | OPT_DEFS += -DATREUS_ASTAR | ||
| 8 | ifdef PCBDOWN | ||
| 9 | OPT_DEFS += -DPCBDOWN | ||
| 10 | endif | ||
| 11 | ATREUS_UPLOAD_COMMAND = while [ ! -r $(USB) ]; do sleep 1; done; \ | ||
| 12 | avrdude -p $(MCU) -c avr109 -U flash:w:$(TARGET).hex -P $(USB) | ||
| 13 | endif | ||
| 14 | |||
| 15 | # MCU name | 1 | # MCU name |
| 16 | #MCU = at90usb1287 | ||
| 17 | MCU = atmega32u4 | 2 | MCU = atmega32u4 |
| 18 | 3 | ||
| 19 | # Processor frequency. | 4 | # Processor frequency. |
| @@ -48,34 +33,56 @@ ARCH = AVR8 | |||
| 48 | # CPU clock adjust registers or the clock division fuses), this will be equal to F_CPU. | 33 | # CPU clock adjust registers or the clock division fuses), this will be equal to F_CPU. |
| 49 | F_USB = $(F_CPU) | 34 | F_USB = $(F_CPU) |
| 50 | 35 | ||
| 51 | # Bootloader | 36 | # Interrupt driven control endpoint task(+60) |
| 52 | # This definition is optional, and if your keyboard supports multiple bootloaders of | 37 | OPT_DEFS += -DINTERRUPT_CONTROL_ENDPOINT |
| 53 | # different sizes, comment this out, and the correct address will be loaded | 38 | |
| 54 | # automatically (+60). See bootloader.mk for all options. | 39 | |
| 40 | # Bootloader selection | ||
| 41 | # Teensy halfkay | ||
| 42 | # Pro Micro caterina | ||
| 43 | # Atmel DFU atmel-dfu | ||
| 44 | # LUFA DFU lufa-dfu | ||
| 45 | # QMK DFU qmk-dfu | ||
| 46 | # atmega32a bootloadHID | ||
| 55 | ifdef TEENSY2 | 47 | ifdef TEENSY2 |
| 56 | BOOTLOADER = halfkay | 48 | BOOTLOADER = halfkay |
| 49 | OPT_DEFS += -DATREUS_TEENSY2 | ||
| 57 | else | 50 | else |
| 58 | BOOTLOADER = caterina | 51 | BOOTLOADER = caterina |
| 52 | OPT_DEFS += -DATREUS_ASTAR | ||
| 53 | ifdef PCBDOWN | ||
| 54 | OPT_DEFS += -DPCBDOWN | ||
| 55 | endif | ||
| 59 | endif | 56 | endif |
| 60 | 57 | ||
| 61 | # Interrupt driven control endpoint task(+60) | 58 | |
| 62 | OPT_DEFS += -DINTERRUPT_CONTROL_ENDPOINT | 59 | # If you don't know the bootloader type, then you can specify the |
| 60 | # Boot Section Size in *bytes* by uncommenting out the OPT_DEFS line | ||
| 61 | # Teensy halfKay 512 | ||
| 62 | # Teensy++ halfKay 1024 | ||
| 63 | # Atmel DFU loader 4096 | ||
| 64 | # LUFA bootloader 4096 | ||
| 65 | # USBaspLoader 2048 | ||
| 66 | # OPT_DEFS += -DBOOTLOADER_SIZE=4096 | ||
| 63 | 67 | ||
| 64 | 68 | ||
| 65 | # Build Options | 69 | # Build Options |
| 66 | # comment out to disable the options. | 70 | # change yes to no to disable |
| 67 | # | 71 | # |
| 68 | #BOOTMAGIC_ENABLE = yes # Virtual DIP switch configuration(+1000) | 72 | BOOTMAGIC_ENABLE = no # Virtual DIP switch configuration(+1000) |
| 69 | MOUSEKEY_ENABLE = yes # Mouse keys(+4700) | 73 | MOUSEKEY_ENABLE = yes # Mouse keys(+4700) |
| 70 | EXTRAKEY_ENABLE = yes # Audio control and System control(+450) | 74 | EXTRAKEY_ENABLE = yes # Audio control and System control(+450) |
| 71 | CONSOLE_ENABLE = yes # Console for debug(+400) | 75 | CONSOLE_ENABLE = yes # Console for debug(+400) |
| 72 | COMMAND_ENABLE = yes # Commands for debug and configuration | 76 | COMMAND_ENABLE = yes # Commands for debug and configuration |
| 73 | # Do not enable SLEEP_LED_ENABLE. it uses the same timer as BACKLIGHT_ENABLE | 77 | # Do not enable SLEEP_LED_ENABLE. it uses the same timer as BACKLIGHT_ENABLE |
| 74 | # SLEEP_LED_ENABLE = yes # Breathing sleep LED during USB suspend | 78 | SLEEP_LED_ENABLE = no # Breathing sleep LED during USB suspend |
| 75 | NKRO_ENABLE = yes # USB Nkey Rollover - not yet supported in LUFA | 79 | # if this doesn't work, see here: https://github.com/tmk/tmk_keyboard/wiki/FAQ#nkro-doesnt-work |
| 76 | # BACKLIGHT_ENABLE = yes # Enable keyboard backlight functionality | 80 | NKRO_ENABLE = yes # USB Nkey Rollover |
| 77 | # MIDI_ENABLE = YES # MIDI controls | 81 | BACKLIGHT_ENABLE = no # Enable keyboard backlight functionality on B7 by default |
| 78 | UNICODE_ENABLE = YES # Unicode | 82 | RGBLIGHT_ENABLE = no # Enable keyboard RGB underglow |
| 79 | # BLUETOOTH_ENABLE = yes # Enable Bluetooth with the Adafruit EZ-Key HID | 83 | MIDI_ENABLE = no # MIDI support (+2400 to 4200, depending on config) |
| 80 | 84 | UNICODE_ENABLE = yes # Unicode | |
| 81 | USB = /dev/cu.usbmodem1411 | 85 | BLUETOOTH_ENABLE = no # Enable Bluetooth with the Adafruit EZ-Key HID |
| 86 | AUDIO_ENABLE = no # Audio output on port C6 | ||
| 87 | FAUXCLICKY_ENABLE = no # Use buzzer to emulate clicky switches | ||
| 88 | HD44780_ENABLE = no # Enable support for HD44780 based LCDs (+400) | ||
