This the multi-page printable view of this section. Click here to print.

Return to the regular view of this page.

Reference

Section containing reference documentation.

Introduction

This part of the documentation contains some topics such as

  • A glossary of key terms
  • How to contribute to the project
  • How to build and work with the documentation
  • Images of the various 3d printed parts for reference

1 - Glossary

Glossary of key terms to do with index, electronics and the ecosystem around pick and place machines.

Glossary

AOI

  • Acronym for Automatic Optical Inspection.

Automatic optical inspection

  • Computer vision inspection process to check for any issues after reflow.

CM

  • Acronym for Contract Manufacturer.

Index

  • The open source pick and place machine for creating populated circuit boards on a mid-level manufacturing scale.

Mid-level manufacturing

  • A term used to describe the step between small-scale and large-scale manufacturing where the amounts of products you are making doesn’t justify going to a contract manufacturer.

OSH

  • Acronym for Open Source Hardware.

OSS

  • Acronym for Open Source Software.

Pick and place machine

  • A machine that can programatically place components onto a circuit board in an automated fashion.

PNP

  • Acronym for Pick and Place.

PCB

  • Acronym for Printed Circuit Board.

Printed circuit board

  • A board which uses certain techniques for components to be spaced closer together and more easily manufactured.

SMD

  • Acronym for Surface Mount Device.

2 - 3D Print Detailed Information Table

Details of the 3D print objects

3D Printed Objects - Detailed Information

Example print times and filament requirements using Prusa Slicer and a Prusa MK3 printer, 0.2mm layer height and standard PLA filament.

FilenameFilament Used (m)Extruded Volume (mm3)Print Time (h:m:s)Total Print TimeFill DensityPerimetersTop/Bottom Solid LayersQuantity Required
FDM-0001-0127.422765959.37:14:007:14:0020%351
FDM-0002-011.984234772.630:30:000:30:0020%351
FDM-0003-0137.425490018.610:06:0010:06:0020%351
FDM-0004-0137.40689971.910:06:0010:06:0020%351
FDM-0005-0217.863242965.95:07:005:07:0020%351
FDM-0006-013.611858687.521:01:001:01:0020%351
FDM-0007-0111.950628744.73:32:003:32:0020%351
FDM-0008-016.9930716820.31:53:003:46:0020%352
FDM-0009-000.201029483.530:08:000:48:0030%456
FDM-0010-017.0056316850.52:32:002:32:0020%351
FDM-0011-0119.639847239.25:30:005:30:0030%451
FDM-0012-0119.471546834.55:28:005:28:0030%451
FDM-0013-024.9506611907.71:21:001:21:0020%351
FDM-0014-010.6991031681.540:27:000:27:0020%351
FDM-0015-012.468835938.230:49:000:49:0020%351
FDM-0016-000.7375851774.10:44:004:24:0020%356
FDM-0017-01????30%451
FDM-0018-012.731236569.380:56:000:56:0020%351
FDM-0019-01????20%351
FDM-0020-025.9201714239.71:42:001:42:0020%351
FDM-0021-012.510746039.050:43:000:43:0020%351
FDM-0022-011.479293558.110:26:000:26:0020%351
FDM-0023-010.129428311.3120:05:000:10:0020%352
FDM-0024-015.3827812947.11:58:001:58:0020%351
FDM-0025-012.365465689.590:58:000:58:0020%351
FDM-0026-010.4221661015.430:15:001:00:0020%354
FDM-0027-010.8878252135.470:20:001:40:0020%355
FDM-0037-001.741824189.570:34:001:42:0020%353
FDM-0038-000.03208677.17580:02:000:02:0020%351
FDM-0039-02????20%351
FDM-0040-010.8806082118.110:15:000:15:0020%351
FDM-0041-010.8899662140.620:15:000:15:0020%351

Totals

Filament used:

  • Length: 245.32 meters
  • Weight: 731.68 grams

Total duration: 3 days, 2:28:00

3 - Documentation

Page containing topics to do with how the documentation works.

Folder structure

The documentation is essentially built up using markdown with a certain folder structure. Section pages are made with folders containing an _index.md file in the root, subsections are built with folders and an index.md file in the root. The weight is what gives the certain ordering of the pages in each section.

The easiest way is to click the buttons on the right hand side of the docs page and it will generate, you just need to rename the file with the correct folder name and file name from the default change-me.md.

See below for an example file structure for the section pages or subsection pages which is auto-generated on clicking of the buttons.

---
title: "Long Page Title"
linkTitle: "Short Nav Title"
weight: 100
description: >-
     Page description for heading and indexes.
---

## Heading

Edit this template to create your new page.

* Give it a good name, ending in `.md` - e.g. `getting-started.md`
* Edit the "front matter" section at the top of the page (weight controls how its ordered amongst other pages in the same directory; lowest number first).
* Add a good commit message at the bottom of the page (<80 characters; use the extended description field for more detail).
* Create a new branch so you can preview your new file and request a review via Pull Request.

Testing

Docker

Testing changes requires that you be able to run docker and docker-compose. Once these tools are installed, follow the steps below to test.

  1. Ensure git-lfs is properly installed.

  2. Perform a recursive update of the repository.

    git submodule update --init --recursive
    
  3. Navigate to the doc directory of the repository.

  4. Build the docker image

    docker-compose build
    
  5. Run the build image

    docker-compose up
    
  6. Open the address http://localhost:1313/index in your web browser to preview your documentation. You can now make changes to the source files, those changes will be live-reloaded in your browser.

  7. Press CTRL+C to exit

  8. Remove the docker images.

    docker-compose rm
    

Native Installation of Hugo

  1. Install an extend version of Hugo. The first step of the quickstart guide is a good source.

  2. Perform a recursive update of the repository.

    git submodule update --init --recursive
    
  3. Navigate to the doc directory of the repository.

  4. Start the Hugo server.

    hugo server --source .
    
  5. Open the address http://localhost:1313/index in your web browser to preview your documentation. You can now make changes to the source files, those changes will be live-reloaded in your browser.

  6. Press CTRL+C to exit

Building the docs

Generation is done with Hugo doc generator and the docsy theme. Take a look at https://www.docsy.dev if you want to get set up for local preview. Updates to the site happen automatically on merge to the assembly-guide branch via GitHub actions. So contributing pull requests is the proper way to update the site.

See this comment for more details.

4 - FDM Reference

Diagrams and images of the various 3d printed parts using FDM print methods

Fused Deposition Modelling

Fused deposition modelling (FDM) is the most widely used form of 3D printing at the consumer level. FDM works by extruding thermoplastics, such as ABS, PLA, through a heated nozzle, melting the material and applying the plastic layer by layer to a build platform.

FDM Parts Reference

FDM_0001_00_front_left_leg

FDM_0001_00_front_left_leg

FDM_0002_00_front_right_leg

FDM_0002_00_front_right_leg

FDM_0003_00_back_left_leg

FDM_0003_00_back_left_leg

FDM_0005_00_y_gantry

FDM_0005_00_y_gantry

FDM_0006_00_x_motor_mount

FDM_0006_00_x_motor_mount

FDM_0007_00_frame_umbilical_mount

FDM_0007_00_frame_umbilical_mount

FDM_0008_00_y_gantry_support

FDM_0008_00_y_gantry_support

FDM_0009_00_roller_spacer

FDM_0009_00_roller_spacer

FDM_0010_00_y_gantry_umbilical_mount

FDM_0010_00_y_gantry_umbilical_mount

FDM_0011_00_x_gantry_front

FDM_0011_00_x_gantry_front

FDM_0012_00_x_gantry_back

FDM_0012_00_x_gantry_back

FDM_0013_00_x_idler_mount

FDM_0013_00_x_idler_mount

FDM_0014_00_down_camera_mount

FDM_0014_00_down_camera_mount

FDM_0015_00_down_light_mount

FDM_0015_00_down_light_mount

FDM_0016_00_cable_clip

FDM_0016_00_cable_clip

FDM_0017_00_z_gantry_left

FDM_0017_00_z_gantry_left

FDM_0019_00_up_light_mount

FDM_0019_00_up_light_mount

FDM_0020_00_up_camera_mount

FDM_0020_00_up_camera_mount

FDM_0021_00_foot

FDM_0021_00_foot

FDM_0022_00_umbilical_guide

FDM_0022_00_umbilical_guide

FDM_0023_00_peek_cable_guide

FDM_0023_00_peek_cable_guide

FDM_0024_00_nozzle_holder

FDM_0024_00_nozzle_holder

FDM_0025_00_belt_clamp

FDM_0025_00_belt_clamp

FDM_0025_00_pump_mount

FDM_0025_00_pump_mount

FDM_0026_00_board_holder

FDM_0026_00_board_holder

5 - Print settings

Page containing recommendations and explanations of print settings for 3D printed parts.

3D Printing

During development of the Index, all parts were printed in PLA. A few parts in particular require quite a high strength if being printed. Of course, every printer runs a bit different, and these are just guidelines to illustrate the necessary strength difference between different parts.

Default Settings

  • 3 shells
  • 20% infill
  • 5 Top/Bottom layers

Gantry Part Settings

  • 4 shells
  • 30% infill
  • 5 Top/Bottom layers