mirror of
https://github.com/System-End/hackpad.git
synced 2026-04-20 00:35:24 +00:00
Fix grammar issues
This commit is contained in:
cheyao
parent
deb5cd0f3c
commit
c048c3a370
2 changed files with 41 additions and 32 deletions
|
|
@ -6,7 +6,6 @@ Finally finished your hackpad? Nice job! Follow along and we're going to make su
|
|||
- Exporting the production files
|
||||
- Publishing the design
|
||||
|
||||
|
||||
## Structuring your project
|
||||
To make reviewing easier, we need to make sure that the source files of our project are formatted in a way that's complete & easy to navigate.
|
||||
|
||||
|
|
|
|||
|
|
@ -23,9 +23,7 @@ There's also [this](/resources) giant wall of resources to reference!
|
|||
|
||||
Here is also a guide on [advanced PCB components](/advancedPCB).
|
||||
|
||||
Don't forget to find out some [Tips'n Tricks here!](/tipsntricks)
|
||||
|
||||
[Look up DRC errors here :D](/tipsntricks)
|
||||
[Look up DRC errors here :D](/errors)
|
||||
|
||||
Lets start with:
|
||||
|
||||
|
|
@ -34,7 +32,8 @@ Lets start with:
|
|||
|
||||
For this guide we're going to be using [KiCad](https://www.kicad.org/), which is an open source PCB designer tool.
|
||||
|
||||
To start, we're going to have to install the kicad library! We are going to use the following respository
|
||||
To start, we're going to have to install the kicad library! We are going to use the following respository:
|
||||
|
||||
- [OPL Kicad Library](https://github.com/Seeed-Studio/OPL_Kicad_Library/)
|
||||
|
||||
There are many tutorials on how to install libraries! Google is your best friend here :)
|
||||
|
|
@ -55,9 +54,9 @@ Start by opening up KiCad, a window will pop up, create a new project then click
|
|||
This should open up a new window with your schematic editor! Once you're in, press the A key on your keyboard. This should open up a menu where you can add **symbols** for your different components! Search for the following to add them:
|
||||
- XIAO-RP2040-DIP (your microcontroller)
|
||||
- SW_Push (This will be our keyboard switch! Copy and paste this 4 times)
|
||||
- SK6812 MINI LED (its an RGB LED - I will be using 2 of these!)
|
||||
- SK6812 MINI LED (it's an RGB LED, also known as neopixels - I will be using 2 of these!)
|
||||
|
||||
Start by placing these symbols down. They don't have to be in any particular order, but place them somewhat close together
|
||||
Start by placing these symbols down. They don't have to be in any particular order, but place them somewhat close together.
|
||||
|
||||
To rotate the symbols, click R. And to mirror them, click X.
|
||||
|
||||
|
|
@ -65,7 +64,7 @@ To rotate the symbols, click R. And to mirror them, click X.
|
|||
|
||||
Afterwards, it should look something like this ^^
|
||||
|
||||
Now it's time to start wiring. Hit the W key on your keyboard to start wiring! This should make a green wire start to appear. Connect your components like so:
|
||||
Now it's time to start wiring. Hit the W key on your keyboard to start wiring! This should make a green wire appear. Connect your components like so:
|
||||
|
||||
<img src="/docs/v2/wiredcomponents.png" className="max-w-96" />
|
||||
|
||||
|
|
@ -100,7 +99,7 @@ First, to be able to better place the components, we would need to change the gr
|
|||
|
||||
Grids are used to allow efficient placement, movement and connection between symbols and wires. It defines what is the spacing of the grid, which components will snap to.
|
||||
|
||||
Select the button at the top that says "1.2700 mm (50 mils)" (Replace xx by a arbitrary number). You can use this menu to change what grid you are on. hen click on Edit Grids...
|
||||
Select the button at the top that says "1.2700 mm (50 mils)". You can use this menu to change what grid you are on. Then click on Edit Grids...
|
||||
|
||||
<img src="/docs/v2/grid.png" className="max-w-96" />
|
||||
|
||||
|
|
@ -108,14 +107,14 @@ You should have the following menu open:
|
|||
|
||||
<img src="/docs/v2/editgrid.png" className="max-w-96" />
|
||||
|
||||
Now click on the + button at the bottom left, and enter "2.38125" in the field named "X". Press Ok then Ok again. Now you have defined a custom grid!
|
||||
Now click on the + button at the bottom left, and enter "2.38125" in the field named "X". Press Ok, then click on Ok again. Now you have defined a custom grid!
|
||||
(this is the distance between the switches divided by 8. 19.05mm / 8 = 2.38125mm)
|
||||
|
||||
We now need to place the components!
|
||||
We now need to place the components:
|
||||
|
||||
Select a footprint, drag it around to move it (Or if you prefer, click a component to select it, press M to move it and click again to put it down). To rotate the footprint, press R when selecting it.
|
||||
|
||||
When placing the switches, I recommend you to use the newly defined grid of 2.38125 mm (Select it in the menu). **Important**: While moving the switches, select the blue circle at the center. This will make sure all the switches are alighed properly. You should align the outer while lines of the switches as so:
|
||||
When placing the switches, I recommend you to use the newly defined grid of 2.38125 mm (Select it in the menu), and for placing other components, I recommend a grid of 0.10000 mm. **Important**: While moving the switches, select the blue circle at the center, this will make sure all the switches are alighed properly. You should align the outer while lines of the switches as so:
|
||||
|
||||
<img src="/docs/v2/align.png" className="max-w-96" />
|
||||
|
||||
|
|
@ -127,7 +126,7 @@ If you want to put the footprint on the back side, press F. Here is what the foo
|
|||
|
||||
<img src="/docs/v2/compfrontback.png" className="max-w-96" />
|
||||
|
||||
Move, rotate and flip your footprints into a design that you like! It should looks like this:
|
||||
Move, rotate and flip your footprints into a design that you like! It should look something like this:
|
||||
|
||||
<img src="/docs/v2/placedfootprints.png" className="max-w-96" />
|
||||
|
||||
|
|
@ -145,11 +144,11 @@ This shall be the size of your physical board.
|
|||
|
||||
<img src="/docs/v2/xiaohead.png" className="max-w-96" />
|
||||
|
||||
Now it's time to route the PCB! Hit X on your keyboard and hit any golden pad with a thin blue line poking out. It should dim the entire screen and show you where to go:
|
||||
Now it's time to route the PCB! Hit X on your keyboard and hit any golden pad with a thin blue line poking out of it. It should dim the entire screen, show you which direction you need to go with a thin blue line and highlight the destination:
|
||||
|
||||
<img src="/docs/v2/routing.png" className="max-w-96" />
|
||||
|
||||
Join the highlighted pads together. If there isn't enough space on the front side, or there is a trace already present that is blocking you, you can route on the back side by clicking B.Cu on the right toolbar. At the same time, if you want to change sides during routing, you can press V, and a via shall be added, and you will be on the other side of the board:
|
||||
Join the highlighted pads together. If there isn't enough space on the front side, or there is a trace already present that is blocking you, you can route on the back side by clicking B.Cu on the right toolbar. At the same time, if you want to change sides during routing, press V and a via shall be added, which will transfer your trace to the other side of the board:
|
||||
|
||||
<img src="/docs/v2/via.png" className="max-w-96" />
|
||||
|
||||
|
|
@ -169,11 +168,13 @@ Enter your text and place it down!
|
|||
|
||||
<img src="/docs/v2/realfinalpcb.png" className="max-w-96" />
|
||||
|
||||
Good stuff! You're almost done the PCB. Let's run the DRC to make sure the PCB works. The silkscreen warnings you see are okay, make sure there are no more errors! Here is a [list of all DRC errors you might encounter](/errors)
|
||||
If you want to add some pictures to your PCB to make it even more personal, [check this out!](/advancedguide#silkscreen)
|
||||
|
||||
Good work! You're almost done with the PCB. Let's run the DRC to make sure the PCB works. The silkscreen warnings you see are okay, make sure there are no more errors! Here is a [list of all DRC errors you might encounter](/errors)
|
||||
|
||||
<img src="/docs/v2/drcbutton.png" className="max-w-96" />
|
||||
|
||||
PS. You might need to cheange tabs to see all errors. (Click on "Unconnected Items")
|
||||
PS. You might need to change tabs to see all errors. (Click on "Unconnected Items")
|
||||
|
||||
Thats all for your PCB! Great job.
|
||||
|
||||
|
|
@ -186,20 +187,20 @@ You currently can view the 3D version of your PCB by pressing Alt+3 (Option+3 on
|
|||
|
||||
<img src="/docs/v2/3d-view.png" className="max-w-96" />
|
||||
|
||||
Oh no! We are missing some 3D Models. Here we will learn how you add them.
|
||||
Oh no! We are missing some 3D models. Here we will learn how you add them.
|
||||
|
||||
First, you must find 3D Models for your components on the internet, but here is @Cyao's trusty list of common models. (If this opens a new tab and doesn't automatically download, press Control+S)
|
||||
First, you must find 3D models for your components on the internet, but here is @Cyao's trusty list of common models. (If this opens a new tab and doesn't automatically download, press Control+S)
|
||||
|
||||
- [Seeed-Studio Xiao](https://rawcdn.githack.com/cheyao/macropad/642f4e5dbdabb88147ccd878850d199042967667/PCB/third_party/xiao.step)
|
||||
- [Cherry MX v2 (Models for the switches)](https://rawcdn.githack.com/cheyao/macropad/3adb7e07d888458e6d1985f4e6be17601a1c2350/PCB/third_party/SW_Cherry_MX_PCB.stp)
|
||||
- [Neopixel SK6812_Mini](https://rawcdn.githack.com/StefanHamminga/kicad-packages3D/395108dcab363619c3c82ad00e060acd423aeeb7/LED_SMD.3dshapes/SK6812_Mini.step)
|
||||
- [Neopixel SK6812_Mini (This is the one used in the beginner guide)](https://rawcdn.githack.com/StefanHamminga/kicad-packages3D/395108dcab363619c3c82ad00e060acd423aeeb7/LED_SMD.3dshapes/SK6812_Mini.step)
|
||||
- [Reverse Mount Neopixel](https://rawcdn.githack.com/cheyao/macropad/642f4e5dbdabb88147ccd878850d199042967667/PCB/third_party/neopixel.petty/SK6812MINI-E.step)
|
||||
- [128x64 0.96" SSD1306 OLED Display](https://rawcdn.githack.com/cheyao/macropad/642f4e5dbdabb88147ccd878850d199042967667/PCB/third_party/KiCad-SSD1306-128x64-master/SSD1306_OLED_Display(128x64).step)
|
||||
- [128x64 0.91" SSD1306 OLED Display](https://rawcdn.githack.com/cheyao/macropad/3adb7e07d888458e6d1985f4e6be17601a1c2350/PCB/third_party/oled_0.91_128x32.step)
|
||||
- [Rotatory encoder Alps EC11E](https://rawcdn.githack.com/horfee/kicad-packages3D/7a1d016fbda6eb6f7ae842b31ead5cd162b98a05/Rotary_Encoder.3dshapes/RotaryEncoder_Alps_EC11E-Switch_Vertical_H20mm.step)
|
||||
- [Kailh Choc v2 switched (You probably don't need this one)](https://rawcdn.githack.com/cheyao/macropad/642f4e5dbdabb88147ccd878850d199042967667/PCB/third_party/Kailh-Choc-V2.step)
|
||||
|
||||
Note: On some Linux distributions, you need to download the built-in kicad 3d models seperatly, most likely called "kicad-library-3d"
|
||||
Note: On some Linux distributions, you need to download the built-in kicad 3d models seperatly, most likely in the form of a package called "kicad-library-3d"
|
||||
|
||||
Now open the footprint editor:
|
||||
|
||||
|
|
@ -267,7 +268,12 @@ In the KLE Data fiels, you need to enter some custom json data. For example
|
|||
["", "", ""],
|
||||
["", "", ""],
|
||||
|
||||
Is for a macropad that has 3 keys in each column and 2 rows
|
||||
Is for a macropad that has 3 columns and 2 rows. For me, it will be
|
||||
|
||||
["", ""],
|
||||
["", ""],
|
||||
|
||||
Since my macropad has 2 rows and 2 columns.
|
||||
|
||||
If your keyboard is more complex, you can use [keyboard-layout-editor.com](https://www.keyboard-layout-editor.com/) to generate the json data. (Modify the layout, open the "Raw data" tab at the middle of the page, then copy & paste)
|
||||
|
||||
|
|
@ -331,16 +337,16 @@ Press "Finish sketch" (green checkmark at top right of screen), then select all
|
|||
<img src="/docs/v2/fusionselect.png" className="max-w-96" />
|
||||
<img src="/docs/v2/fusionextrudemenu.png" className="max-w-96" />
|
||||
|
||||
Now, you must re-show the object be opening the Sketches folder on the left, and cliking the eye icon on Sketch1. Then select the outer rectangle and press extrude. This time the Start shall be "Profile Plane" (and will be for all future extrudes), and set the distance to 13mm:
|
||||
Now, you must re-show the object be opening the Sketches folder on the left, and clicking the eye icon to the left of Sketch1. Then select the outer rectangle and press extrude. This time the Start shall be "Profile Plane" (and will be this for all future extrudes), and set the distance to 13mm:
|
||||
|
||||
<img src="/docs/v2/fusionshow.png" className="max-w-96" />
|
||||
<img src="/docs/v2/fusionextrude2.png" className="max-w-96" />
|
||||
|
||||
Now, click the center square, and extrude it by 3mm. Now you can move arround and your will see something like this:
|
||||
Now, click the center square, and extrude it by 3mm. You can move arround and you will see something like this:
|
||||
|
||||
<img src="/docs/v2/fusioncasehalf.png" className="max-w-96" />
|
||||
|
||||
Thats the base of your case done!
|
||||
That's the base of your case done!
|
||||
|
||||
Now go to kicad and measure the distance from the edge of the PCB to the USB port.
|
||||
|
||||
|
|
@ -354,7 +360,7 @@ And create a new sketch (Create Sketch button). Draw a rectangle at the top, and
|
|||
|
||||
<img src="/docs/v2/fusionhole.png" className="max-w-96" />
|
||||
|
||||
Click finish sketch, select the rectangle we just draw and press extrude. This time set the distance to -7.5mm
|
||||
Click finish sketch, select the rectangle we just drew and press extrude. This time set the distance to -7.5mm
|
||||
|
||||
<img src="/docs/v2/fusioncase.png" className="max-w-96" />
|
||||
|
||||
|
|
@ -373,11 +379,11 @@ Right now our case looks a little ugly, its so blocky! Lets round the corners, p
|
|||
<a name="top"/>
|
||||
### Creating the top
|
||||
|
||||
Next, we will make the other half to our case. Start by clicking new design.
|
||||
Next, we will make the other half of our case. Start by clicking new design.
|
||||
|
||||
<img src="/docs/v2/fusionnewdesign.png" className="max-w-96" />
|
||||
|
||||
Now go to the INSERT menu, expand it and click "Insert DXF". Select a dxf file (in the web you need to first click Upload from Fusion Team..., upload it from there, click refresh then select the file), and click ok. Now delete the outer lines surrounding the keyholes. You should have something like this:
|
||||
Now go to the INSERT menu, expand it and click "Insert DXF". Select the dxf file we generated at the start (in the web you need to first click Upload from Fusion Team..., upload it from there, click refresh then select the file), and click ok. Now delete the outer lines surrounding the keyholes. You should have something like this:
|
||||
|
||||
<img src="/docs/v2/fusionholes.png" className="max-w-96" />
|
||||
|
||||
|
|
@ -390,17 +396,17 @@ Go back to KiCAD PCB editor and measure the dimensions of your board with the ru
|
|||
<img src="/docs/v2/ruler.png" className="max-w-96" />
|
||||
<img src="/docs/v2/pcbsize.png" className="max-w-96" />
|
||||
|
||||
Now lets create a new rectangle, define it's width and height the same as the size of the top plate. Set the distance between the left end of your keyholes and the left edge of the rectangle the x distance you just measured + 10.5 (for me it's 3.99+10.5). Same for the bottom edge of the keyhole and bottom edge of the rectangle, y distance + 10.5.
|
||||
Now lets create a new rectangle, define it's width and height be the same as the size of the top plate. Set the distance between the left keyhole end and the left rectangle edge the x distance you just measured + 10.5 (for me it's 3.99+10.5). Same for the bottom edge of the keyhole and bottom edge of the rectangle, y distance + 10.5.
|
||||
|
||||
<img src="/docs/v2/fusionalmost.png" className="max-w-96" />
|
||||
|
||||
Add another rectangle, this time with it's start starting on the top line of our rectangle. Set it's width to 18.5mm and height to 31mm. After that use the distance tool to set the distance from the left of the rectangle to the left edge of the rounded rectangle to x_distance_in_kicad+5.75mm
|
||||
|
||||
Add 4 more circles of 3.4mm and 5mm from the edges:
|
||||
Add 4 more circles of 3.4mm and set their position to 5mm from the edges with the distance tool:
|
||||
|
||||
<img src="/docs/v2/fusionfinalsketch.png" className="max-w-96" />
|
||||
|
||||
Click finish sketch, and pad the main part 3mm.
|
||||
Click finish sketch, and pad out the main part by 3mm.
|
||||
|
||||
<img src="/docs/v2/fusionplate.png" className="max-w-96" />
|
||||
|
||||
|
|
@ -408,7 +414,7 @@ But currently the plate is kinda ugly. Do the same things with the fillet as the
|
|||
|
||||
<img src="/docs/v2/fusionplatefinal.png" className="max-w-96" />
|
||||
|
||||
You finished your plate!! Congrats
|
||||
You finished your plate!! Congrats 🎉
|
||||
|
||||
<a name="finishing"/>
|
||||
### Finishing Touches
|
||||
|
|
@ -487,3 +493,7 @@ The board should automatically restart and be recognised as a new external drive
|
|||
# Next steps
|
||||
We just made a pretty cool macropad, but obviously there's a lot of cooler stuff out there - that's up to you to figure out! Again, don't copy this guide 1:1, add your own design into it.
|
||||
|
||||
You might want to check out the [advanced guide](/advancedguide).
|
||||
|
||||
Or maybe do you think you are done? Check out how to submit [here](/submitting)
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Reference in a new issue