~ruther/qmk_firmware

bfbcfbc83e9c496abff002726f7cc07108d99003 — dezli 5 years ago 967ed19
[Keyboard] Add miniMACRO5 Macropad (#10392)

* add miniMACRO5

add all nessecary files for the miniMACRO5

I have rewritten the readme, and changed the keymaps to be more simple. I have tested compiling, and everything works perfectly.

* update miniMACRO5 readme

add the make example into the readme file

* Update keyboards/minimacro5/config.h

Co-authored-by: Ryan <fauxpark@gmail.com>

* Update keyboards/minimacro5/keymaps/default/keymap.c

Co-authored-by: Ryan <fauxpark@gmail.com>

* Update keyboards/minimacro5/keymaps/media/keymap.c

Co-authored-by: Ryan <fauxpark@gmail.com>

* Update keyboards/minimacro5/keymaps/media/keymap.c

Co-authored-by: Ryan <fauxpark@gmail.com>

* Update keyboards/minimacro5/minimacro5.c

Co-authored-by: Ryan <fauxpark@gmail.com>

* Update keyboards/minimacro5/info.json

Co-authored-by: Ryan <fauxpark@gmail.com>

* Apply suggestions from code review

applied all suggestions.

Co-authored-by: Ryan <fauxpark@gmail.com>

* drashna suggestions - enum rather than define

committed enum update by drashna

Co-authored-by: Drashna Jaelre <drashna@live.com>

* update keymap.c

incorrect brackets

Co-authored-by: dezli <m@dez.li>
Co-authored-by: Ryan <fauxpark@gmail.com>
Co-authored-by: Drashna Jaelre <drashna@live.com>
A keyboards/minimacro5/config.h => keyboards/minimacro5/config.h +62 -0
@@ 0,0 1,62 @@
/*
Copyright 2012 Jun Wako <wakojun@gmail.com>

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       0xCEEB
#define PRODUCT_ID      0x0007
#define DEVICE_VER      0x0001
#define MANUFACTURER    leafcutterlabs
#define PRODUCT         miniMACRO5

/* key matrix size */
#define MATRIX_ROWS 1
#define MATRIX_COLS 5

/*
 * 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)
 *                  NO_DIODE = switches are directly connected to AVR pins
 *
*/
// #define MATRIX_ROW_PINS { D0, D5 }
// #define MATRIX_COL_PINS { F1, F0, B0 }
#define DIRECT_PINS {   \
    { F4, B6, B2, D7, B4 } \
}
//speed for double tap
#define TAPPING_TERM 200

#define UNUSED_PINS

/* rotary encoder 1,2,3 closest to usb port is 0*/
#define ENCODERS_PAD_B { D3, F6, F7, D4, C6}
#define ENCODERS_PAD_A { F5, D2, D1, D0, E6}
#define ENCODER_RESOLUTION 2 //default/suggested

/* ws2812 RGB LED */
#define RGB_DI_PIN B5
#define RGBLIGHT_ANIMATIONS
#define RGBLED_NUM 5    // Number of LEDs

A keyboards/minimacro5/info.json => keyboards/minimacro5/info.json +12 -0
@@ 0,0 1,12 @@
{
  "keyboard_name": "minimacro5",
  "url": "",
  "maintainer": "qmk",
  "width": 5,
  "height": 1,
  "layouts": {
    "LAYOUT_ortho_1x5": {
      "layout": [{"x":0, "y":0}, {"x":1, "y":0}, {"x":2, "y":0}, {"x":3, "y":0}, {"x":5, "y":0}]
    }
  }
}

A keyboards/minimacro5/keymaps/default/keymap.c => keyboards/minimacro5/keymaps/default/keymap.c +46 -0
@@ 0,0 1,46 @@
#include QMK_KEYBOARD_H

enum layers {
     _MAIN,
};

void encoder_update_user(uint8_t index, bool clockwise) {
  if (index == 0) { /* First encoder*/
    if (clockwise) {
      tap_code(KC_1);
    } else {
      tap_code(KC_2);
    }
  } else if (index == 1) { /* Second encoder*/
    if (clockwise) {
      tap_code(KC_3);
    } else {
      tap_code(KC_4);
    }
  } else if (index == 2) { /* Third encoder*/
    if (clockwise) {
      tap_code(KC_5);
    } else {
      tap_code(KC_6);
    }
  } else if (index == 3) { /* Fourth encoder*/
    if (clockwise) {
      tap_code(KC_7);
    } else {
      tap_code(KC_8);
    }
  } else if (index == 4) { /* Fifth encoder*/
    if (clockwise) {
      tap_code(KC_9);
    } else {
      tap_code(KC_0);
    }
  }
}

//
const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = { //buttion closest to usb is first
  [_MAIN] = LAYOUT_ortho_1x5(
     KC_A, KC_B, KC_C, KC_D, KC_E
  )
};

A keyboards/minimacro5/keymaps/media/keymap.c => keyboards/minimacro5/keymaps/media/keymap.c +43 -0
@@ 0,0 1,43 @@
#include QMK_KEYBOARD_H

#define _MAIN 0

void encoder_update_user(uint8_t index, bool clockwise) {
  if (index == 0) { /* First encoder*/
    if (clockwise) {
      tap_code(KC_VOLU);
    } else {
      tap_code(KC_VOLD);
    }
  } else if (index == 1) { /* Second encoder*/
    if (clockwise) {
      tap_code(KC_3);
    } else {
      tap_code(KC_4);
    }
  } else if (index == 2) { /* Third encoder*/
    if (clockwise) {
      tap_code(KC_5);
    } else {
      tap_code(KC_6);
    }
  } else if (index == 3) { /* Fourth encoder*/
    if (clockwise) {
      tap_code(KC_7);
    } else {
      tap_code(KC_8);
    }
  } else if (index == 4) { /* Fifth encoder*/
    if (clockwise) {
      tap_code(KC_9);
    } else {
      tap_code(KC_0);
    }
  }
}

const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = { //buttion closest to usb is first
  [_MAIN] = LAYOUT_ortho_1x5(
     KC_MUTE, KC_MEDIA_PREV_TRACK, KC_MEDIA_NEXT_TRACK, KC_MEDIA_PLAY_PAUSE, KC_MEDIA_STOP
  )
};

A keyboards/minimacro5/minimacro5.c => keyboards/minimacro5/minimacro5.c +1 -0
@@ 0,0 1,1 @@
#include "minimacro5.h"

A keyboards/minimacro5/minimacro5.h => keyboards/minimacro5/minimacro5.h +9 -0
@@ 0,0 1,9 @@
#pragma once

#include "quantum.h"

#define LAYOUT_ortho_1x5( \
    k01, k02, k03, k04, k05\
  ) { \
    { k01, k02, k03, k04, k05 } \
}

A keyboards/minimacro5/readme.md => keyboards/minimacro5/readme.md +15 -0
@@ 0,0 1,15 @@
# miniMACRO5

A 5 key Macropad based on Arduino Pro Micro with support for a combination of rotary encoders and mechanical switches.

![](https://i.imgur.com/lxA8DSCl.jpg)

* Keyboard Maintainer: [LeafCutterLabs](https://github.com/LeafCutterLabs)
* Hardware Supported: Pro Micro 5V/16MHz and compatible.
* Hardware availability: PCB Files are available [here](https://github.com/LeafCutterLabs/miniMACRO5), which you can get produced.

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

    make minimacro5: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).

A keyboards/minimacro5/rules.mk => keyboards/minimacro5/rules.mk +23 -0
@@ 0,0 1,23 @@
# MCU name
MCU = atmega32u4

# Bootloader selection
BOOTLOADER = caterina

# Build Options
#   change yes to no to disable
#
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 = no         # 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
RGBLIGHT_ENABLE = yes       # Enable keyboard RGB underglow
BLUETOOTH_ENABLE = no       # Enable Bluetooth
AUDIO_ENABLE = no           # Audio output
ENCODER_ENABLE = yes        #enable rotary encoders