getPrinterStatus
Before v4.0, this method was called getStatus.
Get the current status of a printer.
Parameter
| Key | Type | Description |
|---|---|---|
| printer | string | Printer ID. |
Return value
A Status object with the following keys:
| Key | Type | Description |
|---|---|---|
| state | string | See getPrinterState. |
| ragStatus | string | RED, AMBER or GREEN. |
| errors | array of strings | Empty if there are no errors. |
| ink | array of InkStatus | See below. |
| position | number | Current position in meters. Present only when known. |
| speed | number | Current speed in meters per second. Present only when known. |
| notifications | array of Notification | Raised notifications about the printer or the whole machine, see below. v6.0 |
| notificationRagStatus | string | The 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:
| Key | Type | Description |
|---|---|---|
| owner | string | Who raised the notification, e.g. the name of an extension. |
| key | string | Identifies the notification among those of its owner. |
| message | string | The text of the notification. |
| rag | string | RED, AMBER or GREEN. |
| printer | string | The printer the notification is about. Absent if it is about the whole machine. |
| dismissable | boolean | Present and true if the operator may dismiss the notification. |
For Marvin1 and Blade v6.0 printers, an InkStatus object has the following keys:
| Key | Type | Description |
|---|---|---|
| state | string | STOPPED, STANDBY, PREHEATING, STARTING, HEATING, STARTED, STOPPING, FILLING, EMPTYING, MANUAL, SELF_TEST, or ERROR. |
| ragStatus | string | RED, AMBER or GREEN. |
| level | string | EMPTY, LOW, or OK. Present only when known. |
| reserveLevel | number | Level of the ink reserve, from 0 to 1. Present only when known. v6.0 |
| bulkSupplyID | string | ID of the bulk supply that refills the ink supply. Present only for an ink supply fed by a bulk supply. v6.0 |
| bulkState | string | State 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 |
| errors | array of strings | Empty if there are no errors. |
| faults | array of strings | Faults of the ink supply module, such as moduleMissing. Empty if there are none. v6.0 |
| warnings | array of strings | Empty 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:
| Key | Type | Description |
|---|---|---|
| phState | string | Printhead state. |
| crtState | string | Cartridge state. |
| ragStatus | string | RED, AMBER or GREEN. |
| inkLevel | number | Cartridge ink level. Present only when known. |
| inkLow | boolean | Whether the cartridge ink is low. Present only when known. |