Merge pull request #577 from Kale-Wu/main

Add RGBar (hackpad)
This commit is contained in:
Taran Mittal 2025-10-12 23:05:06 +11:00 committed by GitHub
commit d177ed78c1
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
14 changed files with 508526 additions and 0 deletions

File diff suppressed because it is too large Load diff

View file

@ -0,0 +1,9 @@
import board
from kmk.kmk_keyboard import KMKKeyboard as _KMKKeyboard
from kmk.scanners import DiodeOrientation
class KMKKeyboard(_KMKKeyboard):
col_pins = (board.D2, board.D3, board.D4, board.D5)
row_pins = (board.D1, board.D7)
diode_orientation = DiodeOrientation.ROW2COL

View file

@ -0,0 +1,103 @@
'''
KW-01 RGBar V1
Untested code for a 2x4 macropad using the XIAO RP2040.
Currently supports simple numpad function. Blocked on hardware assembly.
'''
import board
import neopixel
from screen_brightness_control import set_brightness, get_brightness
from kmk.kmk_keyboard import KMKKeyboard
from kmk.scanners.matrix import MatrixScanner, DiodeOrientation
from kmk.keys import KC
from kmk.modules.macros import Press, Release, Tap, Macros
from kmk.modules.encoder import EncoderHandler
# Initialize the NeoPixel chain
NUM_PIXELS = 8
pixels = neopixel.NeoPixel(board.D6, NUM_PIXELS, auto_write=False)
keys_pressed = []
# Define colors for each key
colors = [
(255, 0, 0), # Red
(0, 255, 0), # Green
(0, 0, 255), # Blue
(255, 255, 0), # Yellow
(0, 255, 255), # Cyan
(255, 0, 255), # Magenta
(255, 255, 255),# White
(128, 0, 128) # Purple
]
# Encoder rotation
def encoder_handler(direction):
SCREEN_BRIGHTNESS = get_brightness()
if direction == 1:
# Increase brightness
print("Increase brightness")
SCREEN_BRIGHTNESS += 1
set_brightness(SCREEN_BRIGHTNESS)
elif direction == -1:
# Decrease brightness
print("Decrease brightness")
SCREEN_BRIGHTNESS -= 1
set_brightness(SCREEN_BRIGHTNESS)
# Neopixel lighting
def update_keys():
for i in range(NUM_PIXELS):
if i in keys_pressed:
pixels[i] = colors[i]
else:
pixels[i] = (0, 0, 0)
pixels.show()
def press(key):
keys_pressed.append(key.index)
update_keys()
return Press(key)
def release(key):
keys_pressed.remove(key.index)
update_keys()
return Release(key)
keyboard = KMKKeyboard()
macros = Macros()
keyboard.modules.append(macros)
# Matrix definitions
ROW_PINS = [board.D1, board.D7]
COL_PINS = [board.D2, board.D3, board.D4, board.D5]
# Matrix scanner
keyboard.matrix = MatrixScanner(
cols=COL_PINS,
rows=ROW_PINS,
diode_orientation=DiodeOrientation.ROW2COL
)
# Encoder definition
ENCODER_PINS = (board.D9, board.D10)
# Encoder handler
encoder = EncoderHandler(ENCODER_PINS, encoder_handler)
keyboard.modules.append(encoder)
# Here you define the buttons corresponding to the matrix
# Look here for keycodes: https://github.com/KMKfw/kmk_firmware/blob/main/docs/en/keycodes.md
# And here for macros: https://github.com/KMKfw/kmk_firmware/blob/main/docs/en/macros.md
keyboard.keymap = [
[KC.N1, KC.N2, KC.N3, KC.N4],
[KC.N5, KC.N6, KC.N7, KC.N8]
]
macros.press = press
macros.release = release
# Start kmk!
if __name__ == '__main__':
keyboard.go()

View file

@ -0,0 +1 @@
KMK port stand-in code awaiting hardware testing.

File diff suppressed because it is too large Load diff

View file

@ -0,0 +1,83 @@
{
"board": {
"active_layer": 48,
"active_layer_preset": "",
"auto_track_width": true,
"hidden_netclasses": [],
"hidden_nets": [],
"high_contrast_mode": 0,
"net_color_mode": 1,
"opacity": {
"images": 0.6,
"pads": 1.0,
"tracks": 1.0,
"vias": 1.0,
"zones": 0.6
},
"selection_filter": {
"dimensions": true,
"footprints": true,
"graphics": true,
"keepouts": true,
"lockedItems": false,
"otherItems": true,
"pads": true,
"text": true,
"tracks": true,
"vias": true,
"zones": true
},
"visible_items": [
0,
1,
2,
3,
4,
5,
8,
9,
10,
11,
12,
13,
15,
16,
17,
18,
19,
20,
21,
22,
23,
24,
25,
26,
27,
28,
29,
30,
32,
33,
34,
35,
36,
39,
40
],
"visible_layers": "803feff_ffffffff",
"zone_display_mode": 0
},
"git": {
"repo_password": "",
"repo_type": "",
"repo_username": "",
"ssh_key": ""
},
"meta": {
"filename": "Hackpad Circuit Schematic.kicad_prl",
"version": 3
},
"project": {
"files": []
}
}

View file

@ -0,0 +1,582 @@
{
"board": {
"3dviewports": [],
"design_settings": {
"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": [],
"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",
"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.005,
"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": [],
"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": "",
"distpn": "",
"internal_id": "",
"mfg": "",
"mpn": ""
},
"layer_presets": [],
"viewports": []
},
"boards": [],
"cvpcb": {
"equivalence_files": []
},
"erc": {
"erc_exclusions": [],
"meta": {
"version": 0
},
"pin_map": [
[
0,
0,
0,
0,
0,
0,
1,
0,
0,
0,
0,
2
],
[
0,
2,
0,
1,
0,
0,
1,
0,
2,
2,
2,
2
],
[
0,
0,
0,
0,
0,
0,
1,
0,
1,
0,
1,
2
],
[
0,
1,
0,
0,
0,
0,
1,
1,
2,
1,
1,
2
],
[
0,
0,
0,
0,
0,
0,
1,
0,
0,
0,
0,
2
],
[
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
2
],
[
1,
1,
1,
1,
1,
0,
1,
1,
1,
1,
1,
2
],
[
0,
0,
0,
1,
0,
0,
1,
0,
0,
0,
0,
2
],
[
0,
2,
1,
2,
0,
0,
1,
0,
2,
2,
2,
2
],
[
0,
2,
0,
1,
0,
0,
1,
0,
2,
0,
0,
2
],
[
0,
2,
1,
1,
0,
0,
1,
0,
2,
0,
0,
2
],
[
2,
2,
2,
2,
2,
2,
2,
2,
2,
2,
2,
2
]
],
"rule_severities": {
"bus_definition_conflict": "error",
"bus_entry_needed": "error",
"bus_to_bus_conflict": "error",
"bus_to_net_conflict": "error",
"conflicting_netclasses": "error",
"different_unit_footprint": "error",
"different_unit_net": "error",
"duplicate_reference": "error",
"duplicate_sheet_names": "error",
"endpoint_off_grid": "warning",
"extra_units": "error",
"global_label_dangling": "warning",
"hier_label_mismatch": "error",
"label_dangling": "error",
"lib_symbol_issues": "warning",
"missing_bidi_pin": "warning",
"missing_input_pin": "warning",
"missing_power_pin": "error",
"missing_unit": "warning",
"multiple_net_names": "warning",
"net_not_bus_member": "warning",
"no_connect_connected": "warning",
"no_connect_dangling": "warning",
"pin_not_connected": "error",
"pin_not_driven": "error",
"pin_to_pin": "warning",
"power_pin_not_driven": "error",
"similar_labels": "warning",
"simulation_model_issue": "ignore",
"unannotated": "error",
"unit_value_mismatch": "error",
"unresolved_variable": "error",
"wire_dangling": "error"
}
},
"libraries": {
"pinned_footprint_libs": [],
"pinned_symbol_libs": []
},
"meta": {
"filename": "Hackpad Circuit Schematic.kicad_pro",
"version": 1
},
"net_settings": {
"classes": [
{
"bus_width": 12,
"clearance": 0.2,
"diff_pair_gap": 0.25,
"diff_pair_via_gap": 0.25,
"diff_pair_width": 0.2,
"line_style": 0,
"microvia_diameter": 0.3,
"microvia_drill": 0.1,
"name": "Default",
"pcb_color": "rgba(0, 0, 0, 0.000)",
"schematic_color": "rgba(0, 0, 0, 0.000)",
"track_width": 0.2,
"via_diameter": 0.6,
"via_drill": 0.3,
"wire_width": 6
}
],
"meta": {
"version": 3
},
"net_colors": null,
"netclass_assignments": null,
"netclass_patterns": []
},
"pcbnew": {
"last_paths": {
"gencad": "",
"idf": "",
"netlist": "",
"plot": "../Production/",
"pos_files": "",
"specctra_dsn": "",
"step": "Hackpad Circuit Schematic.step",
"svg": "",
"vrml": "Hackpad Circuit Schematic.wrl"
},
"page_layout_descr_file": ""
},
"schematic": {
"annotate_start_num": 0,
"bom_fmt_presets": [],
"bom_fmt_settings": {
"field_delimiter": ",",
"keep_line_breaks": false,
"keep_tabs": false,
"name": "CSV",
"ref_delimiter": ",",
"ref_range_delimiter": "",
"string_delimiter": "\""
},
"bom_presets": [],
"bom_settings": {
"exclude_dnp": false,
"fields_ordered": [
{
"group_by": false,
"label": "Reference",
"name": "Reference",
"show": true
},
{
"group_by": true,
"label": "Value",
"name": "Value",
"show": true
},
{
"group_by": false,
"label": "Datasheet",
"name": "Datasheet",
"show": true
},
{
"group_by": false,
"label": "Footprint",
"name": "Footprint",
"show": true
},
{
"group_by": false,
"label": "Qty",
"name": "${QUANTITY}",
"show": true
},
{
"group_by": true,
"label": "DNP",
"name": "${DNP}",
"show": true
}
],
"filter_string": "",
"group_symbols": true,
"name": "Grouped By Value",
"sort_asc": true,
"sort_field": "Reference"
},
"connection_grid_size": 50.0,
"drawing": {
"dashed_lines_dash_length_ratio": 12.0,
"dashed_lines_gap_length_ratio": 3.0,
"default_line_thickness": 6.0,
"default_text_size": 50.0,
"field_names": [],
"intersheets_ref_own_page": false,
"intersheets_ref_prefix": "",
"intersheets_ref_short": false,
"intersheets_ref_show": false,
"intersheets_ref_suffix": "",
"junction_size_choice": 3,
"label_size_ratio": 0.375,
"operating_point_overlay_i_precision": 3,
"operating_point_overlay_i_range": "~A",
"operating_point_overlay_v_precision": 3,
"operating_point_overlay_v_range": "~V",
"overbar_offset_ratio": 1.23,
"pin_symbol_size": 25.0,
"text_offset_ratio": 0.15
},
"legacy_lib_dir": "",
"legacy_lib_list": [],
"meta": {
"version": 1
},
"net_format_name": "",
"page_layout_descr_file": "",
"plot_directory": "",
"spice_current_sheet_as_root": false,
"spice_external_command": "spice \"%I\"",
"spice_model_current_sheet_as_root": true,
"spice_save_all_currents": false,
"spice_save_all_dissipations": false,
"spice_save_all_voltages": false,
"subpart_first_id": 65,
"subpart_id_separator": 0
},
"sheets": [
[
"cd369e69-d5f6-4093-9f57-c9ccd4282edf",
"Root"
]
],
"text_variables": {}
}

File diff suppressed because it is too large Load diff

View file

@ -0,0 +1,5 @@
(sym_lib_table
(version 7)
(lib (name "OPL")(type "KiCad")(uri "${KIPRJMOD}/OPL_Kicad_Library-master/Seeed Studio XIAO Series Library/Seeed_Studio_XIAO_Series.kicad_sym")(options "")(descr ""))
(lib (name "1N4148")(type "KiCad")(uri "C:/Users/kalew/Downloads/1N4148/1N4148.kicad_sym")(options "")(descr ""))
)

File diff suppressed because it is too large Load diff

File diff suppressed because it is too large Load diff

Binary file not shown.

View file

@ -0,0 +1,103 @@
'''
KW-01 RGBoard V1
Untested code for a 2x4 macropad using the XIAO RP2040.
Currently supports simple numpad function. Blocked on hardware assembly.
'''
import board
import neopixel
from screen_brightness_control import set_brightness, get_brightness
from kmk.kmk_keyboard import KMKKeyboard
from kmk.scanners.matrix import MatrixScanner, DiodeOrientation
from kmk.keys import KC
from kmk.modules.macros import Press, Release, Tap, Macros
from kmk.modules.encoder import EncoderHandler
# Initialize the NeoPixel chain
NUM_PIXELS = 8
pixels = neopixel.NeoPixel(board.D6, NUM_PIXELS, auto_write=False)
keys_pressed = []
# Define colors for each key
colors = [
(255, 0, 0), # Red
(0, 255, 0), # Green
(0, 0, 255), # Blue
(255, 255, 0), # Yellow
(0, 255, 255), # Cyan
(255, 0, 255), # Magenta
(255, 255, 255),# White
(128, 0, 128) # Purple
]
# Encoder rotation
def encoder_handler(direction):
SCREEN_BRIGHTNESS = get_brightness()
if direction == 1:
# Increase brightness
print("Increase brightness")
SCREEN_BRIGHTNESS += 1
set_brightness(SCREEN_BRIGHTNESS)
elif direction == -1:
# Decrease brightness
print("Decrease brightness")
SCREEN_BRIGHTNESS -= 1
set_brightness(SCREEN_BRIGHTNESS)
# Neopixel lighting
def update_keys():
for i in range(NUM_PIXELS):
if i in keys_pressed:
pixels[i] = colors[i]
else:
pixels[i] = (0, 0, 0)
pixels.show()
def press(key):
keys_pressed.append(key.index)
update_keys()
return Press(key)
def release(key):
keys_pressed.remove(key.index)
update_keys()
return Release(key)
keyboard = KMKKeyboard()
macros = Macros()
keyboard.modules.append(macros)
# Matrix definitions
ROW_PINS = [board.D1, board.D7]
COL_PINS = [board.D2, board.D3, board.D4, board.D5]
# Matrix scanner
keyboard.matrix = MatrixScanner(
cols=COL_PINS,
rows=ROW_PINS,
diode_orientation=DiodeOrientation.ROW2COL
)
# Encoder definition
ENCODER_PINS = (board.D9, board.D10)
# Encoder handler
encoder = EncoderHandler(ENCODER_PINS, encoder_handler)
keyboard.modules.append(encoder)
# Here you define the buttons corresponding to the matrix
# Look here for keycodes: https://github.com/KMKfw/kmk_firmware/blob/main/docs/en/keycodes.md
# And here for macros: https://github.com/KMKfw/kmk_firmware/blob/main/docs/en/macros.md
keyboard.keymap = [
[KC.N1, KC.N2, KC.N3, KC.N4],
[KC.N5, KC.N6, KC.N7, KC.N8]
]
macros.press = press
macros.release = release
# Start kmk!
if __name__ == '__main__':
keyboard.go()

52
hackpads/RGBar/README.md Normal file
View file

@ -0,0 +1,52 @@
# RGBar
RGBoard is an 8 key macropad with a rotary encoder. Each key is backlit with a SK6812 reverse mounted neopixel.
![KW-01 Assembled](https://github.com/user-attachments/assets/8986adfd-3117-437b-9bf0-5ade84aad97a)
### Inspiration
I wanted to make something sleek and minimalist - kinda like a streamdeck, but with keys. I couldn't resist the RGB temptation though... oh well. More is better than less, right?
### Challenges
Since this was my first ever PCB, routing and learning the process took a looong time... Also, writing firmware without testing was a bit unorthodox, it it's *probably* fine...
## Features
- 3D printed case
- EC11 rotary encoder
- 8 keys w/ rgb backlighting
## CAD
The top and bottom are assembled using 4 M3 bolts and heated inserts.
![KW-01 Deconstructed](https://github.com/user-attachments/assets/96ae4558-9c86-4993-9616-8be3fa3641ab)
Here's a top view:
![image](https://github.com/user-attachments/assets/d3515b09-fb1e-4789-a6e7-f877bb367d06)
## PCB
The PCB was made in KiCad - the board is powered by a Seeed Studio XIAO RP2040.
Here's the schematic:
![image](https://github.com/user-attachments/assets/5e89411a-cf8a-455e-a475-4935679ddaf7)
...and the PCB:
![image](https://github.com/user-attachments/assets/af50de53-bd76-4e84-acf5-79fd17acc93d)
## Firmware
This hackpad uses KMK firmware. Currently, RGBar just acts like a numpad (with backlighting on press) and the rotary encoder adjusts screen brightness, but it can be reprogrammed to do much more...
## BOM
### Custom Components
- 1x Custom PCB
- 1x 3D printed case (top, bottom, and knob)
- 8x 3D printed keycaps (...or any other keycap for Cherry MX switches)
### COTS Components
- 8x Cherry MX switches (4 clicky and 4 linear as a personal preference~)
- 8x 1N4148 Diodes (through hole)
- 8x SK6812 MINI-E LEDs
- 1x EC11 Rotary encoder
- 1x Seeed XIAO RP2040 (through hole)
- 14x Male headers
- 4x M3 x 6mm Screws
- 4x M3x5mx4mm heatset inserts
## Extra stuff
I built this as a part of Hack Club's Hackpad program. I haven't tested any of it yet, since I don't currently have the parts~