[Keyboard] Add keyboard hifumi (#5341)
	
		
	
				
					
				
			* Add keyboard hifumi * Update keyboards/hifumi/Readme.md Co-Authored-By: zk-phi <zk-phi@users.noreply.github.com> * Update keyboards/hifumi/Readme.md Co-Authored-By: zk-phi <zk-phi@users.noreply.github.com> * Update keyboards/hifumi/Readme.md Co-Authored-By: zk-phi <zk-phi@users.noreply.github.com> * Update keyboards/hifumi/keymaps/default/keymap.c Co-Authored-By: zk-phi <zk-phi@users.noreply.github.com> * Update keyboards/hifumi/keymaps/test/keymap.c Co-Authored-By: zk-phi <zk-phi@users.noreply.github.com> * Update keyboards/hifumi/Readme.md Co-Authored-By: zk-phi <zk-phi@users.noreply.github.com> * Add DIODE_DIRECTION * Rename readme.mdpull/5366/head
							parent
							
								
									0f67232035
								
							
						
					
					
						commit
						5e093ad224
					
				@ -0,0 +1,56 @@
 | 
				
			||||
/*
 | 
				
			||||
Copyright 2019 zk-phi
 | 
				
			||||
 | 
				
			||||
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"
 | 
				
			||||
 | 
				
			||||
/* USB Device descriptor parameter */
 | 
				
			||||
#define VENDOR_ID       0xFEED
 | 
				
			||||
#define PRODUCT_ID      0x3060
 | 
				
			||||
#define DEVICE_VER      0x0001
 | 
				
			||||
#define MANUFACTURER    riconken
 | 
				
			||||
#define PRODUCT         hifumi
 | 
				
			||||
#define DESCRIPTION     A macropad with 6 keys
 | 
				
			||||
 | 
				
			||||
/* key matrix size */
 | 
				
			||||
#define MATRIX_ROWS 2
 | 
				
			||||
#define MATRIX_COLS 3
 | 
				
			||||
 | 
				
			||||
/*
 | 
				
			||||
 * Keyboard Matrix Assignments
 | 
				
			||||
 *
 | 
				
			||||
 * Change this to how you wired your keyboard
 | 
				
			||||
 * COLS: AVR pins used for columns, left to right
 | 
				
			||||
 * ROWS: AVR pins used for rows, top to bottom
 | 
				
			||||
 * DIODE_DIRECTION: COL2ROW = COL = Anode (+), ROW = Cathode (-, marked on diode)
 | 
				
			||||
 *                  ROW2COL = ROW = Anode (+), COL = Cathode (-, marked on diode)
 | 
				
			||||
 *
 | 
				
			||||
*/
 | 
				
			||||
#define MATRIX_ROW_PINS { D4, C6 }
 | 
				
			||||
#define MATRIX_COL_PINS { F4, F5, F6 }
 | 
				
			||||
#define UNUSED_PINS
 | 
				
			||||
#define DIODE_DIRECTION COL2ROW
 | 
				
			||||
 | 
				
			||||
/* Debounce reduces chatter (unintended double-presses) - set 0 if debouncing is not needed */
 | 
				
			||||
#define DEBOUNCING_DELAY 5
 | 
				
			||||
 | 
				
			||||
/* ws2812 RGB LED */
 | 
				
			||||
#define RGB_DI_PIN D3
 | 
				
			||||
#define RGBLED_NUM 6
 | 
				
			||||
#define RGBLIGHT_LIMIT_VAL 255
 | 
				
			||||
#define RGBLIGHT_HUE_STEP 5
 | 
				
			||||
#define RGBLIGHT_ANIMATIONS
 | 
				
			||||
@ -0,0 +1,31 @@
 | 
				
			||||
/* Copyright 2019 zk-phi
 | 
				
			||||
 *
 | 
				
			||||
 * 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 "quantum.h"
 | 
				
			||||
 | 
				
			||||
// This a shortcut to help you visually see your layout.
 | 
				
			||||
// The following is an example using the Planck MIT layout
 | 
				
			||||
// The first section contains all of the arguments
 | 
				
			||||
// The second converts the arguments into a two-dimensional array
 | 
				
			||||
#define LAYOUT( \
 | 
				
			||||
    k00, k01, k02, \
 | 
				
			||||
    k10, k11, k12 \
 | 
				
			||||
) \
 | 
				
			||||
{ \
 | 
				
			||||
    { k00, k01, k02 }, \
 | 
				
			||||
    { k10, k11, k12 } \
 | 
				
			||||
}
 | 
				
			||||
@ -0,0 +1,12 @@
 | 
				
			||||
{
 | 
				
			||||
  "keyboard_name": "hifumi",
 | 
				
			||||
  "url": "https://github.com/zk-phi/1x2x3-keyboard",
 | 
				
			||||
  "maintainer": "riconken",
 | 
				
			||||
  "width": 3,
 | 
				
			||||
  "height": 2,
 | 
				
			||||
  "layouts": {
 | 
				
			||||
    "LAYOUT": {
 | 
				
			||||
        "layout": [{"label":"F5", "x":0, "y":0}, {"label":"Up", "x":1, "y":0}, {"label":"PrSc", "x":2, "y":0}, {"label":"Left", "x":0, "y":1}, {"label":"Down", "x":1, "y":1}, {"label":"Right", "x":2, "y":1}]
 | 
				
			||||
    }
 | 
				
			||||
  }
 | 
				
			||||
}
 | 
				
			||||
@ -0,0 +1,47 @@
 | 
				
			||||
/* Copyright 2019 zk-phi
 | 
				
			||||
 *
 | 
				
			||||
 * 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/>.
 | 
				
			||||
 */
 | 
				
			||||
#include QMK_KEYBOARD_H
 | 
				
			||||
 | 
				
			||||
#ifdef RGBLIGHT_ENABLE
 | 
				
			||||
//Following line allows macro to read current RGB settings
 | 
				
			||||
extern rgblight_config_t rgblight_config;
 | 
				
			||||
#endif
 | 
				
			||||
 | 
				
			||||
enum layers {
 | 
				
			||||
    DEFAULT,
 | 
				
			||||
    RAISE,
 | 
				
			||||
    LOWER,
 | 
				
			||||
    ADJUST
 | 
				
			||||
};
 | 
				
			||||
 | 
				
			||||
const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
 | 
				
			||||
    [DEFAULT] = LAYOUT(
 | 
				
			||||
        LT(RAISE, KC_F5), KC_UP,   LT(LOWER, KC_PSCR),
 | 
				
			||||
        KC_LEFT,          KC_DOWN, KC_RIGHT
 | 
				
			||||
    ),
 | 
				
			||||
    [RAISE] = LAYOUT(
 | 
				
			||||
        _______, KC_PGUP, MO(ADJUST),
 | 
				
			||||
        KC_HOME, KC_PGDN, KC_END
 | 
				
			||||
    ),
 | 
				
			||||
    [LOWER] = LAYOUT(
 | 
				
			||||
        MO(ADJUST), _______, _______,
 | 
				
			||||
        _______,    _______, _______
 | 
				
			||||
    ),
 | 
				
			||||
    [ADJUST] = LAYOUT(
 | 
				
			||||
        _______,        RGB_TOG,        _______,
 | 
				
			||||
        RGB_MODE_SNAKE, RGB_MODE_PLAIN, RGB_HUI
 | 
				
			||||
    )
 | 
				
			||||
};
 | 
				
			||||
@ -0,0 +1,32 @@
 | 
				
			||||
/* Copyright 2019 zk-phi
 | 
				
			||||
 *
 | 
				
			||||
 * 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/>.
 | 
				
			||||
 */
 | 
				
			||||
#include QMK_KEYBOARD_H
 | 
				
			||||
 | 
				
			||||
#ifdef RGBLIGHT_ENABLE
 | 
				
			||||
//Following line allows macro to read current RGB settings
 | 
				
			||||
extern rgblight_config_t rgblight_config;
 | 
				
			||||
#endif
 | 
				
			||||
 | 
				
			||||
enum layers {
 | 
				
			||||
    DEFAULT
 | 
				
			||||
};
 | 
				
			||||
 | 
				
			||||
const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
 | 
				
			||||
    [DEFAULT] = LAYOUT(
 | 
				
			||||
        KC_1, KC_2, KC_3,
 | 
				
			||||
        KC_A, KC_B, KC_C
 | 
				
			||||
    )
 | 
				
			||||
};
 | 
				
			||||
@ -0,0 +1,13 @@
 | 
				
			||||
# hifumi
 | 
				
			||||
 | 
				
			||||
A macro pad with 6 keys.
 | 
				
			||||
 | 
				
			||||
Keyboard Maintainer: riconken, [zk-phi](https://github.com/zk-phi)  
 | 
				
			||||
Hardware Supported: hifumi PCB, Pro Micro   
 | 
				
			||||
Hardware Availability: [PCB & Case Data](https://github.com/zk-phi/1x2x3-keyboard)  
 | 
				
			||||
 | 
				
			||||
Make example for this keyboard (after setting up your build environment):
 | 
				
			||||
 | 
				
			||||
    make hifumi:default
 | 
				
			||||
 | 
				
			||||
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).
 | 
				
			||||
@ -0,0 +1,62 @@
 | 
				
			||||
# MCU name
 | 
				
			||||
#MCU = at90usb1286
 | 
				
			||||
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
 | 
				
			||||
#
 | 
				
			||||
BOOTMAGIC_ENABLE = no       # Virtual DIP switch configuration(+1000)
 | 
				
			||||
MOUSEKEY_ENABLE = no        # Mouse keys(+4700)
 | 
				
			||||
EXTRAKEY_ENABLE = no        # 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
 | 
				
			||||
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.
 | 
				
			||||
SWAP_HANDS_ENABLE = no      # Enable one-hand typing
 | 
				
			||||
					Loading…
					
					
				
		Reference in new issue