Skip to content

Commit

Permalink
[Keyboard] PCB Ruler updates (#6584)
Browse files Browse the repository at this point in the history
* Move default keymap's rules to keyboard level

* Concatenate the two sets of rules

This sets CONSOLE_ENABLE to no, which was being set at the keymap level.

* Wrap the USB Device Description in quotes

Some preventative maintenance. The firmware for the_ruler can't be compiled without this change if `CONSOLE_ENABLE = yes` because this string has a comma, which gets picked up as two arguments by the Command code, instead of one as it should be.

* Linting

- remove firmware size impacts
- remove trailing white space
- visual alignment of rules

* Use QMK's pre-loaded default rules for atmega32u4

* Update readme

- markdown formatting
- update Hardware Availability link (Maple Computing's site has disappeared)
- update Docs links

* Update header files to use #pragma once
  • Loading branch information
noroadsleft authored and drashna committed Aug 21, 2019
1 parent 5fca6c0 commit 367eac2
Show file tree
Hide file tree
Showing 5 changed files with 12 additions and 74 deletions.
7 changes: 2 additions & 5 deletions keyboards/the_ruler/config.h
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,7 @@ You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
*/

#ifndef CONFIG_H
#define CONFIG_H
#pragma once

#include "config_common.h"

Expand All @@ -26,7 +25,7 @@ along with this program. If not, see <http://www.gnu.org/licenses/>.
#define DEVICE_VER 0x0001
#define MANUFACTURER Maple Computing
#define PRODUCT The PCB Ruler
#define DESCRIPTION A custom keyboard PCB ruler, can also function as a macro pad
#define DESCRIPTION "A custom keyboard PCB ruler, can also function as a macro pad"

/* key matrix size */
#define MATRIX_ROWS 1
Expand Down Expand Up @@ -155,5 +154,3 @@ along with this program. If not, see <http://www.gnu.org/licenses/>.
#define RGBLIGHT_HUE_STEP 10
#define RGBLIGHT_SAT_STEP 17
#define RGBLIGHT_VAL_STEP 17

#endif
18 changes: 0 additions & 18 deletions keyboards/the_ruler/keymaps/default/rules.mk
Original file line number Diff line number Diff line change
@@ -1,18 +0,0 @@
# 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
#
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 = no # Console for debug(+400)
COMMAND_ENABLE = yes # 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
MIDI_ENABLE = no # MIDI controls
AUDIO_ENABLE = no # Audio output on port C6
UNICODE_ENABLE = no # Unicode
BLUETOOTH_ENABLE = no # Enable Bluetooth with the Adafruit EZ-Key HID
RGBLIGHT_ENABLE = yes # Enable WS2812 RGB underlight.
SLEEP_LED_ENABLE = no # Breathing sleep LED during USB suspend

9 changes: 4 additions & 5 deletions keyboards/the_ruler/readme.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,13 @@
The Ruler PCB
=======
# The Ruler PCB

A custom keyboard PCB ruler, that can also function as a macro pad
A custom keyboard PCB ruler, that can also function as a macro pad.

Keyboard Maintainer: Maple Computing
Hardware Supported: PCB Ruler V1 by That-Canadian and Bishop Keyboards
Hardware Availability: https://www.maple-computing.com/products/pcb-ruler-v1-1
Hardware Availability: [Bishop Keyboards](https://bishopkeyboards.com/product/pcb-ruler-gloss-black-silver/)

Make example for this keyboard (after setting up your build environment):

make the_ruler:default

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.
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).
47 changes: 5 additions & 42 deletions keyboards/the_ruler/rules.mk
Original file line number Diff line number Diff line change
@@ -1,43 +1,6 @@
# 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)

# Interrupt driven control endpoint task(+60)
OPT_DEFS += -DINTERRUPT_CONTROL_ENDPOINT


# Boot Section Size in *bytes*
# Teensy halfKay 512
# Teensy++ halfKay 1024
Expand All @@ -50,10 +13,10 @@ 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)
BOOTMAGIC_ENABLE = no # Virtual DIP switch configuration
MOUSEKEY_ENABLE = yes # Mouse keys
EXTRAKEY_ENABLE = yes # Audio control and System control
CONSOLE_ENABLE = no # 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
Expand All @@ -64,4 +27,4 @@ MIDI_ENABLE = no # MIDI controls
UNICODE_ENABLE = no # Unicode
BLUETOOTH_ENABLE = no # Enable Bluetooth with the Adafruit EZ-Key HID
AUDIO_ENABLE = no # Audio output on port C6
RGBLIGHT_ENABLE = yes # Enable WS2812 RGB underlight.
RGBLIGHT_ENABLE = yes # Enable WS2812 RGB underlight.
5 changes: 1 addition & 4 deletions keyboards/the_ruler/the_ruler.h
Original file line number Diff line number Diff line change
@@ -1,11 +1,8 @@
#ifndef THERULER_H
#define THERULER_H
#pragma once

#include "quantum.h"

#define LAYOUT( \
K00, K01, K02, K03, K04, K05 ) { \
{ K00, K01, K02, K03, K04, K05 } \
}

#endif

0 comments on commit 367eac2

Please sign in to comment.