Blog

FTC Onshape Library Standards

In order to make it easy to build models, we have defined a set of standards to ensure that all parts in the library work together and can be easily found.

All of the parts should have proper mates so that they can be used directly in a model.  Motors have a revolute mate for the motor shaft and bearings have an internal revolute mate.  Additionally, set screws and shaft tightening screws are integrated into individual parts to reduce the complexity on a model while still making them realistic.

In general if all the pieces always are used together, they are merged into a single part.  When color matters or there are moving parts, an assembly is created and the parts have a big red X integrated into them so that the parts aren’t used accidentally.  In the rare case of a part which has optional assembly parts, both the part and the assembly are present in the document allowing the user to choose which they want to use.

All parts follow a simple standard.  Whenever the name of a part appears, the SKU for that part as defined by the vendor is also added.  For example, the Tetrix Max Servo Horn (https://www.pitsco.com/Servo-Horn) which has a SKU of 39020 would be listed as:

TETRIX MAX Servo Horn 39020

This allows it to be searched for by the name or the part number.

The Document Properties uses that listed name and also includes the URL.  This allows it to be displayed as the details when a part is selected. Additionally, any part or assembly sets the Name field to be the listed name, the part number to be the web site SKU and the Description is set to be the URL for the vendors website.  This allows quick access to the website in ordering from a BOM for any created assembly using these parts.

Parts also have a standard color associated with materials:

 

Checklist for Parts meeting the Standard

  1. The Document Name must have the part Name followed by the SKU
  2. The Document Properties must have the Part name, SKU and URL
  3. Any imported STEP file should be renamed to STEP
  4. The imported STEP file can either be in the CAD Imports file or at the top level, but should always be the last tab at the top.
  5. For a simple part:
    1. There should be only a single part in the Parts studio
    2. Under the Part properties:
      1. Name must be the same name as the Document Name
      2. Description must be the URL
      3. Part number must be the vendor SKU
      4. Vendor filled in for who sells the part.
    3. The Part Assigned material should be set correctly
    4. The Part Appearance should be set to the correct standard color
    5. The name of the part tab should be the same as the Document Name
    6. The part should be oriented to match the vendor picture for the part
    7. The part studio should be selected as the document thumbnail
  6. For an assembly
    1. The part studio containing the parts should be named Parts
    2. For All parts in the part studio (using the part properties)
      1. They should should have simple names that won’t be found when searching for the full part name/SKU
      2. The Exclude from BOM flag should be checked
      3. The description and Part number fields should be blank
      4. The Part Assigned material should be set correctly
      5. The Part Appearance should be set to the correct standard color
    3. The part studio should have the big red do-not-use X in front of the parts
    4. The properties of the Assembly tab should have:
      1. Name must be the same name as the Document Name
      2. Description must be the URL
      3. Part number must be the vendor SKU
      4. Vendor filled in for who sells the part.
    5. The Assembly should be selected as the document thumbnail
    6. The Assembly should have all parts mated so that they stay together
    7. The Assembly should be oriented to match the vendor picture for the component
    8. Any movable mates should be included in the assembly.  E.g. motors and servos should turn, bearings revolve.
    9. The tabs at the bottom should be the Assembly should be ordered with the assembly first, parts next and any imported step file last
  7. Once all other criteria is met, a version should be created for the document

Adding to the Library

If you have a single part to add, create the part according to the standards for the library, put it into the Robot Parts Contributions folder.  One of the admins with access will move it into the proper folder. If you are interested in working on completing the list of parts, look at the list of parts in the Parts Status document to be worked on.  After contributing at least five parts which correspond to the standard, send email to FIRST@ptc.com and we will add you to the list of admins who can edit the entire tree.