summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJason Barnachea <jrbarnachea@gmail.com>2022-03-08 13:24:06 -0800
committerGitHub <noreply@github.com>2022-03-08 21:24:06 +0000
commitd38696a4937525d34445bf23863f99675ec2f54c (patch)
tree3f8c1ccfd683a4a11a6671a51f5e2cdc91a61bd6
parentb593cfccbde7b4fa7feb0e756eb601f7717bed98 (diff)
[Keyboard] Add Rama Works M4-A (#16570)
* Initial commit Add Rama Works M4-A keyboard. * Update default keymap.c * Update keyboards/machine_industries/m4_a/config.h Co-authored-by: Ryan <fauxpark@gmail.com> Co-authored-by: Ryan <fauxpark@gmail.com>
-rw-r--r--keyboards/machine_industries/m4_a/config.h138
-rw-r--r--keyboards/machine_industries/m4_a/info.json15
-rw-r--r--keyboards/machine_industries/m4_a/keymaps/default/keymap.c17
-rw-r--r--keyboards/machine_industries/m4_a/m4_a.c4
-rw-r--r--keyboards/machine_industries/m4_a/m4_a.h22
-rw-r--r--keyboards/machine_industries/m4_a/readme.md27
-rw-r--r--keyboards/machine_industries/m4_a/rules.mk18
7 files changed, 241 insertions, 0 deletions
diff --git a/keyboards/machine_industries/m4_a/config.h b/keyboards/machine_industries/m4_a/config.h
new file mode 100644
index 0000000000..1ba3f4f715
--- /dev/null
+++ b/keyboards/machine_industries/m4_a/config.h
@@ -0,0 +1,138 @@
+// Copyright 2022 naut
+// SPDX-License-Identifier: GPL-2.0-or-later
+
+#pragma once
+
+#include "config_common.h"
+
+/* USB Device descriptor parameter */
+#define VENDOR_ID 0x5241 // "RA"
+#define PRODUCT_ID 0x004A // 4-A
+#define DEVICE_VER 0x0001
+#define MANUFACTURER RAMA WORKS
+#define PRODUCT M4-A
+
+/* key matrix size */
+#define MATRIX_ROWS 2
+#define MATRIX_COLS 2
+
+/*
+ * 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 { C7, C6 }
+#define MATRIX_COL_PINS { F6, F7 }
+#define UNUSED_PINS
+
+/* COL2ROW, ROW2COL */
+#define DIODE_DIRECTION ROW2COL
+
+/*
+ * Split Keyboard specific options, make sure you have 'SPLIT_KEYBOARD = yes' in your rules.mk, and define SOFT_SERIAL_PIN.
+ */
+#define SOFT_SERIAL_PIN D0 // or D1, D2, D3, E6
+
+//#define LED_NUM_LOCK_PIN B0
+//#define LED_CAPS_LOCK_PIN B1
+//#define LED_SCROLL_LOCK_PIN B2
+//#define LED_COMPOSE_PIN B3
+//#define LED_KANA_PIN B4
+
+//#define BACKLIGHT_PIN B7
+//#define BACKLIGHT_LEVELS 3
+//#define BACKLIGHT_BREATHING
+
+//#define RGB_DI_PIN E2
+//#ifdef RGB_DI_PIN
+//# define RGBLED_NUM 16
+//# define RGBLIGHT_HUE_STEP 8
+//# define RGBLIGHT_SAT_STEP 8
+//# define RGBLIGHT_VAL_STEP 8
+//# define RGBLIGHT_LIMIT_VAL 255 /* The maximum brightness level */
+//# define RGBLIGHT_SLEEP /* If defined, the RGB lighting will be switched off when the host goes to sleep */
+/*== all animations enable ==*/
+//# define RGBLIGHT_ANIMATIONS
+/*== or choose animations ==*/
+//# define RGBLIGHT_EFFECT_BREATHING
+//# define RGBLIGHT_EFFECT_RAINBOW_MOOD
+//# define RGBLIGHT_EFFECT_RAINBOW_SWIRL
+//# define RGBLIGHT_EFFECT_SNAKE
+//# define RGBLIGHT_EFFECT_KNIGHT
+//# define RGBLIGHT_EFFECT_CHRISTMAS
+//# define RGBLIGHT_EFFECT_STATIC_GRADIENT
+//# define RGBLIGHT_EFFECT_RGB_TEST
+//# define RGBLIGHT_EFFECT_ALTERNATING
+/*== customize breathing effect ==*/
+/*==== (DEFAULT) use fixed table instead of exp() and sin() ====*/
+//# define RGBLIGHT_BREATHE_TABLE_SIZE 256 // 256(default) or 128 or 64
+/*==== use exp() and sin() ====*/
+//# define RGBLIGHT_EFFECT_BREATHE_CENTER 1.85 // 1 to 2.7
+//# define RGBLIGHT_EFFECT_BREATHE_MAX 255 // 0 to 255
+//#endif
+
+/* Debounce reduces chatter (unintended double-presses) - set 0 if debouncing is not needed */
+#define DEBOUNCE 5
+
+/* define if matrix has ghost (lacks anti-ghosting diodes) */
+//#define MATRIX_HAS_GHOST
+
+/* Mechanical locking support. Use KC_LCAP, KC_LNUM or KC_LSCR instead in keymap */
+#define LOCKING_SUPPORT_ENABLE
+/* Locking resynchronize hack */
+#define LOCKING_RESYNC_ENABLE
+
+/* If defined, GRAVE_ESC will always act as ESC when CTRL is held.
+ * This is useful for the Windows task manager shortcut (ctrl+shift+esc).
+ */
+//#define GRAVE_ESC_CTRL_OVERRIDE
+
+/*
+ * Force NKRO
+ *
+ * Force NKRO (nKey Rollover) to be enabled by default, regardless of the saved
+ * state in the bootmagic EEPROM settings. (Note that NKRO must be enabled in the
+ * makefile for this to work.)
+ *
+ * If forced on, NKRO can be disabled via magic key (default = LShift+RShift+N)
+ * until the next keyboard reset.
+ *
+ * NKRO may prevent your keystrokes from being detected in the BIOS, but it is
+ * fully operational during normal computer usage.
+ *
+ * For a less heavy-handed approach, enable NKRO via magic key (LShift+RShift+N)
+ * or via bootmagic (hold SPACE+N while plugging in the keyboard). Once set by
+ * bootmagic, NKRO mode will always be enabled until it is toggled again during a
+ * power-up.
+ *
+ */
+//#define FORCE_NKRO
+
+/*
+ * Feature disable options
+ * These options are also useful to firmware size reduction.
+ */
+
+/* disable debug print */
+//#define NO_DEBUG
+
+/* disable print */
+//#define NO_PRINT
+
+/* disable action features */
+//#define NO_ACTION_LAYER
+//#define NO_ACTION_TAPPING
+//#define NO_ACTION_ONESHOT
+
+/* disable these deprecated features by default */
+#define NO_ACTION_MACRO
+#define NO_ACTION_FUNCTION
+
+/* Bootmagic Lite key configuration */
+//#define BOOTMAGIC_LITE_ROW 0
+//#define BOOTMAGIC_LITE_COLUMN 0
diff --git a/keyboards/machine_industries/m4_a/info.json b/keyboards/machine_industries/m4_a/info.json
new file mode 100644
index 0000000000..4a2f03e741
--- /dev/null
+++ b/keyboards/machine_industries/m4_a/info.json
@@ -0,0 +1,15 @@
+{
+ "keyboard_name": "Rama Works M4-A",
+ "url": "http://rama.works",
+ "maintainer": "naut",
+ "layouts": {
+ "LAYOUT": {
+ "layout": [
+ {"x":0, "y":0},
+ {"x":1, "y":0},
+ {"x":2, "y":0, "h":2},
+ {"x":0, "y":1, "w":2}
+ ]
+ }
+ }
+}
diff --git a/keyboards/machine_industries/m4_a/keymaps/default/keymap.c b/keyboards/machine_industries/m4_a/keymaps/default/keymap.c
new file mode 100644
index 0000000000..f5c02a185b
--- /dev/null
+++ b/keyboards/machine_industries/m4_a/keymaps/default/keymap.c
@@ -0,0 +1,17 @@
+// Copyright 2022 naut
+// SPDX-License-Identifier: GPL-2.0-or-later
+
+#include QMK_KEYBOARD_H
+
+// Defines names for use in layer keycodes and the keymap
+enum layer_names {
+ _BASE
+};
+
+const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
+ /* Base */
+ [_BASE] = LAYOUT(
+ KC_1, KC_2, KC_3,
+ KC_0
+ )
+};
diff --git a/keyboards/machine_industries/m4_a/m4_a.c b/keyboards/machine_industries/m4_a/m4_a.c
new file mode 100644
index 0000000000..a1598688a8
--- /dev/null
+++ b/keyboards/machine_industries/m4_a/m4_a.c
@@ -0,0 +1,4 @@
+// Copyright 2022 naut
+// SPDX-License-Identifier: GPL-2.0-or-later
+
+#include "m4_a.h"
diff --git a/keyboards/machine_industries/m4_a/m4_a.h b/keyboards/machine_industries/m4_a/m4_a.h
new file mode 100644
index 0000000000..13d3010991
--- /dev/null
+++ b/keyboards/machine_industries/m4_a/m4_a.h
@@ -0,0 +1,22 @@
+// Copyright 2022 naut
+// SPDX-License-Identifier: GPL-2.0-or-later
+
+#pragma once
+
+#include "quantum.h"
+
+/* This is a shortcut to help you visually see your layout.
+ *
+ * The first section contains all of the arguments representing the physical
+ * layout of the board and position of the keys.
+ *
+ * The second converts the arguments into a two-dimensional array which
+ * represents the switch matrix.
+ */
+#define LAYOUT( \
+ k00, k01, k11, \
+ k10 \
+) { \
+ { k00, k01 }, \
+ { k10, k11 } \
+}
diff --git a/keyboards/machine_industries/m4_a/readme.md b/keyboards/machine_industries/m4_a/readme.md
new file mode 100644
index 0000000000..37c16639d1
--- /dev/null
+++ b/keyboards/machine_industries/m4_a/readme.md
@@ -0,0 +1,27 @@
+# Rama Works x Machine Industries M4-A
+
+![Rama Works x Machine Industries M4-A](https://images.squarespace-cdn.com/content/v1/563c788ae4b099120ae219e2/1479361502907-WL2VUR210J6RFD84WH2E/image-asset.jpeg?format=1500w)
+
+A tiny 4-key macropad designed by Rama Works.
+
+* Keyboard Maintainer: [naut](https://github.com/nautxx)
+* Hardware Supported: Rama Works x Machine Industries M4-A PCB
+* Hardware Availability: [Rama Works Store](https://ramaworks.store/)
+
+Make example for this keyboard (after setting up your build environment):
+
+ make machine_industries/m4_a:default
+
+Flashing example for this keyboard:
+
+ make machine_industries/m4_a:default:flash
+
+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).
+
+## Bootloader
+
+Enter the bootloader in 3 ways:
+
+* **Bootmagic reset**: Hold down the key at (0,0) in the matrix (usually the top left key or Escape) and plug in the keyboard
+* **Physical reset button**: Briefly press the button on the back of the PCB - some may have pads you must short instead
+* **Keycode in layout**: Press the key mapped to `RESET` if it is available
diff --git a/keyboards/machine_industries/m4_a/rules.mk b/keyboards/machine_industries/m4_a/rules.mk
new file mode 100644
index 0000000000..1275531ef6
--- /dev/null
+++ b/keyboards/machine_industries/m4_a/rules.mk
@@ -0,0 +1,18 @@
+# MCU name
+MCU = atmega32u4
+
+# Bootloader selection
+BOOTLOADER = atmel-dfu
+
+# Build Options
+# change yes to no to disable
+#
+BOOTMAGIC_ENABLE = yes # Enable Bootmagic Lite
+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
+NKRO_ENABLE = no # Enable N-Key Rollover
+BACKLIGHT_ENABLE = no # Enable keyboard backlight functionality
+RGBLIGHT_ENABLE = no # Enable keyboard RGB underglow
+AUDIO_ENABLE = no # Audio output