Package org.openpnp.util

Class Cycles

  • public class Cycles
extends java.lang.Object

    • Constructor Summary

      Constructors 
      Constructor Description
      Cycles()  

    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static void discard​(Nozzle nozzle)
      Discard the Part, if any, on the given Nozzle.
      static void discardAlways​(Nozzle nozzle)
      Discard the Part on the given Nozzle.
      static Location zProbe​(Location l)
      Performs a Z Probe canned cycle if a Z Probe actuator name is defined on the default head.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • Cycles

        public Cycles()

    • Method Detail

      • zProbe

        public static Location zProbe​(Location l)
                       throws java.lang.Exception
        Performs a Z Probe canned cycle if a Z Probe actuator name is defined on the default head. If none is defined, null is returned. The cycle is as follows: 1. Move the Z Probe actuator to the specified location, respecting head offsets. 2. Perform an Actuator.read() and parse the result as a Double in Millimeters. 3. Move back to the location the zProbe was at before the call. 4. Return a Location that matches the passed in location in X, Y, and Rotation with the Z value set to that of the probe. Note that currently the Z Probe is expected to return millimeters. This can be made configurable in the future.
        Parameters:
        l -
        Returns:
        Throws:
        java.lang.Exception

      • discard

        public static void discard​(Nozzle nozzle)
                    throws java.lang.Exception
        Discard the Part, if any, on the given Nozzle. The Nozzle is returned to Safe Z at the end of the operation.
        Parameters:
        nozzle -
        Throws:
        java.lang.Exception

      • discardAlways

        public static void discardAlways​(Nozzle nozzle)
                          throws java.lang.Exception
        Discard the Part on the given Nozzle. Perform the discard action whether there is a part on the nozzle or not. The Nozzle is returned to Safe Z at the end of the operation.
        Parameters:
        nozzle -
        Throws:
        java.lang.Exception