Reserved Keys for Detailed Status for Epson Devices
The following reserved keys can be used to refer to detailed device data retrieved from an Epson ESC/Label device by using a detailedDeviceStatus or detailedDeviceInfo business rule component. For examples, see Retrieve Detailed Device Status (XML).
Important! The detailedDeviceStatus and detailedDeviceInfo business rule components are supported for use only with Avery Dennison, cab, Datamax-O'Neil, Epson, Intermec IPL, Loftware, NOVEXX Solutions, PCL, Printronix, QuickLabel, SATO, Toshiba, and Zebra devices.
Important! Content in a business rule is case sensitive. This includes business rule component names, attributes, and values.
Device Status Data
The following reserved keys can be used to refer to detailed device data retrieved from an Epson device by using a detailedDeviceStatus business rule component.
| Reserved Key | Description |
|---|---|
| DDS_BUFFERFULL |
Whether all of the device's internal memory is in use. No more jobs can be sent until some internal memory is freed for use. true: All memory is in use false: Some memory is free |
| DDS_COVEROPEN |
Whether the cover of the device is open. true: Open false: Closed |
| DDS_GRAPHICSCOUNT |
The number of images stored in the memory of the device. |
| DDS_LABELLENGTH |
The length in dots of media for which the device is configured. |
| DDS_LABELSINBUFFER | For the current job, the number of labels in the receive buffer. |
| DDS_LABELSREMAINING |
For the current job, the number of labels remaining to be printed. |
| DDS_LABELWAITING |
Whether a printed label is waiting to be peeled off or torn off and removed from the device. true: A label is waiting false: No label is waiting |
| DDS_PAUSED |
Whether the device has been manually paused. true: Paused false: Not paused |
| DDS_PRINTMODE |
The Print Mode for which the device is configured. This mode determines the action the device takes after a label or group of labels has been printed. Values: TEAROFF, PEELOFF, REWIND, APPLICATOR, CUTTER Tip: You can configure the Print Mode in the Options tab. |
| DDS_REPLACEINK |
Whether the ink cartridge is in need of replacement, such as because the ink level is low or the ink cartridge is missing. true: Replacement needed false: Replacement not needed |
Common Reserved Keys for Device Status
These keys are available for most devices supported by Spectrum.
| Reserved Key | Description |
|---|---|
|
DDS_CONNECTIONERROR |
Whether any connection errors have occurred. true: Connection errors occurred false: No connection errors occurred |
|
DDS_ENABLED |
Whether Detailed Device Status reporting is enabled for this device in Spectrum. true: Enabled false: Disabled |
|
DDS_FATALERRORS |
Whether any errors that would prevent printing occurred. true: Errors that prevent printing occurred false: No errors that prevent printing occurred Note: Not supported on Avery Dennison, NOVEXX Solutions, QuickLabel, or Toshiba devices. |
|
DDS_PAPERERROR |
Whether the device is out of label stock. true: Out of stock false: Not out of stock Note: Not supported on Avery Dennison, NOVEXX Solutions, QuickLabel, or Toshiba devices. |
|
DDS_PRINTHEADERROR |
Whether the print head is up and not ready for printing. true: Print head is up, not ready to print false: Print head is down, ready to print Note: Not supported on Avery Dennison, NOVEXX Solutions, QuickLabel, or Toshiba devices. |
|
DDS_RAWDATA |
The raw data (base 64 encoded) returned from a call to retrieve detailed device status from this device by using a business rule. |
|
DDS_RIBBONERROR |
Whether the device is out of ribbon. true: Out of ribbon false: Ribbon available Note: Not supported on Avery Dennison, NOVEXX Solutions, QuickLabel, or Toshiba devices. |
|
DDS_SUPPORTED |
Whether Detailed Device Status reporting is supported and enabled for this device in Spectrum. true: Supported and enabled false: Not supported, disabled, or both |
Device Information Data
The following reserved keys can be used to refer to detailed device data retrieved from an Epson device by using a detailedDeviceInfo business rule component.
| Reserved Key | Description |
|---|---|
| DDI_FIRMWAREVERSION |
The version number of the firmware installed for the device. |
| DDI_HARDWAREMODEL |
The model name or model number of the device. |
| DDI_PRINTHEADRESOLUTION |
The resolution configured for the device in dots per millimeter. |
| DDI_RESOLUTION |
The resolution configured for the device in Dots Per Inch (dpi). Tip: You can configure the Device Resolution in the Options tab. |
| DDI_TOTALMEMORY |
The amount of memory existing in the device. This includes both available memory and memory that is in use or otherwise unavailable. |
Common Reserved Keys for Device Information
These keys are available for most devices supported by Spectrum.
| Reserved Key | Description |
|---|---|
|
DDI_CONNECTIONERROR |
Whether any connection errors have occurred. true: Connection errors have occurred false: No connection errors have occurred |
|
DDI_DEVICEFAMILY |
The name of the device family in Spectrum. |
|
DDI_DEVICEMODEL |
The model of the device in Spectrum. |
| DDI_ENABLED |
Whether Detailed Device Info reporting is enabled for this device in Spectrum. true: Enabled for this device. false: Disabled for this device. |
| DDI_RAWDATA |
The raw data (base 64 encoded) returned from a call to retrieve detailed device information from this device by using a business rule. |
| DDI_SUPPORTED |
Whether Detailed Device Info reporting is supported and enabled for this device in Spectrum. true: Supported and enabled for this device. false: Not supported, disabled, or both for this device. |
more