Skip to content

octoprint.printer.profile#

This module contains printer profile related code.

A printer profile is a dict of the following structure:

.. list-table:: :widths: 15 5 30 :header-rows: 1

    • Name
    • Type
    • Description
    • id
    • string
    • Internal id of the printer profile
    • name
    • string
    • Human readable name of the printer profile
    • model
    • string
    • Printer model
    • color
    • string
    • Color to associate with the printer profile
    • volume
    • dict
    • Information about the print volume
    • volume.width
    • float
    • Width of the print volume (X axis)
    • volume.depth
    • float
    • Depth of the print volume (Y axis)
    • volume.height
    • float
    • Height of the print volume (Z axis)
    • volume.formFactor
    • string
    • Form factor of the print bed, either rectangular or circular
    • volume.origin
    • string
    • Location of gcode origin in the print volume, either lowerleft or center
    • volume.custom_box
    • dict or False
    • Custom boundary box overriding the default bounding box based on the provided width, depth, height and origin. If False, the default boundary box will be used.
    • volume.custom_box.x_min
    • float
    • Minimum valid X coordinate
    • volume.custom_box.y_min
    • float
    • Minimum valid Y coordinate
    • volume.custom_box.z_min
    • float
    • Minimum valid Z coordinate
    • volume.custom_box.x_max
    • float
    • Maximum valid X coordinate
    • volume.custom_box.y_max
    • float
    • Maximum valid Y coordinate
    • volume.custom_box.z_max
    • float
    • Maximum valid Z coordinate
    • heatedBed
    • bool
    • Whether the printer has a heated bed (True) or not (False)
    • heatedChamber
    • bool
    • Whether the printer has a heated chamber (True) or not (False)
    • extruder
    • dict
    • Information about the printer's extruders
    • extruder.count
    • int
    • How many extruders the printer has (default 1)
    • extruder.offsets
    • list of tuple
    • Extruder offsets relative to first extruder, list of (x, y) tuples, first is always (0,0)
    • extruder.nozzleDiameter
    • float
    • Diameter of the printer nozzle(s)
    • extruder.sharedNozzle
    • boolean
    • Whether there's only one nozzle shared among all extruders (true) or one nozzle per extruder (false).
    • extruder.defaultExtrusionLength
    • int
    • Default extrusion length used in Control tab on initial page load in mm.
    • axes
    • dict
    • Information about the printer axes
    • axes.x
    • dict
    • Information about the printer's X axis
    • axes.x.speed
    • float
    • Speed of the X axis in mm/min
    • axes.x.inverted
    • bool
    • Whether a positive value change moves the nozzle away from the print bed's origin (False, default) or towards it (True)
    • axes.y
    • dict
    • Information about the printer's Y axis
    • axes.y.speed
    • float
    • Speed of the Y axis in mm/min
    • axes.y.inverted
    • bool
    • Whether a positive value change moves the nozzle away from the print bed's origin (False, default) or towards it (True)
    • axes.z
    • dict
    • Information about the printer's Z axis
    • axes.z.speed
    • float
    • Speed of the Z axis in mm/min
    • axes.z.inverted
    • bool
    • Whether a positive value change moves the nozzle away from the print bed (False, default) or towards it (True)
    • axes.e
    • dict
    • Information about the printer's E axis
    • axes.e.speed
    • float
    • Speed of the E axis in mm/min
    • axes.e.inverted
    • bool
    • Whether a positive value change extrudes (False, default) or retracts (True) filament

.. autoclass:: PrinterProfileManager :members:

.. autoclass:: BedFormFactor :members:

.. autoclass:: BedOrigin :members:

.. autoclass:: SaveError

.. autoclass:: CouldNotOverwriteError

.. autoclass:: InvalidProfileError

BedTypes = BedFormFactor module-attribute #

Deprecated name of :class:BedFormFactors

BedFormFactor #

Valid values for bed form factor

CIRCULAR = 'circular' class-attribute #

Circular bed

RECTANGULAR = 'rectangular' class-attribute #

Rectangular bed

BedOrigin #

Valid values for bed origin

CENTER = 'center' class-attribute #

Origin at the center of the bed when looking from top

LOWERLEFT = 'lowerleft' class-attribute #

Origin at lower left corner of the bed when looking from the top

CouldNotOverwriteError #

Bases: SaveError

Overwriting of a profile not allowed

InvalidProfileError #

Bases: Exception

Profile invalid

PrinterProfileManager #

Manager for printer profiles. Offers methods to select the globally used printer profile and to list, add, remove, load and save printer profiles.

SaveError #

Bases: Exception

Saving a profile failed

Back to top