Atreus rules.mk and readme (#5678)
* Update rules and readme to reflect new make usage. * Minor edit. * Minor edit.
This commit is contained in:
Jason Koh
MechMerlin
parent
4ecaa25f3e
commit
76e78e8ca1
2 changed files with 60 additions and 50 deletions
|
|
@ -1,21 +1,24 @@
|
||||||
Atreus
|
Atreus
|
||||||
===
|
======
|
||||||
|
|
||||||
A small mechanical keyboard that is based around the shape of the human hand.
|
A small mechanical keyboard that is based around the shape of the human hand.
|
||||||
|
|
||||||
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.
|
|
||||||
|
|
||||||
Keyboard Maintainer: [Phil Hagelberg](https://github.com/technomancy)
|
Keyboard Maintainer: [Phil Hagelberg](https://github.com/technomancy)
|
||||||
Hardware Supported: Atreus, PCB-based or hand-wired
|
Hardware Supported: Atreus, PCB-based or hand-wired
|
||||||
Hardware Availability: https://atreus.technomancy.us
|
Hardware Availability: https://atreus.technomancy.us
|
||||||
|
|
||||||
Make example for this keyboard (after setting up your build environment):
|
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.
|
||||||
|
|
||||||
make atreus:default:avrdude
|
A-Star:\
|
||||||
|
`make atreus:default:avrdude`
|
||||||
|
|
||||||
Unlike the TMK firmware, this command should be run from the root of
|
Teensy:\
|
||||||
the repository, not the directory containing this readme.
|
`make TEENSY2=yes atreus:default:teensy`
|
||||||
|
|
||||||
|
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.
|
||||||
|
|
||||||
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.
|
`make PCBDOWN=yes atreus:default:avrdude`
|
||||||
|
|
||||||
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.
|
*Unlike the TMK firmware, these commands should be run from the root of the repository, not the directory containing this readme.*
|
||||||
|
|
||||||
|
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.
|
||||||
|
|
|
||||||
|
|
@ -1,19 +1,4 @@
|
||||||
|
|
||||||
|
|
||||||
ifdef TEENSY2
|
|
||||||
OPT_DEFS += -DATREUS_TEENSY2
|
|
||||||
ATREUS_UPLOAD_COMMAND = teensy_loader_cli -w -mmcu=$(MCU) $(TARGET).hex
|
|
||||||
else
|
|
||||||
OPT_DEFS += -DATREUS_ASTAR
|
|
||||||
ifdef PCBDOWN
|
|
||||||
OPT_DEFS += -DPCBDOWN
|
|
||||||
endif
|
|
||||||
ATREUS_UPLOAD_COMMAND = while [ ! -r $(USB) ]; do sleep 1; done; \
|
|
||||||
avrdude -p $(MCU) -c avr109 -U flash:w:$(TARGET).hex -P $(USB)
|
|
||||||
endif
|
|
||||||
|
|
||||||
# MCU name
|
# MCU name
|
||||||
#MCU = at90usb1287
|
|
||||||
MCU = atmega32u4
|
MCU = atmega32u4
|
||||||
|
|
||||||
# Processor frequency.
|
# Processor frequency.
|
||||||
|
|
@ -48,34 +33,56 @@ ARCH = AVR8
|
||||||
# CPU clock adjust registers or the clock division fuses), this will be equal to F_CPU.
|
# CPU clock adjust registers or the clock division fuses), this will be equal to F_CPU.
|
||||||
F_USB = $(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.
|
|
||||||
ifdef TEENSY2
|
|
||||||
BOOTLOADER = halfkay
|
|
||||||
else
|
|
||||||
BOOTLOADER = caterina
|
|
||||||
endif
|
|
||||||
|
|
||||||
# Interrupt driven control endpoint task(+60)
|
# Interrupt driven control endpoint task(+60)
|
||||||
OPT_DEFS += -DINTERRUPT_CONTROL_ENDPOINT
|
OPT_DEFS += -DINTERRUPT_CONTROL_ENDPOINT
|
||||||
|
|
||||||
|
|
||||||
# Build Options
|
# Bootloader selection
|
||||||
# comment out to disable the options.
|
# Teensy halfkay
|
||||||
#
|
# Pro Micro caterina
|
||||||
#BOOTMAGIC_ENABLE = yes # Virtual DIP switch configuration(+1000)
|
# Atmel DFU atmel-dfu
|
||||||
MOUSEKEY_ENABLE = yes # Mouse keys(+4700)
|
# LUFA DFU lufa-dfu
|
||||||
EXTRAKEY_ENABLE = yes # Audio control and System control(+450)
|
# QMK DFU qmk-dfu
|
||||||
CONSOLE_ENABLE = yes # Console for debug(+400)
|
# atmega32a bootloadHID
|
||||||
COMMAND_ENABLE = yes # Commands for debug and configuration
|
ifdef TEENSY2
|
||||||
# Do not enable SLEEP_LED_ENABLE. it uses the same timer as BACKLIGHT_ENABLE
|
BOOTLOADER = halfkay
|
||||||
# SLEEP_LED_ENABLE = yes # Breathing sleep LED during USB suspend
|
OPT_DEFS += -DATREUS_TEENSY2
|
||||||
NKRO_ENABLE = yes # USB Nkey Rollover - not yet supported in LUFA
|
else
|
||||||
# BACKLIGHT_ENABLE = yes # Enable keyboard backlight functionality
|
BOOTLOADER = caterina
|
||||||
# MIDI_ENABLE = YES # MIDI controls
|
OPT_DEFS += -DATREUS_ASTAR
|
||||||
UNICODE_ENABLE = YES # Unicode
|
ifdef PCBDOWN
|
||||||
# BLUETOOTH_ENABLE = yes # Enable Bluetooth with the Adafruit EZ-Key HID
|
OPT_DEFS += -DPCBDOWN
|
||||||
|
endif
|
||||||
|
endif
|
||||||
|
|
||||||
USB = /dev/cu.usbmodem1411
|
|
||||||
|
# If you don't know the bootloader type, then you can specify the
|
||||||
|
# Boot Section Size in *bytes* by uncommenting out the OPT_DEFS line
|
||||||
|
# Teensy halfKay 512
|
||||||
|
# Teensy++ halfKay 1024
|
||||||
|
# Atmel DFU loader 4096
|
||||||
|
# LUFA bootloader 4096
|
||||||
|
# USBaspLoader 2048
|
||||||
|
# OPT_DEFS += -DBOOTLOADER_SIZE=4096
|
||||||
|
|
||||||
|
|
||||||
|
# Build Options
|
||||||
|
# change yes to no to disable
|
||||||
|
#
|
||||||
|
BOOTMAGIC_ENABLE = no # Virtual DIP switch configuration(+1000)
|
||||||
|
MOUSEKEY_ENABLE = yes # Mouse keys(+4700)
|
||||||
|
EXTRAKEY_ENABLE = yes # Audio control and System control(+450)
|
||||||
|
CONSOLE_ENABLE = yes # Console for debug(+400)
|
||||||
|
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 = no # Enable keyboard backlight functionality on B7 by default
|
||||||
|
RGBLIGHT_ENABLE = no # Enable keyboard RGB underglow
|
||||||
|
MIDI_ENABLE = no # MIDI support (+2400 to 4200, depending on config)
|
||||||
|
UNICODE_ENABLE = yes # Unicode
|
||||||
|
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 (+400)
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue