Interface Gantry

Represents a physical gantry that exists in three-dimensional space.

Hierarchy

Implemented by

Properties

doCommand getLengths getPosition home isMoving moveToPosition stop

Properties

doCommand

doCommand: ((command: StructType) => Promise<StructType>)

Type declaration

getLengths

getLengths: ((extra?: StructType) => Promise<number[]>)

Type declaration

    • (extra?: StructType): Promise<number[]>

    • Returns

      The lengths of the axes of the gantry in millimeters.

      Parameters

      Returns Promise<number[]>

getPosition

getPosition: ((extra?: StructType) => Promise<number[]>)

Type declaration

    • (extra?: StructType): Promise<number[]>

    • Returns

      The current position of each axis.

      Parameters

      Returns Promise<number[]>

home

home: ((extra?: StructType) => Promise<boolean>)

Type declaration

    • (extra?: StructType): Promise<boolean>

    • Runs the homing sequence to find the start and end positions of the gantry axis.

      Returns

      A bool representing whether the gantry has run the homing sequence successfully.

      Parameters

      Returns Promise<boolean>

isMoving

isMoving: (() => Promise<boolean>)

Type declaration

    • (): Promise<boolean>

    • Get if the gantry is currently moving.

      Returns Promise<boolean>

moveToPosition

moveToPosition: ((positionsMm: number[], speedsMmPerSec: number[], extra?: StructType) => Promise<void>)

Type declaration

    • (positionsMm: number[], speedsMmPerSec: number[], extra?: StructType): Promise<void>

    • Move each axis of the gantry to the positionsMm at the speeds in speedsMmPerSec

      Parameters

      • positionsMm: number[]

        The goal positions for each axis of the gantry.

      • speedsMmPerSec: number[]

        The desired speed for each axis to move to the respective position in positionsMm.

      • Optional extra: StructType

      Returns Promise<void>

stop

stop: ((extra?: StructType) => Promise<void>)

Type declaration

    • (extra?: StructType): Promise<void>

    • Stops the motion of the gantry.

      Parameters

      Returns Promise<void>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc