Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion .markdownlint.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,7 @@
"MD013": false,
"MD033": false,
"MD059": false,
"MD046": false
"MD046": false,
"MD042": false,
"MD034": false
}
63 changes: 63 additions & 0 deletions docs/design/featurescripts.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
# Featurescripts

Onshape has its own scripting language to create custom features to automate aspects of design called [Featurescript](https://www.onshape.com/features/custom-features "Onshape Featurescript Page"){:target="_blank"}. There are a lot of featurescripts (what we call the custom features) that make designing for FRC much easier.

## How To Install Featurescripts

1. Open any Onshape document and go inside of a part studio
2. Click the rightmost button on the toolbar that looks like this: ![add custom feature button](/images/design/addCustomFeatures.webp)
- **Note:** If you have previously added any Featurescripts one of those may show up as the right most icon. In that case click the dropdown to show the add button.
3. Paste the link of the document with the featurescript(s) in it into the search bar
- **Note:** Some of the below featurescripts exist in the same document, so you can add multiple from the same link.

4. Select the featurescript(s) you want to add to your profile, then exit the box. They will be accessible in all documents from then on in the same drop-down in the toolbar where you added the feature.

!!! Note "Adding Featurescripts while in an Onshape Document"
When viewing a tab in a document that uses custom features, you can click a button near the top left that says 'custom features'. From here you can add custom features used in the document to your profile.

## Required Featurescripts

These featurescripts are required for all Team 401 design students to install and are extensively used as we design robots.

To install each featurescript:

1. Click the coresponding 'Copy to Clipboard' button
2. Click 'Add Custom Feature' in your Onshape window
3. Paste the copied URL
4. Select the custom feature you need - not all of the features in the Document

| Featurescript | Description | Copy to Clipboard | Onshape Link |
| -- | -- | -- | -- |
| Design Constants | Belt, gear, bolt distances | [Copy to Clipboard](javascript:void(0)){ .md-button .md-button--primary data-clipboard-text="https://cad.onshape.com/documents/780aac08a335649a61c44aaa/w/0b2ae0d562d2207807fb7b74/e/eea661b52c72a077238a2695"} | [Onshape :fontawesome-solid-share-from-square:](https://cad.onshape.com/documents/780aac08a335649a61c44aaa/w/0b2ae0d562d2207807fb7b74/e/eea661b52c72a077238a2695){:target="_blank" .md-button} |
| Extrude Individual | Use one sketch to make multiple tubes | [Copy to Clipboard](javascript:void(0)){ .md-button .md-button--primary data-clipboard-text="https://cad.onshape.com/documents/95c00401c440b44ad8799ef5/v/eea16175f5a62f4905e19ca1/e/f59ee8c28530122eb7fa9f5c"} | [Onshape :fontawesome-solid-share-from-square:](https://cad.onshape.com/documents/95c00401c440b44ad8799ef5/v/eea16175f5a62f4905e19ca1/e/f59ee8c28530122eb7fa9f5c){:target="_blank" .md-button} |
| Tube Converter | Convert Extrudes to Tubes | [Copy to Clipboard](javascript:void(0)){ .md-button .md-button--primary data-clipboard-text="https://cad.onshape.com/documents/95c00401c440b44ad8799ef5/v/3780fb78ddb5f9478d41aeeb/e/7f62400703032fab9a7a3320"} | [Onshape :fontawesome-solid-share-from-square:](https://cad.onshape.com/documents/95c00401c440b44ad8799ef5/v/3780fb78ddb5f9478d41aeeb/e/7f62400703032fab9a7a3320){:target="_blank" .md-button} |
| Spacer | Generate spacers to connect plates | [Copy to Clipboard](javascript:void(0)){ .md-button .md-button--primary data-clipboard-text="https://cad.onshape.com/documents/95c00401c440b44ad8799ef5/v/3780fb78ddb5f9478d41aeeb/e/9d38ab00b89aa97b6c65b7b0"} | [Onshape :fontawesome-solid-share-from-square:](https://cad.onshape.com/documents/95c00401c440b44ad8799ef5/v/3780fb78ddb5f9478d41aeeb/e/9d38ab00b89aa97b6c65b7b0){:target="_blank" .md-button} |
| Shaft | Generate shafts for power transmission | [Copy to Clipboard](javascript:void(0)){ .md-button .md-button--primary data-clipboard-text="https://cad.onshape.com/documents/95c00401c440b44ad8799ef5/v/3780fb78ddb5f9478d41aeeb/e/8db1f48368bdac821997185f"} | [Onshape :fontawesome-solid-share-from-square:](https://cad.onshape.com/documents/95c00401c440b44ad8799ef5/v/3780fb78ddb5f9478d41aeeb/e/8db1f48368bdac821997185f){:target="_blank" .md-button} |
| Gusset | Generate plates to connect tubes | [Copy to Clipboard](javascript:void(0)){ .md-button .md-button--primary data-clipboard-text="https://cad.onshape.com/documents/95c00401c440b44ad8799ef5/v/3780fb78ddb5f9478d41aeeb/e/80b86b695b75c4dcf2be5a7f"} | [Onshape :fontawesome-solid-share-from-square:](https://cad.onshape.com/documents/95c00401c440b44ad8799ef5/v/3780fb78ddb5f9478d41aeeb/e/80b86b695b75c4dcf2be5a7f){:target="_blank" .md-button} |
| Fillet All Edges | Fillets all edges on a part | [Copy to Clipboard](javascript:void(0)){ .md-button .md-button--primary data-clipboard-text="https://cad.onshape.com/documents/95c00401c440b44ad8799ef5/v/3780fb78ddb5f9478d41aeeb/e/be51a7d601bee5eb80c431ad?jumpToIndex=436"} | [Onshape :fontawesome-solid-share-from-square:](https://cad.onshape.com/documents/95c00401c440b44ad8799ef5/v/3780fb78ddb5f9478d41aeeb/e/be51a7d601bee5eb80c431ad?jumpToIndex=436){ .md-button} |
| Part Lighten | Lighten parts with ribs and perimeters | [Copy to Clipboard](javascript:void(0)){ .md-button .md-button--primary data-clipboard-text="https://cad.onshape.com/documents/028ca8fb10baf53e1f6fce96/v/821c8b51ed0953526b51926e/e/a8b9e45297aac9f5688c871d"} | [Onshape :fontawesome-solid-share-from-square:](https://cad.onshape.com/documents/028ca8fb10baf53e1f6fce96/v/821c8b51ed0953526b51926e/e/a8b9e45297aac9f5688c871d){:target="_blank" .md-button} |
| CheeseIt | Lighten parts with patterns | [Copy to Clipboard](javascript:void(0)){ .md-button .md-button--primary data-clipboard-text="https://cad.onshape.com/documents/f46510f08cc311a34733cac2/v/f7f3a1c996c58466f6b88a37/e/af18ea948d73d8e6aafa0767"} | [Onshape :fontawesome-solid-share-from-square:](https://cad.onshape.com/documents/f46510f08cc311a34733cac2/v/f7f3a1c996c58466f6b88a37/e/af18ea948d73d8e6aafa0767){:target="_blank" .md-button} |
| Threads | Create threads in / on 3DP parts | [Copy to Clipboard](javascript:void(0)){ .md-button .md-button--primary data-clipboard-text="https://cad.onshape.com/documents/95c00401c440b44ad8799ef5/v/3780fb78ddb5f9478d41aeeb/e/5e303420d66f4911c362508e"} | [Onshape :fontawesome-solid-share-from-square:](https://cad.onshape.com/documents/95c00401c440b44ad8799ef5/v/3780fb78ddb5f9478d41aeeb/e/5e303420d66f4911c362508e){:target="_blank" .md-button} |
| 3D Printing | Set accurate masses for 3DP parts | [Copy to Clipboard](javascript:void(0)){ .md-button .md-button--primary data-clipboard-text="https://cad.onshape.com/documents/95c00401c440b44ad8799ef5/v/3780fb78ddb5f9478d41aeeb/e/4490f033b69821f5722cc71d"} | [Onshape :fontawesome-solid-share-from-square:](https://cad.onshape.com/documents/95c00401c440b44ad8799ef5/v/3780fb78ddb5f9478d41aeeb/e/4490f033b69821f5722cc71d){:target="_blank" .md-button} |
| Motor Mounting | Mounting holes for FRC motors | [Copy to Clipboard](javascript:void(0)){ .md-button .md-button--primary data-clipboard-text="https://cad.onshape.com/documents/95c00401c440b44ad8799ef5/v/3780fb78ddb5f9478d41aeeb/e/f7d2fd67eee8b713d4a91fb3"} | [Onshape :fontawesome-solid-share-from-square:](https://cad.onshape.com/documents/95c00401c440b44ad8799ef5/v/3780fb78ddb5f9478d41aeeb/e/f7d2fd67eee8b713d4a91fb3){:target="_blank" .md-button} |
| Robot Belt | Generate Belts and Pulleys | [Copy to Clipboard](javascript:void(0)){ .md-button .md-button--primary data-clipboard-text="https://cad.onshape.com/documents/9cffa92db8b62219498f89af/v/05dd06c5cc9ae655a39e5c5d/e/99672d1e329b38e647d90146"} | [Onshape :fontawesome-solid-share-from-square:](https://cad.onshape.com/documents/9cffa92db8b62219498f89af/v/05dd06c5cc9ae655a39e5c5d/e/99672d1e329b38e647d90146){:target="_blank" .md-button} |
| Belt and Chain Gen | Generate Double Sided Belts | [Copy to Clipboard](javascript:void(0)){ .md-button .md-button--primary data-clipboard-text="https://cad.onshape.com/documents/53c0b14cad92676c14e04e97/v/ba3d3c1c31ed90eb4540d8b5/e/7394c4a86d8d6c35c9a12041"} | [Onshape :fontawesome-solid-share-from-square:](https://cad.onshape.com/documents/53c0b14cad92676c14e04e97/v/ba3d3c1c31ed90eb4540d8b5/e/7394c4a86d8d6c35c9a12041){:target="_blank" .md-button} |

## Optional Featurescripts

These featurescripts are not mandatory but make things quicker and are useful to have.

| Featurescript | Description | Copy to Clipboard | Onshape Link |
| -- | -- | -- | -- |
| Corner Overcut | Corners for tab and slot construction | [Copy to Clipboard](javascript:void(0)){ .md-button .md-button--primary data-clipboard-text="https://cad.onshape.com/documents/b99915c0b73924ca981bc57f/w/fe0bd1c034e61bbcdb3e68eb/e/14458d1263a98640a0cf663c"} | [Onshape :fontawesome-solid-share-from-square:](https://cad.onshape.com/documents/b99915c0b73924ca981bc57f/w/fe0bd1c034e61bbcdb3e68eb/e/14458d1263a98640a0cf663c){:target="_blank" .md-button} |
| Auto Layout | Layout Parts for Laser or Waterjet | [Copy to Clipboard](javascript:void(0)){ .md-button .md-button--primary data-clipboard-text="https://cad.onshape.com/documents/576e01dbe4b0cc2e7f46a55d/v/f697250aa149b6846173f4b1/e/887d6e2324589bfd2058c3e1"} | [Onshape :fontawesome-solid-share-from-square:](https://cad.onshape.com/documents/576e01dbe4b0cc2e7f46a55d/v/f697250aa149b6846173f4b1/e/887d6e2324589bfd2058c3e1){:target="_blank" .md-button} |
| T Slot Joint | Create T Slots for Laser or Waterjet | [Copy to Clipboard](javascript:void(0)){ .md-button .md-button--primary data-clipboard-text="https://cad.onshape.com/documents/5791a167e4b03c2aa6af3b35/v/f4f0540312c744f12681a624/e/acc455ae2adcf11a571ba510"} | [Onshape :fontawesome-solid-share-from-square:](https://cad.onshape.com/documents/5791a167e4b03c2aa6af3b35/v/f4f0540312c744f12681a624/e/acc455ae2adcf11a571ba510){ .md-button} |
| Laser Joint | Finger joint for Laser Cutter | [Copy to Clipboard](javascript:void(0)){ .md-button .md-button--primary data-clipboard-text="https://cad.onshape.com/documents/578830e4e4b0e65410f9c34e/v/4a3153e5b4fb5385bd22a9b8/e/7af109b2f1cead90850525ae"} | [Onshape :fontawesome-solid-share-from-square:](https://cad.onshape.com/documents/578830e4e4b0e65410f9c34e/v/4a3153e5b4fb5385bd22a9b8/e/7af109b2f1cead90850525ae){:target="_blank" .md-button} |
| Plate | Creating detailed FRC plates quickly | [Copy to Clipboard](javascript:void(0)){ .md-button .md-button--primary data-clipboard-text="https://cad.onshape.com/documents/9cffa92db8b62219498f89af/v/4d631c107644bbf1a650d6fc/e/f202d95d12d16b67322f5465?jumpToIndex=2672"} | [Onshape :fontawesome-solid-share-from-square:](https://cad.onshape.com/documents/9cffa92db8b62219498f89af/v/4d631c107644bbf1a650d6fc/e/f202d95d12d16b67322f5465?jumpToIndex=2672){ .md-button} |

## Troubleshooting and Updating Featurescripts

If a featurescript is not working as expected, the current version might be broken. You might have to update the featurescript. If it needs updating, the feature will show a blue icon to the right of it that, when hovered over, will say "change version of linked document."

1. The first way to update it is by individually by right clicking the feature you want updated in the feature list and clicking "Update linked document..."
2. The second, and slightly more permanent way (until the maintainer of the custom feature creates a new version), is by right clicking any of the featurescript icons in your toolbar or in the custom features dropdown and clicking "Update..." or "Update all..." From there, you can see the current versions of the custom features you have added to your profile and update selected ones to use the current latest version when you use a featurescript.
2 changes: 2 additions & 0 deletions docs/design/index.md
Original file line number Diff line number Diff line change
@@ -1 +1,3 @@
# Design

Team 401 uses Onshape for all of our CAD designs. Please follow the [FRC Design Learning Course](https://www.frcdesign.org/learning-course/) to get started with design.
25 changes: 25 additions & 0 deletions docs/design/team-designs.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# Team Designs

Team 401 maintains a set of reusable Onshape designs to help us design our robots more efficiently. Consider using one of these instead of starting a design from scratch.

## Electrical Designs

| Name | Description | Copy to Clipboard | Onshape Link |
| -- | -- | -- | -- |
| Combined Electronics | Case for roboRIO, CANivore, Pigeon2.0, MPM | [Copy Link](javascript:void(0)){ .md-button .md-button--primary data-clipboard-text="https://cad.onshape.com/documents/ab765f16e2cb17b316b39f19"} | [Onshape :fontawesome-solid-share-from-square:](https://cad.onshape.com/documents/ab765f16e2cb17b316b39f19){:target="_blank" .md-button} |
| Vision PC | Case for vision mini PC and mitoCANdria | [Copy Link](javascript:void(0)){ .md-button .md-button--primary data-clipboard-text="https://cad.onshape.com/documents/a120d4953e38a3cf42eaa23d"} | [Onshape :fontawesome-solid-share-from-square:](https://cad.onshape.com/documents/a120d4953e38a3cf42eaa23d){:target="_blank" .md-button} |
| Cable Retention | Configurable 3DP wire management brackets | [Copy Link](javascript:void(0)){ .md-button .md-button--primary data-clipboard-text="https://cad.onshape.com/documents/204b604ee8017210cb034919"} | [Onshape :fontawesome-solid-share-from-square:](https://cad.onshape.com/documents/204b604ee8017210cb034919){:target="_blank" .md-button} |
| Radio Case | Strain relieved VH-109 radio case | [Copy Link](javascript:void(0)){ .md-button .md-button--primary data-clipboard-text="https://cad.onshape.com/documents/8dd577bfbc61a387ca33d8f7"} | [Onshape :fontawesome-solid-share-from-square:](https://cad.onshape.com/documents/8dd577bfbc61a387ca33d8f7){:target="_blank" .md-button} |
| Breaker Shroud | 3DP protection for main breaker | [Copy Link](javascript:void(0)){ .md-button .md-button--primary data-clipboard-text="https://cad.onshape.com/documents/a9cb124c964e4791977a3cdb"} | [Onshape :fontawesome-solid-share-from-square:](https://cad.onshape.com/documents/a9cb124c964e4791977a3cdb){:target="_blank" .md-button} |
| ThriftyCam | Camera with configurable FOV and lens | [Copy Link](javascript:void(0)){ .md-button .md-button--primary data-clipboard-text="https://cad.onshape.com/documents/2236965b76c77e2f48548365"} | [Onshape :fontawesome-solid-share-from-square:](https://cad.onshape.com/documents/2236965b76c77e2f48548365){:target="_blank" .md-button} |

## Mechanical Designs

| Name | Description | Copy to Clipboard | Onshape Link |
| -- | -- | -- | -- |
| Swerve Chassis Gen | Configurable MK5n Chassis Generator | [Copy Link](javascript:void(0)){ .md-button .md-button--primary data-clipboard-text="https://cad.onshape.com/documents/ca5af9da40b032e6449f6ab9"} | [Onshape :fontawesome-solid-share-from-square:](https://cad.onshape.com/documents/ca5af9da40b032e6449f6ab9){:target="_blank" .md-button} |
| MK5n Swerve | Enhanced configurable MK5n swerve module | [Copy Link](javascript:void(0)){ .md-button .md-button--primary data-clipboard-text="https://cad.onshape.com/documents/d443d8b6fe769f5271457ce8"} | [Onshape :fontawesome-solid-share-from-square:](https://cad.onshape.com/documents/d443d8b6fe769f5271457ce8){:target="_blank" .md-button} |
| Bumper Mounts | Pneumatic Fitting Bumper Mounting | [Copy Link](javascript:void(0)){ .md-button .md-button--primary data-clipboard-text="https://cad.onshape.com/documents/1551a69a3a7caee5417fe2bc"} | [Onshape :fontawesome-solid-share-from-square:](https://cad.onshape.com/documents/1551a69a3a7caee5417fe2bc){:target="_blank" .md-button} |
| Configurable Pulley | Enhanced configurable pulley | [Copy Link](javascript:void(0)){ .md-button .md-button--primary data-clipboard-text="https://cad.onshape.com/documents/c530ab6409e9ed0be76ebf5f"} | [Onshape :fontawesome-solid-share-from-square:](https://cad.onshape.com/documents/c530ab6409e9ed0be76ebf5f){:target="_blank" .md-button} |
| Configurable Flywheel | Custom high MOI flywheel | [Copy Link](javascript:void(0)){ .md-button .md-button--primary data-clipboard-text="https://cad.onshape.com/documents/7984f558a0c8bc6cd4499332"} | [Onshape :fontawesome-solid-share-from-square:](https://cad.onshape.com/documents/7984f558a0c8bc6cd4499332){:target="_blank" .md-button} |
| Intake Template | Starting point for an intake | [Copy Link](javascript:void(0)){ .md-button .md-button--primary data-clipboard-text="https://cad.onshape.com/documents/f1555d2d609e1ac11b5ba048"} | [Onshape :fontawesome-solid-share-from-square:](https://cad.onshape.com/documents/f1555d2d609e1ac11b5ba048){:target="_blank" .md-button} |
Binary file added docs/images/design/addCustomFeatures.webp
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/design/units.webp
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion docs/programming/getting-started/installing-git.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@

On Windows, follow [this link](https://git-scm.com/) to go to the Git homepage.

![Git-Download](../../images/Git-Download.PNG)
![Git-Download](/images/Git-Download.PNG)

Click the blue download button inside the picture of a computer monitor. This screenshot shows the Windows version selected, but the link should automatically be set for whatever operating system you are using.

Expand Down
4 changes: 4 additions & 0 deletions docs/stylesheets/colors.css
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
.md-grid {
max-width: 1440px;
}

:root > * {

/* Primary color shades */
Expand Down
2 changes: 2 additions & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -78,6 +78,8 @@ markdown_extensions:
- pymdownx.emoji:
emoji_index: !!python/name:material.extensions.emoji.twemoji
emoji_generator: !!python/name:material.extensions.emoji.to_svg
- tables:
- attr_list:

extra:
generator: false
Expand Down
Binary file added requirements.txt
Binary file not shown.