Skip to content

Setup and Calibration

markmaker edited this page Feb 26, 2024 · 32 revisions

Setup and Calibration

This will guide you through the process of setting up a new machine to work with OpenPnP. Since every machine is different you may find that not every part of this document is applicable to your machine, but it should provide a good starting point for getting your machine up and running.

Follow the Issues & Solutions System

In recent versions of OpenPnP, the Issues and Solutions system can guide you through most of the machine setup process. The system already covers most of the difficult configuration steps, more are continuously being added. Many of the suggested solutions are automatic, or can be configured interactively, some even with graphical guidance:

Nozzle Solutions

Whenever OpenPnP starts up, or when you press Find Issues & Solutions, it will scan your configuration for any issues and solutions. A notifier dot will appear on the tab, when unresolved items are present. The system is very flexible, you can skip over steps and proceed to the next. OpenPnP will keep monitoring your configuration and list issues as long as unsolved. It will also detect issues if they are (re-) introduced later.

Consider the Issues and Solutions system as a more up-to-date/smarter alternative to the Table of Contents of this Wiki. Instead of working linearly through this document, follow Issues and Solutions and then use the blue information buttons to link back to this Wiki for details.

To get an impression, before you even start, watch the following videos. Note: they only cover a small subset of the available solutions, and they're already a bit outdated, i.e., Issues & Solutions has since evolved to be even better:


NOTE: The Wiki still contains information for many of the older versions of OpenPnP and/or legacy ways of setting things up manually, including hacking the machine.xml. It is no longer recommended to do so!

The following is left for older versions of OpenPnP, and for those steps and use cases that are not yet covered by Issues and Solutions.


You should follow the steps in the order they are listed in this guide since many of the steps depend on previous steps.

  1. Before You Start
  2. Machine Setup
  3. Driver Setup
  4. Axes Setup
  5. Top Camera Setup
  6. Steps Per Mm
  7. Nozzle Setup
  8. Actuators
  9. Vacuum Setup
  10. Bottom Camera Setup
  11. Park Location
  12. Discard Location
  13. Feeders
  14. Bottom Vision
  15. Vacuum Sensing
  16. Camera Lighting
  17. Next Steps

Previous Step Jump To Next Step
Table of Contents Before You Start
Clone this wiki locally