-
Notifications
You must be signed in to change notification settings - Fork 883
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1,549 changed files
with
4,202,249 additions
and
61 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,24 @@ | ||
| # Invalid label: If there are changes in /projects AND other top-level directories. | ||
| Invalid: | ||
| - all: | ||
| - changed-files: | ||
| - 'projects/**' | ||
| - '!projects/**' | ||
|
|
||
| # Submission label: Apply when there are changes ONLY within /projects. | ||
| Submission: | ||
| - all: | ||
| - changed-files: | ||
| - 'projects/**' | ||
| - any: | ||
| - changed-files: | ||
| - '!*/**' | ||
|
|
||
| # Dev label: Apply when there are changes ONLY outside /projects. | ||
| Dev: | ||
| - all: | ||
| - changed-files: | ||
| - '*' | ||
| - any: | ||
| - changed-files: | ||
| - '!projects/**' |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,45 @@ | ||
| name: Cleanup Pull Requests | ||
| on: pull_request_target | ||
|
|
||
| jobs: | ||
| stalled-tickets: | ||
| runs-on: ubuntu-latest | ||
| permissions: | ||
| pull-requests: write | ||
| issues: write | ||
| actions: write | ||
| steps: | ||
| - name: Close Stale Issues | ||
| uses: actions/[email protected] | ||
| with: | ||
| stale-pr-message: > | ||
| Hi, if you need any assistance, please don't hesitate to ask here or in #electronics on Slack. This pull request is being marked as 'Stalled' for now and will be closed in 3 days if there is no activity. | ||
| close-pr-message: > | ||
| This pull request has been inactive for some time and has therefore been closed. Feel free to create a new one when you're ready. | ||
| # The number of days old an issue or a pull request can be before marking it stale. Set to -1 to never mark issues or pull requests as stale automatically. | ||
| days-before-issue-stale: 30 | ||
| days-before-pr-stale: 7 | ||
| # The number of days to wait to close an issue or a pull request after it being marked stale. Set to -1 to never close stale issues or pull requests. | ||
| days-before-close: 3 | ||
| # The number of days to wait to close an issue after it being marked stale. Set to -1 to never close stale issues. Override "days-before-close" option regarding only the issues. | ||
| days-before-issue-close: -1 | ||
| # The label to apply when an issue is stale. | ||
| stale-issue-label: "Stalled" | ||
| # The labels that mean an issue is exempt from being marked stale. Separate multiple labels with commas (eg. "label1,label2"). | ||
| exempt-issue-labels: "Dev" | ||
| exempt-pr-labels: "Dev" | ||
| # The label to apply when a pull request is stale. | ||
| stale-pr-label: "Stalled" | ||
| # Only pull requests with at least one of these labels are checked if stale. Defaults to `` (disabled) and can be a comma-separated list of labels. Override "any-of-labels" option regarding only the pull requests. | ||
| any-of-pr-labels: "Submission" | ||
| # include-only-assigned: true | ||
| labeler: | ||
| permissions: | ||
| contents: read | ||
| pull-requests: write | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - uses: actions/[email protected] | ||
| - uses: actions/labeler@v5 | ||
| with: | ||
| sync-labels: true |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,3 +1,4 @@ | ||
| .vscode | ||
| req_check.sh | ||
| .DS_Store | ||
| .DS_Store | ||
| .idea |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,14 +1,15 @@ | ||
| # OnBoard Tips | ||
| # OnBoard Tips - By The Students | ||
|
|
||
| Here are a few tips to make your OnBoard experience as smooth as possible! A collection of tips from OnBoard participants! | ||
|
|
||
| Here are a few tips to make your OnBoard experience as smooth as possible! | ||
|
|
||
| --- | ||
|
|
||
| 1. When HQ gives you your credit card and you pay for your PCB, make sure to select a coupon at checkout! This way you will have more money to build more PCBs in the future. | ||
| 1. When recieving your grant and you're ready to pay for your PCB, make sure to select a coupon at checkout! This way you will have more money to build more PCBs in the future. | ||
| 2. Try to buy multiple designs at the same time to save on shipping! | ||
| 3. Don't forget to submit your invoice/receipt to Hack Club bank after paying!!!! | ||
| 4. Select the "assemble" option when ordering! This way everything will come assembled. | ||
| 5. Use Lead-free HASL! | ||
| 6. When ordering, you may get an alert that some parts "unselected". This can be ignored. | ||
| 6. When ordering, you may get an alert that some parts "unselected". This usually can be ignored. | ||
| 7. You can design as many boards as you want, as long as the total cost doesn't go over $100. | ||
| 8. While generating your gerber files in EasyEDA, always chose the One-Click Order option to get a $8 discount. It's more efficient and hassle free, generating and submitting the BOM, Pick&Place, and Gerber files automatically. [More information ℹ️.](https://support.jlcpcb.com/article/217-special-offer-get-8-off-coupon-once-a-month-for-easyeda-project) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,81 @@ | ||
| ## Tagline | ||
| Have you already shipped a couple PCBs and want to challange yourself and use something a little more.. ***"pro"***; [KiCad](https://www.kicad.org/) is here for you! KiCad is another PCB CAD software like EasyEDA but with a ton more features and tools to perfect your craft. | ||
|
|
||
| ## KiCad Installation | ||
| KiCad is available on Windows, Linux and MacOS and is a downloadable software rather than something that runs in your browser like EasyEDA. Download it [here](https://www.kicad.org/download/), selecting your operating system and download location. | ||
|
|
||
| ## Prerequisites | ||
| ### Plugins (Optional) | ||
| You might also want to install these two plugins the plugin manager that I find really useful, | ||
|
|
||
| <p align="center"> | ||
| <img src="images/kicad/plugins.png" alt="Fabrication Toolkit & FreeRouting plugin"/> | ||
| </p> | ||
|
|
||
| #### EasyEDA2KiCad (Optional) | ||
| One small setback to using KiCad is you have to fetch all the symbols,footprints and models yourself rather than EasyEDA automatically finding and importing them for you to use. Not to worry though, some smart group (Wokwi) decided to make a script to port these files to KiCad; [EasyEDA2KiCad](https://github.com/uPesy/easyeda2kicad.py). | ||
|
|
||
| You'll need to have Python installed and functional, perferably the latest version, then you can install it with `pip install easyeda2kicad`. | ||
|
|
||
| To confirm it was install correct, simply type `easyeda2kicad` in your terminal. | ||
|
|
||
| #### Linking Paths | ||
| Ensure KICad knows where EasyEDA2KiCad is downloading the files to, follow this [guide](https://github.com/uPesy/easyeda2kicad.py?tab=readme-ov-file#-add-libraries-in-kicad) on how to set that up. | ||
|
|
||
| ***Windows Troubleshooting***<br> | ||
|
|
||
| --- | ||
| You might have to [tinker around](https://graycode.ie/blog/how-to-add-python-pip-to-path/) with system path variables if you're on Windows. Ask around on the Slack for assistance. | ||
|
|
||
| **Linux Troubleshooting**<br> | ||
|
|
||
| --- | ||
|
|
||
| If you're on Linux and getting a `Externally Managed Enviornment` error when using `pip install`, you might want to try out [PipX](https://github.com/pypa/pipx). | ||
|
|
||
| ### Introduction | ||
| After launching KiCad and launching it, you should be greeted by a menu similar to this, | ||
|  | ||
| You can start by creating a project by pressing File > New Project and giving it a name and save location. That'll create 3 files, the `.kicad_pro` project file, a `kicad.sch` which contains your electrical schematic and `.kicad.pcb` which is your PCB layout similar to EasyEDA's `pcb.json` file. | ||
|
|
||
| <br> | ||
|
|
||
| <p align="center"> | ||
| <img src="images/kicad/files.png" alt="KiCad Project Files"/> | ||
| </p> | ||
|
|
||
| You can open your `.kicad_sch` file, this will be the first file you'll be using. Looks a little scary eh? Don't be concerned, it just has a lot more features than EasyEDA but has all the simple tools that you're used to still there. | ||
|
|
||
| You can place basic components like resistors, capacitors and diodes using KiCad's built-in symbol library. This is good for when you're just starting you're project and you want to quickly iterate your design without fine-tuned values of components. Add a resistor, press `ESC` then double click on it and give it a `Value`, | ||
| <p align="center"> | ||
| <img src="images/kicad/resistor.png" alt="Resistor_Value" width=60%/> | ||
| </p> | ||
| Try this out with a few other symbols and then connect them together with the "Add Wire" tool on the right of the screen, | ||
| <p align="left" class="resistor"> | ||
| <img src="images/kicad/add_wire.png" alt="Adding a wire" width=20%/> | ||
| </p> | ||
| <style> | ||
| .resistor{ | ||
| padding-left: 80px | ||
| } | ||
| </style> | ||
|
|
||
| #### Tip | ||
| Use [**Labels**](https://www.baldengineer.com/kicad-bus-labels-and-global-labels.html) and [**Power Symbols**](https://klc.kicad.org/symbol/s7/s7.1/). These are very underused in beginner KiCad projects and while they don't serve much functional perpose they make is so much easier to review and understand your design. | ||
|
|
||
| ## Tutorial: The Hackercard Jam | ||
| We'll start the tutorial by making a simple NFC PCB using the [Hackcard Jam](https://jams.hackclub.com/jam/hacker-card) by Maggie. This tutorial assumes you've already completed this jam but with EasyEDA. | ||
|
|
||
| We can start by importing the necessary parts into KiCad's Symbol and Footprint librarys by using the following EasyEDA2KiCad command in a terminal, | ||
| ```bash | ||
| easyeda2kicad --lcsc_id C710403 --full | ||
| ``` | ||
| *replace "C710403" with the actual LCSC part number found on either [JLCPCB Parts](https://jlcpcb.com/partdetail/NxpSemicon-NT3H2111W0FHKH/C710403) or [LCSC](https://www.lcsc.com/product-detail/RFID-ICs_NXP-Semicon-NT3H2111W0FHKH_C710403.html)* | ||
|
|
||
| Next, in KiCad, press Place, Symbol and enter the LCSC part number for the part. Do this for every component in the jam. For the antenna this may be a little more tricky, first place the `Antenna_Loop` symbol from KiCad's default library. Lastly, to get the footprint, download the provided `.kicad_mod` [footprint file](docs/images/kicad/25X48MM_NFC_ANTENNA.kicad_mod), then in the KiCad main menu, click footprint editor, open the kicard_mod file and then File > Save As and save it to your easyeda2kicad folder. | ||
|
|
||
| Return to your schematic and double-click on the antenna. Next, click the three-books icon and search for the footprint named 25X48MM_NFC_ANTENNA. You should see it appear, displaying the correct antenna footprint. It should look something like this: | ||
|  | ||
|
|
||
| ## Submitting Your KiCad Project | ||
| Take a look at [Submitting To KiCad](/submitting-kicad.md) for instructions on how to submit your files. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.