Printer states and state categories

The /printer-states endpoint reports both a raw printer state and a high-level state category. Use the tables in this topic to understand which raw states roll up into which categories.

About printer states and categories

For each printer engine, the Data Export API reports two related values:

printerState
The raw operating state reported by the printer engine, such as printing, sleeping, or maintenance. The set of raw states varies by printer model.
stateCategory
A high-level grouping that classifies the raw state as up, down, idle, or unknown. Categories are consistent across printer models, so they are the better choice for dashboards and reports that aggregate data from multiple printers.

The category assignments are defined by RICOH Predictive Insight and apply uniformly to every printer reporting through the Data Export API.

Up states

An engine is reported as up when it is actively producing output or actively preparing to produce output. Use this category to measure productive operating time.

Raw printer state Description
feeding The engine is feeding media in preparation for printing.
initializing The engine is initializing as part of starting a print operation.
preparing The engine is preparing to print, for example by loading job data or warming components for an imminent job.
printing The engine is printing.
processing The engine is processing job data.
receiving The engine is receiving a job from the print server.

Down states

An engine is reported as down when it cannot print and operator or service intervention, maintenance, or recovery is required or in progress. Use this category to measure unplanned and planned downtime.

Raw printer state Description
adjusting The engine is performing an adjustment operation that prevents printing.
calibrating The engine is calibrating, for example for color or registration.
cleaning The engine is performing a cleaning operation.
disconnected The engine has lost its connection to RICOH Predictive Insight.
error The engine has reported an error condition that prevents printing.
maintenance The engine is performing a maintenance operation.
not available The engine is reachable but cannot accept work at this time.
pre/post busy A pre- or post-processing device attached to the engine is busy and is blocking printing.
pre/post eof A pre- or post-processing device has reached an end-of-form condition that is blocking printing.
pre/post paused A pre- or post-processing device is paused and is blocking printing.
pre/post threading A pre- or post-processing device is threading media and is blocking printing.
rebooting The engine is rebooting.
recirculation The engine is recirculating ink.
restart The engine is in a restart condition.
restarting The engine is restarting.

Idle states

An engine is reported as idle when it is operational and able to print but is not currently producing output. Use this category to measure available capacity.

Raw printer state Description
checking The engine is performing a routine check that does not block work.
idle The engine is operational and waiting for work.
not ready The engine is operational but is not currently in a ready-to-print state.
pre/post not ready A pre- or post-processing device is not ready, but the engine itself is operational.
ready The engine is ready to accept and print a job.
shutdown The engine has been shut down.
shutting down The engine is in the process of shutting down.
sleeping The engine is in a low-power sleep state.
start-up The engine is in a start-up phase.
started The engine has completed its start-up sequence.
starting The engine is starting.
stopping The engine is stopping but has not yet shut down.
warming The engine is warming up.

Unknown

The category unknown is reported when RICOH Predictive Insight cannot determine a category for the raw state, for example because the raw state value is not recognized. If your application encounters unknown categories regularly, contact your representative to confirm that your printer is reporting expected state values.