Skip to content

Commit

Permalink
Fixed all internal links to match the format expected by MkDocs - no …
Browse files Browse the repository at this point in the history
…absolute links, always link to the `.md` file.
  • Loading branch information
theacodes committed Nov 13, 2024
1 parent 0b9799d commit e9191c4
Show file tree
Hide file tree
Showing 29 changed files with 66 additions and 66 deletions.
2 changes: 1 addition & 1 deletion docs/byop/testing/actuator-check/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ M3426 G4 C2 I1 A110 ;read vac 2 value
```

!!! danger "In Case Of Error"
These commands are meant for a newer version of Marlin that adds support for multiple ADCs. If you're getting an error in response from Marlin, [update the firmware to the latest version](/guides/update-firmware/).
These commands are meant for a newer version of Marlin that adds support for multiple ADCs. If you're getting an error in response from Marlin, [update the firmware to the latest version](../../../guides/update-firmware/index.md).

## Next steps

Expand Down
2 changes: 1 addition & 1 deletion docs/byop/testing/connect-computer/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@
1. Restart your computer
2. Check if the LumenPnP shows up in Device Manager (Windows).
3. Try another USB Port
4. Try [re-flashing firmware](/guides/update-firmware/)
4. Try [re-flashing firmware](../../../guides/update-firmware/index.md)

## Cameras
We also need to check connecting to the cameras. CNCjs has a webcam feature, so we'll use it for this test too.
Expand Down
2 changes: 1 addition & 1 deletion docs/feeders/1-overview/feeder-overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,4 +66,4 @@ If you find that there's something unclear in this documentation, please [submit

## Next steps

Before using the feeders, you'll [install the slot harness](/feeders/2-install-harness/). If your machine already has slots installed, you can jump ahead to [mounting feeders](/feeders/4-mounting/mounting/).
Before using the feeders, you'll [install the slot harness](../2-install-harness/index.md). If your machine already has slots installed, you can jump ahead to [mounting feeders](../4-mounting/mounting.md).
8 changes: 4 additions & 4 deletions docs/feeders/2-install-harness/feeder-blade/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ In this step, you'll install and wire slots onto the front and back rails of you
To ensure feeders will mount to your LumenPnP's front rail, we need to ensure that your staging plate is mounted at the correct position. **If you have a v3 LumenPnP, your staging plate is already at the correct distance, and can skip this section.**

!!! danger "Warning"
Be aware that moving your primary staging plate will change where your bottom camera and homing fiducial markers are mounted. After moving the staging plate, you will need to review your machine's calibration. Specifically, the [Homing Fiducial](/openpnp/calibration/4-homing-fiducial) and [Bottom Camera Position](/openpnp/calibration/7-bottom-camera-position).
Be aware that moving your primary staging plate will change where your bottom camera and homing fiducial markers are mounted. After moving the staging plate, you will need to review your machine's calibration. Specifically, the [Homing Fiducial](../../../openpnp/calibration/4-homing-fiducial/index.md) and [Bottom Camera Position](../../../openpnp/calibration/7-bottom-camera-position/index.md).

1. Unplug your LumenPnP.

Expand Down Expand Up @@ -181,10 +181,10 @@ In your Slot Harness Kit, you'll find:

If you were directed to this page by LumenPnP wiring instructions return to one of the following pages to finish plugging everything in:

* [v3.0](/semi-assembly/wiring/#finalize-wiring)
* [v3.1 / V3.2](/semi-assembly-3-1/wiring-3-1/#finalize-wiring)
* [v3.0](../../../semi-assembly/wiring/index.md#finalize-wiring)
* [v3.1 / V3.2](../../../semi-assembly-3-1/wiring-3-1/index.md#finalize-wiring)

Otherwise, next is [updating your software.](/feeders/3-software-update)
Otherwise, next is [updating your software.](../../3-software-update/index.md)

[clip-url]: https://github.com/opulo-inc/lumenpnp/blob/main/pnp/cad/FDM/extrusion-cable-clip.FCStd
[slot-url]: https://github.com/opulo-inc/feeder
8 changes: 4 additions & 4 deletions docs/feeders/2-install-harness/feeder-slot/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ In this step, you'll install and wire slots onto the front and back rails of you
To ensure feeders will mount to your LumenPnP's front rail, we need to ensure that your staging plate is mounted at the correct position. **If you have a v3 LumenPnP, your staging plate is already at the correct distance, and can skip this section.**

!!! danger "Warning"
Be aware that moving your primary staging plate will change where your bottom camera and homing fiducial markers are mounted. After moving the staging plate, you will need to review your machine's calibration. Specifically, the [Homing Fiducial](../../openpnp/calibration/4-homing-fiducial/#tuning-the-homing-fiducial) and [Bottom Camera Position](../../openpnp/calibration/7-bottom-camera-position/).
Be aware that moving your primary staging plate will change where your bottom camera and homing fiducial markers are mounted. After moving the staging plate, you will need to review your machine's calibration. Specifically, the [Homing Fiducial](../../../openpnp/calibration/4-homing-fiducial/index.md#tuning-the-homing-fiducial) and [Bottom Camera Position](../../../openpnp/calibration/7-bottom-camera-position/index.md).

1. Unplug your LumenPnP.

Expand Down Expand Up @@ -165,10 +165,10 @@ In your Slot Harness Kit, you'll find:

If you were directed to this page by LumenPnP wiring instructions return to one of the following pages to finish plugging everything in:

* [v3.0](/semi-assembly/wiring/#finalize-wiring)
* [v3.1 / V3.2](/semi-assembly-3-1/wiring-3-1/#finalize-wiring)
* [v3.0](../../../semi-assembly/wiring/index.md#finalize-wiring)
* [v3.1 / V3.2](../../../semi-assembly-3-1/wiring-3-1/index.md#finalize-wiring)

Otherwise, next is [updating your software.](../3-software-update)
Otherwise, next is [updating your software.](../../3-software-update/index.md)

[clip-url]: https://github.com/opulo-inc/lumenpnp/blob/main/pnp/cad/FDM/extrusion-cable-clip.FCStd
[slot-url]: https://github.com/opulo-inc/feeder
4 changes: 2 additions & 2 deletions docs/feeders/2-install-harness/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,11 @@ The LumenPnP has two versions of slots. The most recent version has four "blades
[![Feeder Slot Blades][1]][2]

[1]: img/feeder-blade-set.webp
[2]: feeder-blade/ "Redirect to Feeder Slot Blades"
[2]: feeder-blade/index.md "Redirect to Feeder Slot Blades"

# [Individual Feeder Slots](feeder-slot/index.md)

[![Individual Feeder Slots][3]][4]

[3]: img/IMG_1969.webp
[4]: feeder-slot/ "Redirect to Individual Feeder Slots"
[4]: feeder-slot/index.md "Redirect to Individual Feeder Slots"
4 changes: 2 additions & 2 deletions docs/feeders/3-software-update/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ LumenPnP feeders require a specific version of OpenPnP (the 2023-04-05 release),

1. Download the LumenPnP firmware from the latest release [here](https://github.com/opulo-inc/lumenpnp/releases) that matches your machine's version. Firmware file names start with the machine versions they support.

2. Follow the instructions for [updating your LumenPnP's firmware](/guides/update-firmware).
2. Follow the instructions for [updating your LumenPnP's firmware](../..//guides/update-firmware/index.md).

## Update Feeder Firmware **(Optional)**

Expand Down Expand Up @@ -103,7 +103,7 @@ LumenPnP feeders require a specific version of OpenPnP (the 2023-04-05 release),
## Checking Current Firmware Version

1. Press and hold both buttons on the feeder.
1. Wait until the light comes on, indicating that you've [switched modes](/feeders/1-overview/feeder-overview/#__tabbed_2_3).
1. Wait until the light comes on, indicating that you've [switched modes](../1-overview/feeder-overview.md#__tabbed_2_3).
1. Keep the buttons held until the light goes off.

!!! danger "Firmware versions v1.0.2 and before"
Expand Down
2 changes: 1 addition & 1 deletion docs/feeders/6-loading-tape/loading-tape.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,4 +69,4 @@ This video shows how tape is loaded into the feeder, and the functionality of th

## Next Steps

Next, you'll [set pick position](/feeders/7-setting-pick-position/setting-pick-position/).
Next, you'll [set pick position](../7-setting-pick-position/setting-pick-position.md).
Original file line number Diff line number Diff line change
Expand Up @@ -71,4 +71,4 @@ Now that you've loaded a component into the feeder, we'll fine-tune the feeder's

## Next Steps

If you came here from the FTP documentation, your next step is [running a test job](/openpnp/ftp/3-test-run/).
If you came here from the FTP documentation, your next step is [running a test job](../../openpnp/ftp/3-test-run/index.md).
6 changes: 3 additions & 3 deletions docs/guides/second-tool/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -207,8 +207,8 @@ With the hardware set up, we need to tell OpenPnP about the newly installed tool
## Fine Tuning

1. Attach a nozzle to your new second tool head
2. Set [your new nozzle's offset](../../../openpnp/calibration/6-nozzle-offset).
3. Try homing your machine again. If you get the `Nozzle tip calibration: not enough results from vision. Check pipeline and threshold` error, you will need to tune your [Bottom Camera Vision Pipeline](/openpnp/vision-pipeline-adjustment/4-nozzle-calibration-pipeline).
4. Test picking components out of your feeders. Follow the instructions in the [FTP](/openpnp/ftp/1-installing-the-feeders/#installing-the-n045-nozzle) guide. Make sure to activate your newly created tool head, and assign a nozzle tip to it.
2. Set [your new nozzle's offset](../../openpnp/calibration/6-nozzle-offset/index.md).
3. Try homing your machine again. If you get the `Nozzle tip calibration: not enough results from vision. Check pipeline and threshold` error, you will need to tune your [Bottom Camera Vision Pipeline](../../openpnp/vision-pipeline-adjustment/4-nozzle-calibration-pipeline.md).
4. Test picking components out of your feeders. Follow the instructions in the [FTP](../../openpnp/ftp/1-board-setup/index.md#installing-the-n045-nozzle) guide. Make sure to activate your newly created tool head, and assign a nozzle tip to it.

[step]: https://wiki.fysetc.com/Silent2209/
4 changes: 2 additions & 2 deletions docs/guides/update-gcode-macros/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,10 @@ OpenPnP puts general machine configuration in the same file as machine-specific
**If you're setting up your machine for the first time, you don't need to do this.** This guide is only for folks that are looking to update their machine config, but set up their machine using an older version of the configuration files.

!!! warning "OpenPnP Version"
Be sure that you're using the recommended version of OpenPnP for this guide. You can find installation instructions [here](/openpnp/install).
Be sure that you're using the recommended version of OpenPnP for this guide. You can find installation instructions [here](../../openpnp/install-config/install/index.md).

!!! warning "Firmware Version"
These macros require that your firmware is up to date with the latest firmware release for your machine. [Make sure you're up to date](/guides/update-firmware).
These macros require that your firmware is up to date with the latest firmware release for your machine. [Make sure you're up to date](../../guides/update-firmware/index.md).

## v3.1+ Machines

Expand Down
14 changes: 7 additions & 7 deletions docs/misc/versions/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ The LumenPnP is always being upgraded and improved. This page is a reference for

### v2.X.X

![](/byop/hero-alpha-min.webp){: style="width:60%;margin-left:10%;"}
![](../../byop/hero-alpha-min.webp){: style="width:60%;margin-left:10%;"}

The v2 of the LumenPnP was a kit. It came as a box of parts and circuit boards, and users would 3D print all the plastic parts themselves. The LumenPnP v2 had:

Expand All @@ -23,7 +23,7 @@ The v2 of the LumenPnP was a kit. It came as a box of parts and circuit boards,

### v3.0.X

![](/semi-assembly/semi-hero.webp){: style="width:60%;margin-left:10%;"}
![](../../semi-assembly/semi-hero.webp){: style="width:60%;margin-left:10%;"}

v3.0 versions of the LumenPnP were the first to come semi-assembled. They arrived with all printed parts included, and bolted together from just a handful of subassemblies. The LumenPnP v3.0 had:

Expand All @@ -36,7 +36,7 @@ v3.0 versions of the LumenPnP were the first to come semi-assembled. They arrive

### v3.1.X

![](/semi-assembly-3-1/3_1.webp){: style="width:60%;margin-left:10%;"}
![](../../semi-assembly-3-1/3_1.webp){: style="width:60%;margin-left:10%;"}

v3.1.X was a significant improvement to the previous version, introducing linear rails and upgrading to cable chain.

Expand All @@ -49,7 +49,7 @@ v3.1.X was a significant improvement to the previous version, introducing linear

### v3.2.X

![](/semi-assembly-3-1/3_1.webp){: style="width:60%;margin-left:10%;"}
![](../../semi-assembly-3-1/3_1.webp){: style="width:60%;margin-left:10%;"}

v3.2.X of the machine is almost identical to v3.1.X, except that the slots (where feeders interface with the machine) are ganged together into "blades" to make them easier to manufacure.

Expand Down Expand Up @@ -158,11 +158,11 @@ Once you've added the linear rails, you can greatly increase the speed of your m

In machines prior to v3.1, there wasn't much strain relief for the L and R motors.

![](/semi-assembly/wiring/images/finished-head.webp){: style="width:60%;margin-left:10%;"}
![](../../semi-assembly/wiring/images/finished-head.webp){: style="width:60%;margin-left:10%;"}

Starting in v3.1, the z-gantry print got a location to secure the cable using a zip tie.

![](/semi-assembly-3-1/wiring-3-1/images/zip-lh-4.webp){: style="width:60%;margin-left:10%;"}
![](../../semi-assembly-3-1/wiring-3-1/images/zip-lh-4.webp){: style="width:60%;margin-left:10%;"}

Reprinting your z-gantries from the [v3.1 release](https://github.com/opulo-inc/lumenpnp/releases/tag/v3.1.0) and zip tieing the cables to the print will greatly improve the strain relief for your machine's cables.

Expand All @@ -173,4 +173,4 @@ Reprinting your z-gantries from the [v3.1 release](https://github.com/opulo-inc/

If you're upgrading your machine's hardware, it's very likely you'll need to update how OpenPnP controls it as well. Depending on what you changed, you'll have to splice new Gcode into OpenPnP to support it. In general, speed settings are based on if your machine has linear rails or rollers.

To update your Gcode Macros, visit [our guide for doing so](/guides/update-gcode-macros).
To update your Gcode Macros, visit [our guide for doing so](../../guides/update-gcode-macros/index.md).
2 changes: 1 addition & 1 deletion docs/openpnp/calibration/10-vacuum-sensor/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ While the bottom camera can detect if a part was successfully picked, you can us
## LumenPnP v2

!!! note "v2 Interposers"
If you have a v2 machine, please [check if you have interposer boards installed](/guides/rev3-vac-interposer).
If you have a v2 machine, please [check if you have interposer boards installed](../../../guides/rev3-vac-interposer/index.md).

1. Select your GcodeDriver, then under the Gcode tab, select the `H1 VAC1` actuator, and select the `ACTUATOR_READ_COMMAND` setting.

Expand Down
2 changes: 1 addition & 1 deletion docs/openpnp/calibration/4-homing-fiducial/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Now we can set up the datum board. The datum board is a reference point for ever
!!! danger "If your machine does not move fully to the front left"
If your LumenPnP does not move all the way to the front left of the machine when you click the Home icon, it could mean that your sensorless homing values need to be adjusted.

Instructions for tuning this setting are [here](/guides/tuning-sensorless/).
Instructions for tuning this setting are [here](../../../guides/tuning-sensorless/index.md).

## Setting Homing Fiducial Location

Expand Down
2 changes: 1 addition & 1 deletion docs/openpnp/calibration/5-mm-per-pixel/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ This next step calibrates the relationship between pixels and millimeters to mak

1. Identify your machine's nozzle tips. They're mounted in the rack on your staging plate.

![](/semi-assembly-3-1/mounting-staging-plates-3-1/images/nozzle-tip-location.webp)
![](../../../semi-assembly-3-1/mounting-staging-plates-3-1/images/nozzle-tip-location.webp)

1. Remove the nozzle tips labeled `N045` and `N24` from the rack.

Expand Down
2 changes: 1 addition & 1 deletion docs/openpnp/debugging/feeder-rotation.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,4 +10,4 @@ When setting the position of a feeder, the rotation value you enter is equal to

## The part's vision pipeline needs adjustment

If your rotation offset is consistently 90 or 180 degrees this is less likely, but it could still worth [adjusting that part's vision pipeline](/openpnp/vision-pipeline-adjustment/5-part-identification-pipeline/).
If your rotation offset is consistently 90 or 180 degrees this is less likely, but it could still worth [adjusting that part's vision pipeline](../vision-pipeline-adjustment/5-part-identification-pipeline.md).
6 changes: 3 additions & 3 deletions docs/openpnp/debugging/global-offset.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,15 +6,15 @@ If parts are universally placed with an offset in the X and/or Y axis, there are

## Bottom camera position needs adjustment

If OpenPnP's understanding of where the bottom camera is located is incorrect, part placements can also be incorrect. Perform a [nozzle offset calibration](/openpnp/calibration/6-nozzle-offset/) on one nozzle, then immediately [set the bottom camera position](/openpnp/calibration/7-bottom-camera-position/) without rotating the nozzle.
If OpenPnP's understanding of where the bottom camera is located is incorrect, part placements can also be incorrect. Perform a [nozzle offset calibration](../calibration/6-nozzle-offset/index.md) on one nozzle, then immediately [set the bottom camera position](../calibration/7-bottom-camera-position/index.md) without rotating the nozzle.

## Fiducial calibration pipeline needs adjustment

If OpenPnP incorrectly detects your fiducials and instead thinks a silkscreen marking or footprint pad is the fiducial, all of the locations on your board will be shifted. [Make sure your fiducial pipeline is correctly identifying your PCB's fiducials.](/openpnp/vision-pipeline-adjustment/3-pcb-fiducial-pipeline/)
If OpenPnP incorrectly detects your fiducials and instead thinks a silkscreen marking or footprint pad is the fiducial, all of the locations on your board will be shifted. [Make sure your fiducial pipeline is correctly identifying your PCB's fiducials.](../vision-pipeline-adjustment/3-pcb-fiducial-pipeline.md)

## Both nozzles need offset calibration adjustment

It's possible that both of your nozzle offsets need adjusting. [Make sure your nozzle offsets are correct.](/openpnp/calibration/6-nozzle-offset/)
It's possible that both of your nozzle offsets need adjusting. [Make sure your nozzle offsets are correct.](../calibration/6-nozzle-offset/index.md)

## The LumenPnP skipped steps during motion

Expand Down
8 changes: 4 additions & 4 deletions docs/openpnp/debugging/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,12 +52,12 @@ You might have found an inaccuracy or error when placing parts. This page addres

If the nozzle is not picking parts consistently, there are a few potential root causes:

- **The vacuum sensor threshold is too sensitive.** If you notice that your nozzle is attempting to pick a part, but seems to raise up too quickly, the vacuum sensor threshold value is incorrectly telling OpenPnP that it's successfully picked the part. This can be solved by [tuning your vacuum sensor threshold value](/openpnp/calibration/10-vacuum-sensor).
- **The feeder Z position is set too high.** If the machine is told to pick a part slightly too high, the nozzle tip doesn't make a good seal on the part, and fails to pick. This is solved by adjusting the [feeder's height](/feeders/7-setting-pick-position/setting-pick-position/).
- **The vacuum sensor threshold is too sensitive.** If you notice that your nozzle is attempting to pick a part, but seems to raise up too quickly, the vacuum sensor threshold value is incorrectly telling OpenPnP that it's successfully picked the part. This can be solved by [tuning your vacuum sensor threshold value](../calibration/10-vacuum-sensor/index.md).
- **The feeder Z position is set too high.** If the machine is told to pick a part slightly too high, the nozzle tip doesn't make a good seal on the part, and fails to pick. This is solved by adjusting the [feeder's height](../../feeders/7-setting-pick-position/setting-pick-position.md).
- **Lack of suction force from the nozzle tip.** Especially for the smallest N045 nozzle tip, some solder paste can get stuck in the tip, reducing suction force. If you cannot see a tiny circle of light shining through the tip when held up to a light, you might need to clean the tip with a thin wire and some isopropyl alcohol.

### "No result found" error

![no parts found error](/openpnp/vision-pipeline-adjustment/images/no-parts-found.webp)
![no parts found error](../vision-pipeline-adjustment/images/no-parts-found.webp)

- If the component was not identified by the bottom camera correctly, you will likely need to adjust its [Part Identification Vision Pipeline](/openpnp/vision-pipeline-adjustment/5-part-identification-pipeline.md).
- If the component was not identified by the bottom camera correctly, you will likely need to adjust its [Part Identification Vision Pipeline](../vision-pipeline-adjustment/5-part-identification-pipeline.md).
Loading

0 comments on commit e9191c4

Please sign in to comment.