octoprint.printer

This module defines the interface for communicating with a connected printer.

The communication is in fact divided in two components, the PrinterInterface and a deeper lying communication layer. However, plugins should only ever need to use the PrinterInterface as the abstracted version of the actual printer communication.

octoprint.printer.get_connection_options(): Deprecated since version 1.3.0: Replaced by PrinterInterface.get_connection_options()

class octoprint.printer.PrinterInterface

The PrinterInterface represents the developer interface to the Printer instance.

can_modify_file(path, sd, *args, **kwargs)

Determines whether the path (on the printer’s SD if sd is True) may be modified (updated or deleted) or not.

A file that is currently being printed is not allowed to be modified. Any other file or the current file when it is not being printed is fine though.

Since: 1.3.2

Warning

This was introduced in 1.3.2 to work around an issue when updating a file that is already selected. I’m not 100% sure at this point if this is the best approach to solve this issue, so if you decide to depend on this particular method in this interface, be advised that it might vanish in future versions!

Parameters

path (str) – path in storage of the file to check
sd (bool) – True if to check against SD storage, False otherwise

Returns

(bool) True if the file may be modified, False otherwise

cancel_print(tags=None, *args, **kwargs)

Cancels the current print job.

Parameters: tags (set of str) – An optional set of tags to attach to the command(s) throughout their lifecycle

change_tool(tool, tags=None, *args, **kwargs)

Switch the currently active tool (for which extrude commands will apply).

Parameters

tool (str) – The tool to switch to, matching the regex “tool[0-9]+” (e.g. “tool0”, “tool1”, …)
tags (set of str) – An optional set of tags to attach to the command(s) throughout their lifecycle

commands(commands, tags=None, force=False, *args, **kwargs)

Sends the provided commands to the printer.

Parameters

commands (str, list) – The commands to send. Might be a single command provided just as a string or a list of multiple commands to send in order.
tags (set of str) – An optional set of tags to attach to the command(s) throughout their lifecycle
force (bool) – Whether to force sending of the command right away or allow queuing while printing

connect(port=None, baudrate=None, profile=None, *args, **kwargs)

Connects to the printer, using the specified serial port, baudrate and printer profile. If a connection is already established, that connection will be closed prior to connecting anew with the provided parameters.

Parameters

port (str) – Name of the serial port to connect to. If not provided, an auto detection will be attempted.
baudrate (int) – Baudrate to connect with. If not provided, an auto detection will be attempted.
profile (str) – Name of the printer profile to use for this connection. If not provided, the default will be retrieved from the PrinterProfileManager.

disconnect(*args, **kwargs): Disconnects from the printer. Does nothing if no connection is currently established.

extrude(amount, speed=None, tags=None, *args, **kwargs)

Extrude amount millimeters of material from the tool.

Parameters

amount (int, float) – The amount of material to extrude in mm
speed (int, None) – Speed at which to extrude (F parameter). If set to None (or left out)
used. (the maximum speed of E axis from the printer profile will be) –
tags (set of str) – An optional set of tags to attach to the command(s) throughout their lifecycle

fake_ack(*args, **kwargs): Fakes an acknowledgment for the communication layer. If the communication between OctoPrint and the printer gets stuck due to lost “ok” responses from the server due to communication issues, this can be used to get things going again.

feed_rate(factor, tags=None, *args, **kwargs)

Sets the factor for the printer’s feed rate.

Parameters

factor (int, float) – The factor for the feed rate to send to the firmware. Percentage expressed as either an int between 0 and 100 or a float between 0 and 1.
tags (set of str) – An optional set of tags to attach to the command(s) throughout their lifecycle

flow_rate(factor, tags=None, *args, **kwargs)

Sets the factor for the printer’s flow rate.

Parameters

factor (int, float) – The factor for the flow rate to send to the firmware. Percentage expressed as either an int between 0 and 100 or a float between 0 and 1.
tags (set of str) – An optional set of tags to attach to the command(s) throughout their lifecycle

classmethod get_connection_options(*args, **kwargs)

Retrieves the available ports, baudrates, preferred port and baudrate for connecting to the printer.

Returned dict has the following structure:

ports: <list of available serial ports>
baudrates: <list of available baudrates>
portPreference: <configured default serial port>
baudratePreference: <configured default baudrate>
autoconnect: <whether autoconnect upon server startup is enabled or not>

Returns: A dictionary holding the connection options in the structure specified above
Return type: (dict)

get_current_connection(*args, **kwargs)

Returns

(tuple) The current connection information as a 4-tuple (connection_string, port, baudrate, printer_profile).: If the printer is currently not connected, the tuple will be ("Closed", None, None, None).

get_current_data(*args, **kwargs)

Returns: (dict) The current state data.

get_current_job(*args, **kwargs)

Returns: (dict) The data of the current job.

get_current_temperatures(*args, **kwargs)

Returns: (dict) The current temperatures.

get_state_id(*args, **kwargs)

Identifier of the current communication state.

Possible values are:

OPEN_SERIAL

DETECT_SERIAL

DETECT_BAUDRATE

CONNECTING

OPERATIONAL

PRINTING

PAUSED

CLOSED

ERROR

CLOSED_WITH_ERROR

TRANSFERING_FILE

OFFLINE

UNKNOWN

NONE

Returns: (str) A unique identifier corresponding to the current communication state.

get_state_string(*args, **kwargs)

Returns: (str) A human readable string corresponding to the current communication state.

get_temperature_history(*args, **kwargs)

Returns: (list) The temperature history.

get_transport(*args, **kwargs)

Returns the communication layer’s transport object, if a connection is currently established.

Note that this doesn’t have to necessarily be a serial.Serial instance, it might also be something different, so take care to do instance checks before attempting to access any properties or methods.

Returns: The communication layer’s transport object
Return type: object

home(axes, tags=None, *args, **kwargs)

Homes the specified printer axes.

Parameters

axes (str, list) – The axis or axes to home, each of which must converted to lower case must match one of “x”, “y”, “z” and “e”
tags (set of str) – An optional set of tags to attach to the command(s) throughout their lifecycle

is_cancelling(*args, **kwargs)

Returns: (boolean) Whether the printer is currently cancelling a print.

is_closed_or_error(*args, **kwargs)

Returns: (boolean) Whether the printer is currently disconnected and/or in an error state.

is_current_file(path, sd, *args, **kwargs)

Returns whether the provided path (on the printer’s SD if sd is True) is the currently selected file for printing.

Since: 1.3.2

Warning

This was introduced in 1.3.2 to work around an issue when updating a file that is already selected. I’m not 100% sure at this point if this is the best approach to solve this issue, so if you decide to depend on this particular method in this interface, be advised that it might vanish in future versions!

Parameters

path (str) – path in storage of the file to check
sd (bool) – True if to check against SD storage, False otherwise

Returns

(bool) True if the file is currently selected, False otherwise

is_error(*args, **kwargs)

Returns: (boolean) Whether the printer is currently in an error state.

is_operational(*args, **kwargs)

Returns: (boolean) Whether the printer is currently connected and available.

is_paused(*args, **kwargs)

Returns: (boolean) Whether the printer is currently paused.

is_pausing(*args, **kwargs)

Returns: (boolean) Whether the printer is currently pausing a print.

is_printing(*args, **kwargs)

Returns: (boolean) Whether the printer is currently printing.

is_ready(*args, **kwargs)

Returns: (boolean) Whether the printer is currently operational and ready for new print jobs (not printing).

job_on_hold(blocking=True, *args, **kwargs)

Contextmanager that allows executing code while printing while making sure that no commands from the file being printed are continued to be sent to the printer. Note that this will only work for local files, NOT SD files.

Example:

with printer.job_on_hold():
    park_printhead()
    take_snapshot()
    send_printhead_back()

It should be used sparingly and only for very specific situations (such as parking the print head somewhere, taking a snapshot from the webcam, then continuing). If you abuse this, you WILL cause print quality issues!

A lock is in place that ensures that the context can only actually be held by one thread at a time. If you don’t want to block on acquire, be sure to set blocking to False and catch the RuntimeException thrown if the lock can’t be acquired.

Parameters: blocking (bool) – Whether to block while attempting to acquire the lock (default) or not

jog(axes, relative=True, speed=None, tags=None, *args, **kwargs)

Jogs the specified printer axis by the specified amount in mm.

Parameters

axes (dict) – Axes and distances to jog, keys are axes (“x”, “y”, “z”), values are distances in mm
relative (bool) – Whether to interpret the distance values as relative (true, default) or absolute (false) coordinates
speed (int, bool or None) – Speed at which to jog (F parameter). If set to False no speed will be set specifically. If set to None (or left out) the minimum of all involved axes speeds from the printer profile will be used.
tags (set of str) – An optional set of tags to attach to the command(s) throughout their lifecycle

log_lines(*lines): Logs the provided lines to the printer log and serial.log :param *lines: the lines to log

pause_print(tags=None, *args, **kwargs)

Pauses the current print job if it is currently running, does nothing otherwise.

Parameters: tags (set of str) – An optional set of tags to attach to the command(s) throughout their lifecycle

register_callback(callback, *args, **kwargs)

Registers a PrinterCallback with the instance.

Parameters: callback (PrinterCallback) – The callback object to register.

resume_print(tags=None, *args, **kwargs)

Resumes the current print job if it is currently paused, does nothing otherwise.

Parameters: tags (set of str) – An optional set of tags to attach to the command(s) throughout their lifecycle

script(name, context=None, tags=None, *args, **kwargs)

Sends the GCODE script name to the printer.

The script will be run through the template engine, the rendering context can be extended by providing a context with additional template variables to use.

If the script is unknown, an UnknownScriptException will be raised.

Parameters

name (str) – The name of the GCODE script to render.
context (dict) – An optional context of additional template variables to provide to the renderer.
tags (set of str) – An optional set of tags to attach to the command(s) throughout their lifecycle

Raises

UnknownScriptException – There is no GCODE script with name name

select_file(path, sd, printAfterSelect=False, pos=None, tags=None, *args, **kwargs)

Selects the specified path for printing, specifying if the file is to be found on the sd or not. Optionally can also directly start the print after selecting the file.

Parameters

path (str) – The path to select for printing. Either an absolute path or relative path to a local file in the uploads folder or a filename on the printer’s SD card.
sd (boolean) – Indicates whether the file is on the printer’s SD card or not.
printAfterSelect (boolean) – Indicates whether a print should be started after the file is selected.
tags (set of str) – An optional set of tags to attach to the command(s) throughout their lifecycle

Raises

InvalidFileType – if the file is not a machinecode file and hence cannot be printed
InvalidFileLocation – if an absolute path was provided and not contained within local storage or doesn’t exist

send_initial_callback(callback)

Sends the initial printer update to PrinterCallback.

Parameters: callback (PrinterCallback) – The callback object to send initial data to.

set_job_on_hold(value, blocking=True, *args, **kwargs)

Setter for finer control over putting jobs on hold. Set to True to ensure that no commands from the file being printed are continued to be sent to the printer. Set to False to resume. Note that this will only work for local files, NOT SD files.

Make absolutely sure that if you set this flag, you will always also unset it again. If you don’t, the job will be stuck forever.

Example:

if printer.set_job_on_hold(True):
    try:
        park_printhead()
        take_snapshot()
        send_printhead_back()
    finally:
        printer.set_job_on_hold(False)

Just like job_on_hold() this should be used sparingly and only for very specific situations. If you abuse this, you WILL cause print quality issues!

Parameters

value (bool) – The value to set
blocking (bool) – Whether to block while attempting to set the value (default) or not

Returns

(bool) Whether the value could be set successfully (True) or a timeout was encountered (False)

set_temperature(heater, value, tags=None, *args, **kwargs)

Sets the target temperature on the specified heater to the given value in celsius.

Parameters

heater (str) – The heater for which to set the target temperature. Either “bed” for setting the bed temperature, “chamber” for setting the temperature of the heated enclosure or something matching the regular expression “tool[0-9]+” (e.g. “tool0”, “tool1”, …) for the hotends of the printer. However, addressing components that are disabled or unconfigured in the printer profile will result in a “Suppressed command” error popup message.
value (int, float) – The temperature in celsius to set the target temperature to.
tags (set of str) – An optional set of tags to attach to the command(s) throughout their lifecycle.

set_temperature_offset(offsets=None, tags=None, *args, **kwargs)

Sets the temperature offsets to apply to target temperatures read from a GCODE file while printing.

Parameters

offsets (dict) – A dictionary specifying the offsets to apply. Keys must match the format for the heater parameter to set_temperature(), so “bed” for the offset for the bed target temperature and “tool[0-9]+” for the offsets to the hotend target temperatures.
tags (set of str) – An optional set of tags to attach to the command(s) throughout their lifecycle

start_print(tags=None, *args, **kwargs)

Starts printing the currently selected file. If no file is currently selected, does nothing.

Parameters: tags (set of str) – An optional set of tags to attach to the command(s) throughout their lifecycle

toggle_pause_print(tags=None, *args, **kwargs)

Pauses the current print job if it is currently running or resumes it if it is currently paused.

Parameters: tags (set of str) – An optional set of tags to attach to the command(s) throughout their lifecycle

unregister_callback(callback, *args, **kwargs)

Unregisters a PrinterCallback from the instance.

Parameters: callback (PrinterCallback) – The callback object to unregister.

unselect_file(*args, **kwargs): Unselects and currently selected file.

valid_axes = ('x', 'y', 'z', 'e'): Valid axes identifiers.

valid_heater_regex = re.compile('^(tool\\d+|bed|chamber)$'): Regex for valid heater identifiers.

valid_tool_regex = re.compile('^(tool\\d+)$'): Regex for valid tool identifiers.

class octoprint.printer.PrinterCallback

on_printer_add_log(data)

Called when the PrinterInterface receives a new communication log entry from the communication layer.

Parameters: data (str) – The received log line.

on_printer_add_message(data)

Called when the PrinterInterface receives a new message from the communication layer.

Parameters: data (str) – The received message.

on_printer_add_temperature(data)

Called when the PrinterInterface receives a new temperature data set from the communication layer.

data is a dict of the following structure:

tool0:
    actual: <temperature of the first hotend, in degC>
    target: <target temperature of the first hotend, in degC>
...
bed:
    actual: <temperature of the bed, in degC>
    target: <target temperature of the bed, in degC>
chamber:
    actual: <temperature of the chamber, in degC>
    target: <target temperature of the chamber, in degC>

Parameters: data (dict) – A dict of all current temperatures in the format as specified above

on_printer_received_registered_message(name, output)

Called when the PrinterInterface received a registered message, e.g. from a feedback command.

Parameters

name (str) – Name of the registered message (e.g. the feedback command)
output (str) – Output for the registered message

on_printer_send_current_data(data)

Called when the internal state of the PrinterInterface changes, due to changes in the printer state, temperatures, log lines, job progress etc. Updates via this method are guaranteed to be throttled to a maximum of 2 calls per second.

data is a dict of the following structure:

state:
    text: <current state string>
    flags:
        operational: <whether the printer is currently connected and responding>
        printing: <whether the printer is currently printing>
        closedOrError: <whether the printer is currently disconnected and/or in an error state>
        error: <whether the printer is currently in an error state>
        paused: <whether the printer is currently paused>
        ready: <whether the printer is operational and ready for jobs>
        sdReady: <whether an SD card is present>
job:
    file:
        name: <name of the file>,
        size: <size of the file in bytes>,
        origin: <origin of the file, "local" or "sdcard">,
        date: <last modification date of the file>
    estimatedPrintTime: <estimated print time of the file in seconds>
    lastPrintTime: <last print time of the file in seconds>
    filament:
        length: <estimated length of filament needed for this file, in mm>
        volume: <estimated volume of filament needed for this file, in ccm>
progress:
    completion: <progress of the print job in percent (0-100)>
    filepos: <current position in the file in bytes>
    printTime: <current time elapsed for printing, in seconds>
    printTimeLeft: <estimated time left to finish printing, in seconds>
currentZ: <current position of the z axis, in mm>
offsets: <current configured temperature offsets, keys are "bed" or "tool[0-9]+", values the offset in degC>

Parameters: data (dict) – The current data in the format as specified above.

on_printer_send_initial_data(data)

Called when registering as a callback with the PrinterInterface to receive the initial data (state, log and temperature history etc) from the printer.

data is a dict of the following structure:

temps:
  - time: <timestamp of the temperature data point>
    tool0:
        actual: <temperature of the first hotend, in degC>
        target: <target temperature of the first hotend, in degC>
    ...
    bed:
        actual: <temperature of the bed, in degC>
        target: <target temperature of the bed, in degC>
  - ...
logs: <list of current communication log lines>
messages: <list of current messages from the firmware>

Parameters: data (dict) – The initial data in the format as specified above.

octoprint.printer.profile

This module contains printer profile related code.

A printer profile is a dict of the following structure:

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

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

class octoprint.printer.profile.BedFormFactor

Valid values for bed form factor

CIRCULAR = 'circular': Circular bed

RECTANGULAR = 'rectangular': Rectangular bed

class octoprint.printer.profile.BedOrigin

Valid values for bed origin

CENTER = 'center': Origin at the center of the bed when looking from top

LOWERLEFT = 'lowerleft': Origin at lower left corner of the bed when looking from the top

class octoprint.printer.profile.SaveError: Saving a profile failed

class octoprint.printer.profile.CouldNotOverwriteError: Overwriting of a profile not allowed

class octoprint.printer.profile.InvalidProfileError: Profile invalid