Skip to main content

getPrinterStatus

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.

For Marvin1 printers, an InkStatus object has the following keys:

KeyTypeDescription
statestringSTOPPED, STANDBY, STARTING, STARTED, STOPPING, CALIBRATING, FILLING, EMPTYING, MANUAL, or ERROR.
ragStatusstringRED, AMBER or GREEN.
levelstringEMPTY, LOW, or OK. Present only when known.
errorsarray of stringsEmpty if there are no errors.
warningsarray of stringsEmpty if there are no warnings.

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.