added complete example

hackpads/orpheuspad/firmware/KMK/README.md

@@ -0,0 +1,6 @@
+# Firmware
+
+In here you'll find 2 folders: 
+
+**QMK**: This is a port of [QMK](https://docs.qmk.fm/) to Orpheuspad, with VIA support. It's configured using C++ and JSON, and is generally harder to set up // configure \
+**KMK**: This is a port of [KMK](https://github.com/KMKfw/kmk_firmware). Compared to QMK, it's less powerful, but offers easier configuration through 2 python files/

hackpads/orpheuspad/firmware/KMK/kb.py

@@ -0,0 +1,11 @@
+import board
+
+from kmk.kmk_keyboard import KMKKeyboard as _KMKKeyboard
+from kmk.scanners import DiodeOrientation
+
+
+class KMKKeyboard(_KMKKeyboard):
+    keyboard.col_pins = (board.GP27, board.GP26)
+    keyboard.row_pins = (board.GP29, board.GP28)
+
+    keyboard.diode_orientation = DiodeOrientation.COL2ROW

hackpads/orpheuspad/firmware/KMK/main.py

@@ -0,0 +1,52 @@
+# DEAD CODE, NOT DONE!
+
+print("Hackpad Testing!")
+
+# Basic imports for orpheuspad
+import board
+
+from kmk.kmk_keyboard import KMKKeyboard
+from kmk.keys import KC
+from kmk.scanners import DiodeOrientation
+
+# Extra features
+
+from kmk.modules.encoder import EncoderHandler
+from kmk.extensions.RGB import RGB
+
+
+print(dir(board))
+
+keyboard = KMKKeyboard()
+
+keyboard.col_pins = (board.GP27, board.GP26)
+keyboard.row_pins = (board.GP29, board.GP28)
+
+keyboard.diode_orientation = DiodeOrientation.COL2ROW
+
+# RGB imports
+# TODO: ADD PINS
+rgb = RGB(pixel_pin=board.GP3, num_pixels=2)
+keyboard.extensions.append(rgb)
+
+# TODO: add OLED display
+
+encoder_handler = EncoderHandler()
+encoder_handler.pins = ((keyboard.pin_a, keyboard.pin_b, None, False))
+
+
+keyboard.keymap = [ # TODO: fix this lol
+    [
+        # Example for rotary encoder
+        KC.AUDIO_VOL_DOWN,
+        KC.AUDIO_VOL_UP,
+
+        # switches
+              KC.F, 
+        KC.U, KC.C, KC.K,
+    ]
+]
+
+
+if __name__ == '__main__':
+    keyboard.go()

hackpads/orpheuspad/firmware/QMK/config.h

@@ -0,0 +1,9 @@
+#define ENCODER_A_PINS { GP2 }
+#define ENCODER_B_PINS { GP1 }
+
+#define WS2812_DI_PIN GP3
+#define RGBLIGHT_LED_COUNT 2
+
+#define I2C_DRIVER I2CD1
+#define I2C1_SDA_PIN GP6
+#define I2C1_SCL_PIN GP7

hackpads/orpheuspad/firmware/QMK/keyboard.json

@@ -0,0 +1,37 @@
+{
+    "manufacturer": "Alex Ren",
+    "keyboard_name": "orpheuspad",
+    "maintainer": "qcoral",
+    "bootloader": "rp2040",
+    "diode_direction": "COL2ROW",
+    "features": {
+        "bootmagic": true,
+        "command": false,
+        "console": false,
+        "extrakey": true,
+        "mousekey": true,
+        "nkro": true
+    },
+    "matrix_pins": {
+        "cols": ["GP27", "GP26", "GP4"],
+        "rows": ["GP29", "GP28"]
+    },
+    "processor": "RP2040",
+    "url": "https://hackpad.hackclub.com",
+    "usb": {
+        "device_version": "1.0.0",
+        "pid": "0x0000",
+        "vid": "0xFEED"
+    },
+    "layouts": {
+        "LAYOUT": {
+            "layout": [
+                {"matrix": [0, 0], "x": 1, "y": 1},
+                {"matrix": [0, 1], "x": 2, "y": 0},
+                {"matrix": [0, 2], "x": 2, "y": 1},
+                {"matrix": [1, 0], "x": 0, "y": 0},
+                {"matrix": [1, 1], "x": 1, "y": 0},
+            ]
+        }
+    }
+}

hackpads/orpheuspad/firmware/QMK/keymaps/default/keymap.c

@@ -0,0 +1,56 @@
+// Copyright 2023 QMK
+// SPDX-License-Identifier: GPL-2.0-or-later
+
+#include QMK_KEYBOARD_H
+
+enum layer_names {
+    _BASE,
+};
+
+const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
+    /*
+     *     ┬───┐
+     *     │ 2 │
+     * ├───┼───┼───┤
+     * │ 3 │ 5 │ 6 │
+     * └───┴───┴───┘
+     */
+
+    /*
+    The wiring is a little convoluted - refer to the diagram below:
+    
+    */
+    [_BASE] = LAYOUT(
+        KC_P7, KC_P8, KC_P4,
+        KC_P5, KC_P6
+    )
+};
+
+const uint16_t PROGMEM encoder_map[][1][2] = {
+    [0] = { ENCODER_CCW_CW(MS_WHLU, MS_WHLD) },
+};
+
+
+#ifdef OLED_ENABLE
+bool oled_task_user(void) {
+    // Host Keyboard Layer Status
+    oled_write_P(PSTR("Layer: "), false);
+
+    switch (get_highest_layer(layer_state)) {
+        case _BASE:
+            oled_write_P(PSTR("Default\n"), false);
+            break;
+        default:
+            // Or use the write_ln shortcut over adding '\n' to the end of your string
+            oled_write_ln_P(PSTR("Undefined"), false);
+    }
+
+    // Host Keyboard LED Status
+    led_t led_state = host_keyboard_led_state();
+    oled_write_P(led_state.num_lock ? PSTR("NUM ") : PSTR("    "), false);
+    oled_write_P(led_state.caps_lock ? PSTR("CAP ") : PSTR("    "), false);
+    oled_write_P(led_state.scroll_lock ? PSTR("SCR ") : PSTR("    "), false);
+    
+    return false;
+}
+#endif

hackpads/orpheuspad/firmware/QMK/keymaps/via/README.md

@@ -0,0 +1,2 @@
+# VIA Support
+Not complete.

hackpads/orpheuspad/firmware/QMK/keymaps/via/keymap.c

@@ -0,0 +1,56 @@
+// Copyright 2023 QMK
+// SPDX-License-Identifier: GPL-2.0-or-later
+
+#include QMK_KEYBOARD_H
+
+enum layer_names {
+    _BASE,
+};
+
+const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
+    /*
+     *     ┬───┐
+     *     │ 2 │
+     * ├───┼───┼───┤
+     * │ 3 │ 5 │ 6 │
+     * └───┴───┴───┘
+     */
+
+    /*
+    The wiring is a little convoluted - refer to the diagram below:
+    
+    */
+    [_BASE] = LAYOUT(
+        KC_P7, KC_P8, KC_P4,
+        KC_P5, KC_P6
+    )
+};
+
+const uint16_t PROGMEM encoder_map[][1][2] = {
+    [0] = { ENCODER_CCW_CW(MS_WHLU, MS_WHLD) },
+};
+
+
+#ifdef OLED_ENABLE
+bool oled_task_user(void) {
+    // Host Keyboard Layer Status
+    oled_write_P(PSTR("Layer: "), false);
+
+    switch (get_highest_layer(layer_state)) {
+        case _BASE:
+            oled_write_P(PSTR("Default\n"), false);
+            break;
+        default:
+            // Or use the write_ln shortcut over adding '\n' to the end of your string
+            oled_write_ln_P(PSTR("Undefined"), false);
+    }
+
+    // Host Keyboard LED Status
+    led_t led_state = host_keyboard_led_state();
+    oled_write_P(led_state.num_lock ? PSTR("NUM ") : PSTR("    "), false);
+    oled_write_P(led_state.caps_lock ? PSTR("CAP ") : PSTR("    "), false);
+    oled_write_P(led_state.scroll_lock ? PSTR("SCR ") : PSTR("    "), false);
+    
+    return false;
+}
+#endif

hackpads/orpheuspad/firmware/QMK/keymaps/via/rules.mk

@@ -0,0 +1 @@
+VIA_ENABLE = yes

hackpads/orpheuspad/firmware/QMK/readme.md

@@ -0,0 +1,27 @@
+# orpheuspad
+
+![orpheuspad](imgur.com image replace me!)
+
+*A short description of the keyboard/project*
+
+* Keyboard Maintainer: [Alex Ren](https://github.com/qcoral)
+* Hardware Supported: *The PCBs, controllers supported*
+* Hardware Availability: *Links to where you can find this hardware*
+
+Make example for this keyboard (after setting up your build environment):
+
+    make orpheuspad:default
+
+Flashing example for this keyboard:
+
+    make orpheuspad: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 `QK_BOOT` if it is available

hackpads/orpheuspad/firmware/QMK/rules.mk

@@ -0,0 +1,11 @@
+OLED_ENABLE = yes
+OLED_TRANSPORT = i2c
+OLED_DRIVER = ssd1306
+
+RGBLIGHT_ENABLE = yes
+WS2812_DRIVER = vendor
+
+ENCODER_ENABLE = yes
+ENCODER_MAP_ENABLE = yes
+# required for rp2040
+LTO_ENABLE = yes

hackpads/orpheuspad/firmware/README.md

@@ -0,0 +1,7 @@
+# Firmware
+
+Inside of here you'll find two folders:
+
+**KMK:** This is a port of orpheuspad to KMK Firmware. Currently nont done
+
+**QMK:** This is a port of orpheuspad to QMK firmware. Very primitive setup currently, but it works!

hackpads/orpheuspad/pcb/fp-lib-table

@@ -0,0 +1,8 @@
+(fp_lib_table
+  (version 7)
+  (lib (name "Kailh_PG1353_Solderable")(type "KiCad")(uri "${KIPRJMOD}/libraries/MX_V2/Kailh_PG1353_Solderable.pretty")(options "")(descr ""))
+  (lib (name "MX_Solderable")(type "KiCad")(uri "${KIPRJMOD}/libraries/MX_V2/MX_Solderable.pretty")(options "")(descr ""))
+  (lib (name "Seeed Studio XIAO Series Library")(type "KiCad")(uri "${KIPRJMOD}/libraries/OPL_Kicad_Library/Seeed Studio XIAO Series Library")(options "")(descr ""))
+  (lib (name "Rotary_Encoder")(type "KiCad")(uri "${KIPRJMOD}/libraries/Rotary_Encoder.pretty")(options "")(descr ""))
+  (lib (name "assets")(type "KiCad")(uri "${KIPRJMOD}/assets")(options "")(descr ""))
+)

hackpads/orpheuspad/pcb/orpheuspad_pcb.kicad_prl

@@ -1,6 +1,6 @@
 {
   "board": {
-    "active_layer": 44,
+    "active_layer": 31,
     "active_layer_preset": "All Layers",
     "auto_track_width": true,
     "hidden_netclasses": [],

hackpads/orpheuspad/pcb/orpheuspad_pcb.kicad_pro

@@ -2,12 +2,204 @@
   "board": {
     "3dviewports": [],
     "design_settings": {
-      "defaults": {},
+      "defaults": {
+        "apply_defaults_to_fp_fields": false,
+        "apply_defaults_to_fp_shapes": false,
+        "apply_defaults_to_fp_text": false,
+        "board_outline_line_width": 0.049999999999999996,
+        "copper_line_width": 0.19999999999999998,
+        "copper_text_italic": false,
+        "copper_text_size_h": 1.5,
+        "copper_text_size_v": 1.5,
+        "copper_text_thickness": 0.3,
+        "copper_text_upright": false,
+        "courtyard_line_width": 0.049999999999999996,
+        "dimension_precision": 4,
+        "dimension_units": 3,
+        "dimensions": {
+          "arrow_length": 1270000,
+          "extension_offset": 500000,
+          "keep_text_aligned": true,
+          "suppress_zeroes": false,
+          "text_position": 0,
+          "units_format": 1
+        },
+        "fab_line_width": 0.09999999999999999,
+        "fab_text_italic": false,
+        "fab_text_size_h": 1.0,
+        "fab_text_size_v": 1.0,
+        "fab_text_thickness": 0.15,
+        "fab_text_upright": false,
+        "other_line_width": 0.09999999999999999,
+        "other_text_italic": false,
+        "other_text_size_h": 1.0,
+        "other_text_size_v": 1.0,
+        "other_text_thickness": 0.15,
+        "other_text_upright": false,
+        "pads": {
+          "drill": 0.762,
+          "height": 1.524,
+          "width": 1.524
+        },
+        "silk_line_width": 0.09999999999999999,
+        "silk_text_italic": false,
+        "silk_text_size_h": 1.0,
+        "silk_text_size_v": 1.0,
+        "silk_text_thickness": 0.09999999999999999,
+        "silk_text_upright": false,
+        "zones": {
+          "min_clearance": 0.5
+        }
+      },
       "diff_pair_dimensions": [],
       "drc_exclusions": [],
-      "rules": {},
+      "meta": {
+        "version": 2
+      },
+      "rule_severities": {
+        "annular_width": "error",
+        "clearance": "error",
+        "connection_width": "warning",
+        "copper_edge_clearance": "error",
+        "copper_sliver": "warning",
+        "courtyards_overlap": "error",
+        "diff_pair_gap_out_of_range": "error",
+        "diff_pair_uncoupled_length_too_long": "error",
+        "drill_out_of_range": "error",
+        "duplicate_footprints": "warning",
+        "extra_footprint": "warning",
+        "footprint": "error",
+        "footprint_symbol_mismatch": "warning",
+        "footprint_type_mismatch": "ignore",
+        "hole_clearance": "error",
+        "hole_near_hole": "error",
+        "holes_co_located": "warning",
+        "invalid_outline": "error",
+        "isolated_copper": "warning",
+        "item_on_disabled_layer": "error",
+        "items_not_allowed": "error",
+        "length_out_of_range": "error",
+        "lib_footprint_issues": "warning",
+        "lib_footprint_mismatch": "warning",
+        "malformed_courtyard": "error",
+        "microvia_drill_out_of_range": "error",
+        "missing_courtyard": "ignore",
+        "missing_footprint": "warning",
+        "net_conflict": "warning",
+        "npth_inside_courtyard": "ignore",
+        "padstack": "warning",
+        "pth_inside_courtyard": "ignore",
+        "shorting_items": "error",
+        "silk_edge_clearance": "warning",
+        "silk_over_copper": "warning",
+        "silk_overlap": "warning",
+        "skew_out_of_range": "error",
+        "solder_mask_bridge": "error",
+        "starved_thermal": "error",
+        "text_height": "warning",
+        "text_thickness": "warning",
+        "through_hole_pad_without_hole": "error",
+        "too_many_vias": "error",
+        "track_dangling": "warning",
+        "track_width": "error",
+        "tracks_crossing": "error",
+        "unconnected_items": "error",
+        "unresolved_variable": "error",
+        "via_dangling": "warning",
+        "zones_intersect": "error"
+      },
+      "rules": {
+        "max_error": 0.005,
+        "min_clearance": 0.0,
+        "min_connection": 0.0,
+        "min_copper_edge_clearance": 0.5,
+        "min_hole_clearance": 0.25,
+        "min_hole_to_hole": 0.25,
+        "min_microvia_diameter": 0.19999999999999998,
+        "min_microvia_drill": 0.09999999999999999,
+        "min_resolved_spokes": 2,
+        "min_silk_clearance": 0.0,
+        "min_text_height": 0.7999999999999999,
+        "min_text_thickness": 0.08,
+        "min_through_hole_diameter": 0.3,
+        "min_track_width": 0.0,
+        "min_via_annular_width": 0.09999999999999999,
+        "min_via_diameter": 0.5,
+        "solder_mask_to_copper_clearance": 0.0,
+        "use_height_for_length_calcs": true
+      },
+      "teardrop_options": [
+        {
+          "td_onpadsmd": true,
+          "td_onroundshapesonly": false,
+          "td_ontrackend": false,
+          "td_onviapad": true
+        }
+      ],
+      "teardrop_parameters": [
+        {
+          "td_allow_use_two_tracks": true,
+          "td_curve_segcount": 0,
+          "td_height_ratio": 1.0,
+          "td_length_ratio": 0.5,
+          "td_maxheight": 2.0,
+          "td_maxlen": 1.0,
+          "td_on_pad_in_zone": false,
+          "td_target_name": "td_round_shape",
+          "td_width_to_size_filter_ratio": 0.9
+        },
+        {
+          "td_allow_use_two_tracks": true,
+          "td_curve_segcount": 0,
+          "td_height_ratio": 1.0,
+          "td_length_ratio": 0.5,
+          "td_maxheight": 2.0,
+          "td_maxlen": 1.0,
+          "td_on_pad_in_zone": false,
+          "td_target_name": "td_rect_shape",
+          "td_width_to_size_filter_ratio": 0.9
+        },
+        {
+          "td_allow_use_two_tracks": true,
+          "td_curve_segcount": 0,
+          "td_height_ratio": 1.0,
+          "td_length_ratio": 0.5,
+          "td_maxheight": 2.0,
+          "td_maxlen": 1.0,
+          "td_on_pad_in_zone": false,
+          "td_target_name": "td_track_end",
+          "td_width_to_size_filter_ratio": 0.9
+        }
+      ],
       "track_widths": [],
-      "via_dimensions": []
+      "tuning_pattern_settings": {
+        "diff_pair_defaults": {
+          "corner_radius_percentage": 80,
+          "corner_style": 1,
+          "max_amplitude": 1.0,
+          "min_amplitude": 0.2,
+          "single_sided": false,
+          "spacing": 1.0
+        },
+        "diff_pair_skew_defaults": {
+          "corner_radius_percentage": 80,
+          "corner_style": 1,
+          "max_amplitude": 1.0,
+          "min_amplitude": 0.2,
+          "single_sided": false,
+          "spacing": 0.6
+        },
+        "single_track_defaults": {
+          "corner_radius_percentage": 80,
+          "corner_style": 1,
+          "max_amplitude": 1.0,
+          "min_amplitude": 0.2,
+          "single_sided": false,
+          "spacing": 0.6
+        }
+      },
+      "via_dimensions": [],
+      "zones_allow_external_fillets": false
     },
     "ipc2581": {
       "dist": "",
@@ -277,7 +469,7 @@
       "plot": "",
       "pos_files": "",
       "specctra_dsn": "",
-      "step": "",
+      "step": "orpheuspad_pcb_final.step",
       "svg": "",
       "vrml": ""
     },