Merge remote-tracking branch 'refs/remotes/origin/main'

Author: qcoral

bin/prod_console

@@ -31,7 +31,7 @@ irbrc_content = <<~RUBY
     PROMPT_I: "blueprint(\\e[33mdev→prod\\e[0m)> ",
     PROMPT_S: "blueprint(\\e[33mdev→prod\\e[0m)* ",
     PROMPT_C: "blueprint(\\e[33mdev→prod\\e[0m)* ",
-    RETURN: "=> %s\\n\\n\\e[31m⚠️  YOU ARE CONNECTED TO PRODUCTION ⚠️\\e[0m\\n"
+    RETURN: "=> %s\\n\\n\\e[31m⚠️  YOU ARE CONNECTED TO PRODUCTION DATABASE ⚠️\\e[0m\\n"
   }
   IRB.conf[:PROMPT_MODE] = :PROD
 RUBY

docs/hackpad/add-components.md

@@ -0,0 +1,75 @@
+| title       | Adding more parts! |
+| ----------- | ------------------ |
+| description | Learn how to add RGB LEDs, rotary encoders, OLED screens, and more to your hackpad. |
+| priority    | 2                  |
+
+# Adding in other components!
+
+The hackpad kit comes with more than just a few keyswitches! It comes with RGB LEDs, Rotary encoders, and a fancy 128x32 OLED screen!
+
+The Orpheuspad example I designed has examples of every single one - I would also recommend looking at other repositories for inspo!
+
+As with anything, make sure to ask in #hackpad if you ever have any questions!
+
+## 4+ keys / Matrix wiring
+
+If you're using 4+ keys, you should use [matrix wiring!](https://docs.qmk.fm/how_a_matrix_works). Check out the tutorials in the [resources](/hackpad/resources) section to get an idea of what that might look like
+
+The tl;dr is that instead of wiring each switch to a unique pin, you can set them up in a 2D grid and pinpoint the specific switch being pressed based on which 2 pins activated!
+
+For example, if you wanted to wire 16 switches, you can wire them as a 4x4 matrix and only use 8 pins instead of having 1 pin for every single switch.
+
+You'll need diodes to do this. The specific diode that comes with the kit is a 1N4148 diode from onsemi. Datasheet [here](https://www.onsemi.com/download/data-sheet/pdf/1n914-d.pdf)
+
+For the footprint, I would recommend using `Diode_THT:D_DO-35_SOD27_P7.62mm_Horizontal`. You can use longer ones if you'd like for the aesthetic, but I find this one tends to work the best when assembling - do not use anything shorter, you'll have a pretty hard time if you do.
+
+## Rotary encoders
+
+Rotary encoders are knobs like [these](https://www.adafruit.com/product/377) - they turn both ways, and have a button you can press!
+
+The specific one we're using is the EC11E with a D-shaft that's 20mm long. You can find an exact CAD model in the [GitHub repository!](https://github.com/hackclub/hackpad/tree/clean/extras)
+
+I would recommend using the symbol `RotaryEncoder_Switch` and the footprint `RotaryEncoder_Alps_EC11E-Switch_Vertical_H20mm` - you'll have to install this as a separate library, check out the [resources](/hackpad/resources) section!
+
+You _may_ see some implementations include pull-up resistors. This is not necessary for us since our microcontroller (the rp2040) has built-in pull up resistors.
+
+Firmware implementation info can be found here:
+
+- [QMK](https://docs.qmk.fm/features/encoders)
+- [KMK](https://github.com/KMKfw/kmk_firmware/blob/main/docs/en/encoder.md)
+- [ZMK](https://zmk.dev/docs/development/hardware-integration/encoders)
+
+## SK6812MINI-E RGB LEDs
+
+These are the RGB LEDs that come with the hackpad kit! Each one has a super tiny microcontroller inside, so you can chain them together control all of them with only 1 pin of your micrcontroller!
+
+They have 4 pins - 1 5v power (VCC), 1 ground (GND), 1 for data coming in (DIN), and 1 for data going out of the LED (DOUT).
+
+KiCAD doesn't have the library for the footprint of these by default, but it comes with the KiCAD care package you can find in the "resources" section! It's called SK6812MINI-**E**, _NOT_ SK6812MINI (make sure your symbol and both footprint both say SK6812MINI-E)
+
+**IMPORTANT**: Make sure your pinout matches the following screenshot _exactly:_
+
+![screenshot of SK6812MINI E](/docs-assets/hackpad/v3/sk6812minie.webp)
+
+Notice the small notch/cut on the bottom right corner - your LEDs _will_ not work if it's in a different orientation!
+
+## OLED Display
+
+OLED Displays are small screens that can display various pieces of info! Here's a cat animation I had earlier
+
+<video controls class="w-full max-w-full h-auto rounded">
+  <source src="https://cdn.hackclub.com/019c1b00-538c-7a58-a621-12ec0ac71655/pxl_20241115_191000789.mp4" type="video/mp4" />
+  Your browser does not support the video element.
+</video>
+
+For footprint, you can actually just use a 4 pin header! This is because the module uses a standard 2.54mm 4 pin header, there's no fancy external footprint needed
+
+The most important thing to note is to make sure that you make sure the pin order is correct. Some pictures you'll see online will feature the 4 pins in different orientations, make sure it is GND-VCC-SCL-SDA.
+
+![picture of oled](/docs-assets/hackpad/v3/oled.webp)
+
+*the actual OLED you'll get will have a blue PCB - this picture is just to illustrate the pinout*
+
+Additionally, pull-up resistors are _not_ necessary! The microcontroller we're using is based on the [Raspberry Pi RP2040](https://www.raspberrypi.com/products/rp2040/), which has built-in pullup resistors on every pin - this means you don't need to manually add resistors.
+
+As always, make sure to ask in #hackpad if you need any help!

docs/hackpad/cardgrant.md

@@ -0,0 +1,50 @@
+| title       | About the Card Grant |
+| ----------- | -------------------- |
+| description | Information about the HCB card grant for hackpad projects. |
+| unlisted    | true                 |
+
+# About the card grant
+
+The card grant is a $18 VISA credit card from stripe that will be issued to you when your hackpad gets shipped.
+
+When spending in mind that Hack Club is still a financially limited org; every bit of money we save on Hackpad goes to the next program!
+
+Abuse, fraud, and general misuse will mean that I (dari) am able to do this less often in the future and your projects won't be as fun
+
+**What can I do with it?**
+
+First and foremost, to get your PCB from JLCPCB (or SEEED studio if you're in india). Do not use PCBWAY unless it's cheaper.
+
+You also can get any custom parts you may need for your hackpad. The only requirement is that anying you buy MUST be something needed specifically for your design to function. I/O expanders, distance sensors, etc. are great!
+
+What's not great is trying to purchase the following:
+
+- ENIG finishes
+- USB cables / hubs
+- Switch testers
+- Extra rp2040s/switches/etc (either for another hackpad or project)
+- Anything that won't be directly used for your *one* hackpad.
+
+**What vendors are allowed?**
+
+No limit, but please link it to me in #hackpad *before* you make the purchase if it's not any of the following:
+- AliExpress
+- DigiKey
+- LCSC
+- JLCPCB
+- Seeed (PCB ONLY)
+
+**Does I need to include shipping/taxes/etc?**
+
+Yup! Everything must fit within your $20 grant.
+
+**What billing address do I use?**
+
+Use the one on the card, not your personal address
+
+**Tips for different merchants:**
+- JLCPCB: The default shipping is super expensive, switching to global direct line should be roughly $1.5 for shipping.
+    - If you're anywhere within the US or Canada I can guarantee this is an option. Most places in the EU + UK have similar option
+- DigiKey/LCSC: Combine orders with a friend! Makes stuff cheaper
+- AliExpress: do some digging, there's usually way cheaper options
+- Amazon: Don't. It is almost always far cheaper to go with aliexpress.

docs/hackpad/faq.md

@@ -1,42 +1,47 @@
+| title       | FAQ |
+| ----------- | --- |
+| description | Frequently asked questions about the hackpad program. |
+| priority    | 6   |
+
 # Frequently Asked Questions
 
-Welcome to the FAQ section! If you have something you think should be added here please ping @alexren in the #blueprint channel!
+Welcome to the FAQ section! If you have something you think should be added here please ping @alexren in the #hackpad channel
 
 **What gets shipped to me?**
-- A kit of all the electronic components for your macropad!
-- a $15 HCB Card grant to get your **PCB** made from JLCPCB, and to get a case 3D printed from #printing-legion if needed
+- A kit of all the parts in the [Kit Contents page](/hackpad/parts)!
+- a $15 HCB Card grant to get your **PCB** made, and a case 3D printed from [printing legion](https://www.printlegion.hackclu.com/) if needed!
+- a $18 HCB Card grant to get your soldering iron, if you need one. This is non-transferrable.
+
+**What is an HCB Card grant??**
+
+[READ ME](/hackpad/cardgrant) FOR INFO
 
-**When is the deadline?** \
-Same deadline as Blueprint! March 31st, 2026
+**Where can I find KiCAD footprints / what's the measurement for this thing / etc**
 
-**Where can I find KiCAD footprints / what's the measurement for this thing / etc** \
 A lot of these questions can be answered by checking out the [resources and tips section](/hackpad/resources)! You can find **KiCAD footprints**, 3D models, etc
 
-**Can I use a microcontroller other than the XIAO RP2040?** \
-Sorry, no! If you want to use something else, you can enable "expert mode" in Blueprint and build a custom project instead!
+**Can I use a microcontroller other than the XIAO RP2040?**
+
+Unfortunately not for hackpad! If you want to use a custom microcontroller, you'll have to submit it as a custom project to Blueprint.
 
 The XIAO is a great primer and I recommend using it, but it's totally understandable if you want to do something more advanced! We won't stop you :)
 
-**Will my hackpad come assembled?** \
-Unfortunately not! Not to fear though - assembling a macropad isn't that hard!
+**Will my hackpad come assembled?**
+
+Unfortunately not! Not to fear though - assembling a macropad is a great learning experience!
+
+**Can I use acrylic/cnc metal/etc for the case/plate?**
 
-**Can I use acrylic/cnc metal/etc for the case/plate?** \
-NO!!! Only 3D prints are supported.
+NO! Only 3D prints are supported.
 
-**Can I use parts outside of the approved list?** \
-Yes! You are responsible for sourcing it on your own money though
+**Can I use parts outside of the approved list?**
 
-**What colours are the keycaps?** \
-White!
+Yes! You are responsible for sourcing it on your own money though.
 
-**Can I use Choc switches?** \
-No!
+**Where will everything be shipped from?**
 
-**What are the footprint name for through hole diodes?** \
-The footprint for 1N4148 Diodes are D_DO-35_SOD27_P7.62mm_Horizontal.
+It'll be shipped from [Hack Club HQ](https://maps.app.goo.gl/EPwC2izABPnbVgjq9), which is located in Shelburne, Vermont USA.
 
-**Where will everything be shipped from?** \
-It'll be shipped from HQ, which is located in Shelburne VT.
+**I have more questions!!!**
 
-**I have more questions!!!**  \
-Join the #blueprint channel in the Hack Club slack!
+Join the #hackpad channel in the Hack Club slack!