Skip to main content

getPrinterStatus

Before v4.0, this method was called getStatus.

Get the current status of a printer.

Parameter​

KeyTypeDescription
printerstringPrinter ID.

Return value​

A Status object with the following keys:

KeyTypeDescription
statestringSee getPrinterState.
ragStatusstringRED, AMBER or GREEN.
errorsarray of stringsEmpty if there are no errors.
inkarray of InkStatusSee below.
positionnumberCurrent position in meters. Present only when known.
speednumberCurrent speed in meters per second. Present only when known.
notificationsarray of NotificationRaised notifications about the printer or the whole machine, see below. v6.0
notificationRagStatusstringThe worst rag of the notifications: RED, AMBER or GREEN. GREEN if there are none. v6.0

A printer's ragStatus reflects only the printer itself. Notifications are raised by software, such as extensions, and have their own notificationRagStatus and GPIO signals. A Notification object has the following keys:

KeyTypeDescription
ownerstringWho raised the notification, e.g. the name of an extension.
keystringIdentifies the notification among those of its owner.
messagestringThe text of the notification.
ragstringRED, AMBER or GREEN.
printerstringThe printer the notification is about. Absent if it is about the whole machine.
dismissablebooleanPresent and true if the operator may dismiss the notification.

For Marvin1 and Blade v6.0 printers, an InkStatus object has the following keys:

KeyTypeDescription
statestringSTOPPED, STANDBY, PREHEATING, STARTING, HEATING, STARTED, STOPPING, FILLING, EMPTYING, MANUAL, SELF_TEST, or ERROR.
ragStatusstringRED, AMBER or GREEN.
levelstringEMPTY, LOW, or OK. Present only when known.
reserveLevelnumberLevel of the ink reserve, from 0 to 1. Present only when known. v6.0
bulkSupplyIDstringID of the bulk supply that refills the ink supply. Present only for an ink supply fed by a bulk supply. v6.0
bulkStatestringState of the bulk supply that refills the ink supply, with the same values as state. Present only for an ink supply fed by a bulk supply. v6.0
errorsarray of stringsEmpty if there are no errors.
faultsarray of stringsFaults of the ink supply module, such as moduleMissing. Empty if there are none. v6.0
warningsarray of stringsEmpty if there are no warnings.

An ink supply fed by a bulk supply is at least AMBER while the bulk supply is not GREEN, since it then prints from its reserve.

Before v6.0, state could also be CALIBRATING.

For TIJ1 printers, an InkStatus object instead has the following keys:

KeyTypeDescription
phStatestringPrinthead state.
crtStatestringCartridge state.
ragStatusstringRED, AMBER or GREEN.
inkLevelnumberCartridge ink level. Present only when known.
inkLowbooleanWhether the cartridge ink is low. Present only when known.