Skip to content

Commit 11a3e69

Browse files
committed
Brings Doc refresh, fixes random broken links, and makes corrections. Also brings more validations for each section with more explanations to educate better.
1 parent 46ba5af commit 11a3e69

40 files changed

Lines changed: 315 additions & 184 deletions

docs/guides/design-for-lumenpnp/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@
22

33
While the LumenPnP is capable of populating the vast majority of PCBs, there are general design guidelines that will help make population as smooth and automated as possible.
44

5-
All machine capabilities can also be found in the v3.1 [brochure](https://cdn.shopify.com/s/files/1/0570/4256/7355/files/LumenPnP-v3.1-brochure.pdf?v=1698263482).
5+
All machine capabilities can also be found in the LumenPnP V4 [brochure](https://cdn.shopify.com/s/files/1/0570/4256/7355/files/LumenPnP-v3.1-brochure.pdf?v=1698263482).
66

7-
Also be sure to check out the [Midscale Website](https://midscale.io/) for information and resources for midscale manufacturing.
7+
Also be sure to check out the page for [Setting Up An SMT Line](https://www.opulo.io/pages/set-up) or [Hardware.cafe](https://hardware.cafe/) for information and resources for midscale manufacturing.
88

99
## Components
1010

docs/misc/calibration/10-vacuum-sensor/index.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
![](../../calibration/img/lumenpnp-v3-docs-logo-small.png)
44

5-
When picking up parts with the LumenPnP, it’s important to verify that a part has been successfully picked. While the bottom camera can confirm this visually, using the LumenPnP's vacuum sensors provides a faster way to detect a successful pick.
5+
When picking up parts with the LumenPnP, it’s important to verify that a part has been successfully picked. While the bottom camera also confirms this visually, using the LumenPnP's vacuum sensors provides a faster way to detect a successful pick, preventing it from having to bring the component to the bottom camera first to detect the part. Because the bottom camera does checks the part, even if slightly slower, you can freely disable the vacuum part detection with confidence that you'll still be able to place your parts.
66

77
---
88

@@ -44,7 +44,7 @@ Each nozzle has a different vacuum reading due to variations in nozzle tip size.
4444
![Enabling part detection](../../../openpnp/v4/calibration/10-vacuum-sensor/images/03-n045-part-detection-tab.webp)
4545
<br/><br/>
4646

47-
1. **Measure the Vacuum Pressure**.
47+
1. **Measure the Vacuum Pressure While Open**.
4848
* In `Machine Controls`, navigate to the `Actuators` tab.
4949
* Select `H1:VAC1` to open the vacuum pressure window.
5050
* Click `On` to activate the pump and valve. <br/><br/>
@@ -54,8 +54,8 @@ Each nozzle has a different vacuum reading due to variations in nozzle tip size.
5454
![actuator control](../../../openpnp/v4/calibration/10-vacuum-sensor/images/05-read-vacuum-sensor-n045.webp)
5555
<br/><br/>
5656

57-
1. **Measure the Vacuum Pressure with a Sealed Nozzle**.
58-
* Cover the nozzle tip completely with your fingertip.
57+
1. **Measure the Vacuum Pressure While Covered**.
58+
* **Take one of the components from the strip of components included with your LumenPnP kit**, or a component from your BOM that is an appropriate size for this nozzle, and **hold it up to the nozzle tip**. The vacuum pressure should be able to pick up and hold the part on its own.
5959
* Click `Read` again. This represents the vacuum pressure when a part is picked, or "**covered**".<br/><br/>
6060
![Turn on punp](../../../openpnp/v4/calibration/10-vacuum-sensor/images/06-reading-with-finger-covering-n045.webp)<br/><br/>
6161
* **Take note of the new value**. We will also need it later.
@@ -76,6 +76,7 @@ Each nozzle has a different vacuum reading due to variations in nozzle tip size.
7676
!!! caution
7777
The difference between uncovered and covered readings may be small, but **even a single-digit change can indicate a successful pick**. Nozzle sizes affect these readings, so expect variations between nozzles.
7878
<br/><br/>
79+
7980
1. **Apply and Save**
8081
* Click `Apply` in the lower right corner to save your changes to the **N045** nozzle tip.<br/><br/>
8182
![apply](../../../openpnp/v4/calibration/2-connect-to-machine/images/apply-button.webp)<br/><br/>
@@ -118,7 +119,7 @@ Each nozzle has a different vacuum reading due to variations in nozzle tip size.
118119
<br/><br/>
119120

120121
1. **Measure the Vacuum Pressure with a Sealed Nozzle**.
121-
* Cover the nozzle tip completely with your fingertip.
122+
* **Take a component** from your BOM that is an appropriate size for this nozzle **and hold it up to the nozzle tip**. The vacuum pressure should be able to pick up and hold the part on its own. If you do not have a component large enough for this nozzle tip, you may use your fingertip as a fallback. However, **using an actual component will provide the most accurate results**.
122123
* Click `Read` again. This represents the vacuum pressure when a part is picked, or "**covered**".<br/><br/>
123124
![Vacuum Pump Reading for N24](../../../openpnp/v4/calibration/10-vacuum-sensor/images/14-n24-reading-covered.webp)<br/><br/>
124125
* **Take note of the new value**. We will also need it later.

docs/misc/calibration/2-connect-to-machine/index.md

Lines changed: 12 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22

33
![](../img/lumenpnp-v3-docs-logo-small.png)
44

5+
*(**V2 Users**, you can use these docs for your machine as well. For anything specific to V2, we will add notes pointing it out).*
6+
57
**Now that OpenPnP is installed and the LumenPnP configuration files have been placed in the hidden system folder, OpenPnP can start with some basic preconfigured settings. The next step is to connect your LumenPnP and get familiar with OpenPnP’s user interface.**.
68

79
**Then, we will install the N045 and N24 nozzle tips to help us with calibration**.
@@ -45,7 +47,7 @@ Follow these steps in order:
4547

4648
---
4749

48-
## Configuration the Serial Port
50+
### Configuration the Serial Port
4951

5052
**Before OpenPnP can communicate with the LumenPnP, we need to set the correct serial port**.
5153

@@ -94,7 +96,7 @@ Follow these steps in order:
9496

9597
---
9698

97-
## Establishing a Serial Connection
99+
### Establishing a Serial Connection
98100

99101
1. **Connect OpenPnP to Your Machine**
100102
* Click the **green power button** in the `Machine Controls` section (Bottom left of OpenPnP).<br/><br/>
@@ -140,8 +142,10 @@ Follow these steps in order:
140142
1. Before we home the LumenPnP, it is very important that we check a couple of settings.
141143
* Go to `Machine Setup > Nozzle Tips >N045 > Calibration Tab > Auto Recalibration`
142144
* Ensure `Auto Recalibration` is set to `Manual`.<br/><br/>
145+
![Set nozzle N045 to manual](../../../openpnp/v4/calibration/2-connect-to-machine/images/set-n045-to-manual.webp)<br/><br/>
143146
* Then, go to `Machine Setup > Nozzle Tips >N24 > Calibration Tab > Auto Recalibration`
144147
* Ensure `Auto Recalibration` is set to `Manual`.<br/><br/>
148+
![Set nozzle N24 to manual](../../../openpnp/v4/calibration/2-connect-to-machine/images/set-n24-to-manual.webp)<br/><br/>
145149

146150
1. Once the nozzle tips are set to `Manual`, click the **Home button** to perform a rough homing sequence.
147151
* The Nozzles will move to X, Y, and Z zero positions **(front-left corner of the LumenPnP)** and park there.
@@ -155,7 +159,7 @@ Follow these steps in order:
155159

156160
---
157161

158-
## Install the Nozzle Tips
162+
### Install the Nozzle Tips
159163

160164
1. **Locate Your Nozzle Tips and SuperLube tube**.
161165
* Find and remove the `N045` and `N24` nozzle tips in the nozzle rack that is mounted on the staging plate.<br/><br/>
@@ -197,7 +201,7 @@ Follow these steps in order:
197201

198202
## Configuring the Bottom Camera
199203

200-
Before calibration, the bottom camera and exposure must be set up properly. **We will need to install a nozzle tip and position it above the bottom camera to properly adjust the exposure**.
204+
Before calibration begins, the bottom camera and exposure must be set up properly. **We will need to install a nozzle tip and position it above the bottom camera to properly adjust the exposure**.
201205

202206
!!! tip "Which Reticle should I use?"
203207
We use the "**Ruler**" Reticle in the following steps. If you prefer to use the same **reticle style** that we use, right-click on the **top or bottom camera feed** and choose `Reticle`, then "`Ruler`" to match our docs photos best.<br/><br/>
@@ -232,13 +236,14 @@ Before calibration, the bottom camera and exposure must be set up properly. **We
232236
<br/><br/>
233237

234238
1. **Apply and Verify**
235-
* Click `Apply` to save the **Bottom Camera** settings. One of the red "X"s in the camera feed should disappear. The image might be entirely black, but we'll fix that in the following steps.<br/><br/>
239+
* Click `Apply` to save the **Bottom Camera** settings. One of the red "X"s in the camera feed should disappear. The image might be entirely black, but we'll fix that in the following steps.
240+
* Save your OpenPnP configuration so OpenPnP will remember this when opened. `File > Save Configuration`.<br/><br/>
236241
![Saving changes to the Bottom Camera Config](../../../openpnp/v4/calibration/2-connect-to-machine/images/23-apply-and-save-bottom-cam-settings-gif.gif)
237242
<br/><br/>
238243

239244
---
240245

241-
## Adjust Bottom Camera Exposure
246+
### Adjust Bottom Camera Exposure
242247

243248
!!! warning "Other Camera Settings"
244249
In the following step, **do not** modify any camera settings other than exposure. The default values should remain unchanged.
@@ -285,7 +290,7 @@ Before calibration, the bottom camera and exposure must be set up properly. **We
285290
!!! Warning "🚨 Important 🚨"
286291
The reference image above is just an example. **Your histogram may look very different** depending on lighting conditions, camera placement, and other environmental factors. **Do not try to match it exactly.** Instead, focus on achieving the key characteristics: a distinct peak on the right and a noticeable cluster, or peak, to the left. Adjust gradually until the image is clear and well-exposed.
287292

288-
1. **Set the Correct Exposure**.
293+
1. **Find the Correct Exposure**.
289294
* Adjust the exposure slider, or enter varying manual exposure values, to ensure the camera can clearly detect the dark hole in the nozzle tip for calibration. The exposure should be balanced. Meaning, sbright enough to distinguish the nozzle tip from the background but not so bright that the hole becomes difficult to detect. Aim for a setting where the brightest areas are visible but do not appear completely white, and the darker areas remain well-defined. Use the following images as a reference for adjusting exposure:<br/><br/>
290295
![exposure too high](../../../openpnp/v4/calibration/2-connect-to-machine/images/33-exposure-too-high.webp)<br/><br/>
291296
![exposure too low](../../../openpnp/v4/calibration/2-connect-to-machine/images/34-exposure-too-low.webp)<br/><br/>

docs/misc/calibration/4-homing-fiducial/index.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,11 @@ Now that your bottom camera exposure has been fine-tuned, the same thing needs t
4545

4646
## Preparing for Homing
4747

48+
1. Confirm the following settings before homing the LumenPnP.
49+
* Go to Machine Setup > Heads > ReferenceHead H1 > `Homing Method` is set to `None`
50+
* Go to Machine Setup > Nozzle Tips > ReferenceNozzleTip N045 > Calibration Tab > **Auto Recalibration**: `Manual`
51+
* Go to Machine Setup > Nozzle Tips > ReferenceNozzleTip N24 > Calibration Tab > **Auto Recalibration**: `Manual`
52+
4853
1. **Level the nozzles before homing**.
4954

5055
!!! danger "🚨 Critical Warning: Level Nozzles Before Homing 🚨"
@@ -135,8 +140,6 @@ Now that your bottom camera exposure has been fine-tuned, the same thing needs t
135140

136141
In order for OpenPnP to reliably detect the LumenPnP's homing fiducial, we'll need to **set the exposure and camera settings for your top camera** correctly.
137142

138-
We also detail this process in our [setup video](https://youtu.be/h3mtEQfGMlM?t=842).
139-
140143
1. Navigate to `Machine Setup > Heads > ReferenceHead H1 > Cameras > OpenPnPCaptureCamera Top`.<br/><br/>
141144
![Finding the Top Camera Settings](../../../openpnp/v4/calibration/4-homing-fiducial/images/22-back-to-top-cam-again.webp)
142145
<br/><br/>
@@ -188,7 +191,6 @@ We also detail this process in our [setup video](https://youtu.be/h3mtEQfGMlM?t=
188191

189192
1. If you receive the error `FIDUCIAL-HOME no matches found`, OpenPnP was not able to find your homing fiducial. You need to adjust your [Homing Fiducial Pipeline](../../../openpnp/v4/vision-pipeline-adjustment/2-homing-fiducial-pipeline.md).<br/><br/>
190193
![A first attempt at homing the LumenPnP](../../../openpnp/v4/calibration/4-homing-fiducial/images/33-fiducial-home-no-match-found.webp)
191-
<br/><br/>
192194

193195
---
194196

docs/misc/calibration/5-mm-per-pixel/index.md

Lines changed: 24 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,11 @@
44

55
This next step calibrates the relationship between pixels and millimeters to make our cameras more accurate.
66

7+
The main reason for needing to perform the mm to pixel calibration is to translate pixel data into accurate, real-world measurements (like millimeters). This allows for reliable sizing of objects, quality control, and dimensional analysis in computer vision by correcting for lens distortions and establishing a precise scale factor, which is crucial for tasks needing quantifiable results beyond just visual identification.
8+
79
---
810

9-
## Top Camera Calibration
11+
## Top Camera MM/Pixel Calibration
1012

1113
In this step, we will calibrate the mm/pixels for the **Top Camera**. This requires us to set the dimensions and use a virtual bounding box to outline and measure one of the squares on the datum board, known as a golden guideline square. This allows us to calibrate the **top camera’s Units per pixel**, giving us accurate top camera movement.
1214
<br/><br/>
@@ -59,15 +61,23 @@ In this step, we will calibrate the mm/pixels for the **Top Camera**. This requi
5961
![Save your config now](../../../openpnp/v4/calibration/2-connect-to-machine/images/save-config.webp)
6062
<br/><br/>
6163

62-
1. **Confirm Top Camera Calibration**.
63-
* First, ensure your top camera view is fully zoomed out.
64+
---
65+
66+
## Validate Top Camera Calibration
67+
68+
Lets verify the top camera calibration was successful. This will ensure the top camera's millimeter per pixel is accurate so it is moving the correct amount for a given command.
69+
70+
1. Ensure your top camera view is fully zoomed out.
71+
* Hover over the top camera's feed, and scroll with the mouse wheel or trackpad to zoom all the way out.
72+
73+
1. Confirm top camera is calibrated correctly.
6474
* Click and drag the center reticle (located in the middle of the camera feed) to one of the corners of the Golden Guideline Square.
6575
* If the mm/pixel calibration is correct, the **Top Camera** will move to be precisely over your chosen corner.
6676
![Confirm Top Camera Calibration](../../../openpnp/v4/calibration/5-mm-per-pixel/images/09-confirm-top-cal-is-correct.gif)
6777

6878
---
6979

70-
## Bottom Camera Calibration
80+
## Bottom Camera MM/Pixel Calibration
7181

7282
The following steps will calibrate the mm/pixels for the **Bottom Camera**. This requires us to set the dimensions and use a virtual bounding box to outline the nozzle tip. This allows us to calibrate the **bottom camera’s Units per pixel**, giving us accurate bottom camera movement.
7383

@@ -134,8 +144,16 @@ The following steps will calibrate the mm/pixels for the **Bottom Camera**. This
134144
![Save your config now](../../../openpnp/v4/calibration/2-connect-to-machine/images/save-config.webp)
135145
<br/><br/>
136146

137-
1. **Confirm Bottom Camera Calibration**.
138-
* First, ensure your bottom camera view is fully zoomed out.
147+
---
148+
149+
## Validate Bottom Camera MM/Pixel Calibration
150+
151+
Lets verify the bottom camera calibration was successful. This will ensure the bottom camera's millimeter per pixel is accurate so it is moving the correct amount for a given command.
152+
153+
1. Ensure your bottom camera view is fully zoomed out.
154+
* Hover over the top camera's feed, and scroll with the mouse wheel or trackpad to zoom all the way out.
155+
156+
1. Confirm bottom camera is calibrated correctly.
139157
* Click and drag the center reticle (located in the middle of the camera feed) to the edge of the nozzle tip and then back to the center of the tip.
140158
* The **Bottom Camera** should now be centered on the nozzle tip again.<br/><br/>
141159
![Test your Bottom camera Units Per Pixel](../../../openpnp/v4/calibration/5-mm-per-pixel/images/20-testing-bottom-cam-units-per-pixel.gif)<br/><br/>

0 commit comments

Comments
 (0)