Description This command reports the full range of information available, including the information that is provided by the service provider.
Input Param None.
Output Param LPWFSSIUSTATUS lpStatus;
typedef struct _wfs_siu_status
{
WORD fwDevice;
WORD fwSensors [WFS_SIU_SENSORS_SIZE];
WORD fwDoors [WFS_SIU_DOORS_SIZE];
WORD fwIndicators [WFS_SIU_INDICATORS_SIZE];
WORD fwAuxiliaries [WFS_SIU_AUXILIARIES_SIZE];
WORD fwGuidLights [WFS_SIU_GUIDLIGHTS_SIZE];
LPSTR lpszExtra;
} WFSSIUSTATUS, * LPWFSSIUSTATUS;
fwDevice
Specifies the state of the Sensors and Indicators Unit device as one of the following flags:
Value Meaning
WFS_SIU_DEVONLINE The device is on-line. The device is present and operational (i.e. not busy processing a request and does not have a hardware error).
WFS_SIU_DEVOFFLINE The device is off-line. The device is present and powered on but it is not operational (e.g. a switch may have been used to change it to an off-line state).
WFS_SIU_DEVPOWEROFF The device is powered off. The device is present, but is currently powered off.
WFS_SIU_DEVBUSY The device is busy processing a request. The device is present and an EXECUTE request is currently being processing.
WFS_SIU_DEVNODEVICE There is no device connected.
WFS_SIU_DEVHWERROR The device is inoperable due to a hardware error. The device is present but a hardware fault prevents it from being used.
WFS_SIU_DEVUSERERROR The device is present but a person is preventing proper operation. The application should suspend the device operation or remove the device from service until the service provider generates a device state change event indicating the condition of the device has changed i.e. the error is removed (WFS_SIU_DEVONLINE) or a permanent error condition has occurred (WFS_SIU_DEVHWERROR).
fwSensors [...]
Specifies the state of the Sensors. A number of sensor types are defined below. Vendor specific sensors are defined starting from the end of the array. The maximum sensor index is WFS_SIU_SENSORS_MAX.
fwSensors [WFS_SIU_OPERATORSWITCH]
Specifies the state of the Operator Switch(es). This switch is used to tell the terminal if an Operator/Supervisor wants to change the state from Run to Operators/Supervisors mode or vice versa. The Run mode is used for normal consumer operations/transactions. The Maintenance mode is used when replenish the terminal. The Supervisor mode is used when operating the terminal for service and testing. Supervisor mode has higher priority than maintenance mode. Specified as one of the following flags:
Value Meaning
WFS_SIU_NOT_AVAILABLE The status is not available.
WFS_SIU_RUN The switch is in Run mode.
WFS_SIU_MAINTENANCE The switch is in Maintenance mode.
WFS_SIU_SUPERVISOR The switch is in Supervisor mode.
fwSensors [WFS_SIU_TAMPER]
Specifies the state of the Tamper Sensor for the terminal. This sensor indicates whether the terminal has been tampered with (such as a burglar attempt). Specified as one of the following flags:
Value Meaning
WFS_SIU_NOT_AVAILABLE The status is not available.
WFS_SIU_OFF There is no indication of a tampering attempt.
WFS_SIU_ON There has been a tampering attempt.
fwSensors [WFS_SIU_INTTAMPER]
Specifies the state of the Tamper Sensor for the internal alarm. This sensor indicates whether the internal alarm has been tampered with (such as a burglar attempt). Specified as one of the following flags:
Value Meaning
WFS_SIU_NOT_AVAILABLE The status is not available.
WFS_SIU_OFF There is no indication of a tampering attempt.
WFS_SIU_ON There has been a tampering attempt.
fwSensors [WFS_SIU_SEISMIC]
Specifies the state of the Seismic Sensor. This sensor indicates whether the terminal has been shaken (e.g. burglar attempt or seismic activity). Specified as one of the following flags:
Value Meaning
WFS_SIU_NOT_AVAILABLE The status is not available.
WFS_SIU_OFF The seismic activity has not been high enough to trigger the sensor.
WFS_SIU_ON The seismic or other activity has triggered the sensor.
fwSensors [WFS_SIU_HEAT]
Specifies the state of the Heat Sensor. This sensor is triggered by excessive heat (fire) near the terminal. Specified as one of the following flags:
Value Meaning
WFS_SIU_NOT_AVAILABLE The status is not available.
WFS_SIU_OFF The heat has not been high enough to trigger the sensor.
WFS_SIU_ON The heat has been high enough to trigger the sensor.
fwSensors [WFS_SIU_PROXIMITY]
Specifies the state of the Proximity Sensor. This sensor is triggered by movements around the terminal. Specified as one of the following flags:
Value Meaning
WFS_SIU_NOT_AVAILABLE The status is not available.
WFS_SIU_NOT_PRESENT The sensor can not sense any people around the terminal.
WFS_SIU_PRESENT The sensor is showing that there is someone present at the terminal.
fwSensors [WFS_SIU_AMBLIGHT]
Specifies the state of the Ambient Light Sensor. This sensor indicates the level of ambient light around the terminal. Specified as one of the following flags:
Value Meaning
WFS_SIU_NOT_AVAILABLE The status is not available.
WFS_SIU_VERY_LIGHT The level of light is: very light
WFS_SIU_LIGHT The level of light is: light
WFS_SIU_MEDIUM_LIGHT The level of light is: medium light
WFS_SIU_DARK The level of light is: dark
WFS_SIU_VERY_DARK The level of light is: very dark
fwDoors [...]
Specifies the state of the Doors. A number of door types are defined below. Vendor specific doors are defined starting from the end of the array. The maximum door index is WFS_SIU_DOORS_MAX.
fwDoors [WFS_SIU_CABINET]
Specifies the state of the Cabinet Doors. Cabinet Doors are doors that open up for consumables, and hardware that does not have to be in a secure place. Specified as one of the following flags.
Value Meaning
WFS_SIU_NOT_AVAILABLE The status is not available.
WFS_SIU_OPEN At least one of the Cabinet Doors is open.
WFS_SIU_CLOSED The Cabinet Doors are closed.
WFS_SIU_LOCKED The Cabinet Doors are closed and locked.
WFS_SIU_BOLTED The Cabinet Doors are closed, locked and bolted.
fwDoors [WFS_SIU_SAFE]
Specifies the state of the Safe Doors. Safe Doors are doors that open up for secure hardware, such as the note dispenser, the security device, etc. Specified as one of the following flags:
Value Meaning
WFS_SIU_NOT_AVAILABLE The status is not available.
WFS_SIU_OPEN At least one of the Safe Doors is open.
WFS_SIU_CLOSED The Safe Doors are closed.
WFS_SIU_LOCKED The Safe Doors are closed and locked.
WFS_SIU_BOLTED The Safe Doors are closed, locked and bolted.
fwDoors [WFS_SIU_VANDALSHIELD]
Specifies the state of the Vandal Shield. The Vandal Shield is a door that open up for consumer access to the terminal. Specified as one of the following flags:
Value Meaning
WFS_SIU_NOT_AVAILABLE The status is not available.
WFS_SIU_OPEN The Vandal Shield is open.
WFS_SIU_CLOSED The Vandal Shield is closed.
WFS_SIU_LOCKED The Vandal Shield is closed and locked.
WFS_SIU_SERVICE The Vandal Shield is in service position.
WFS_SIU_KEYBOARD The Vandal Shield position permits access to the keyboard.
WFS_SIU_AJAR The Vandal Shield is ajar.
WFS_SIU_JAMMED The Vandal Shield is jammed.
fwIndicators [...]
Specifies the state of the Status Indicators. A number of Status Indicator types are defined below. Vendor specific indicators are defined starting from the end of the array. The maximum indicator index is WFS_SIU_INDICATORS_MAX.
fwIndicators [WFS_SIU_OPENCLOSE]
Specifies the state of the Open/Closed Indicator as one of the following flags:
Value Meaning
WFS_SIU_NOT_AVAILABLE The status is not available.
WFS_SIU_CLOSED The terminal is closed for a consumer.
WFS_SIU_OPEN The terminal is open to be used by a consumer.
fwIndicators [WFS_SIU_FASCIALIGHT]
Specifies the state of the Fascia Light as one of the following flags:
Value Meaning
WFS_SIU_NOT_AVAILABLE The status is not available.
WFS_SIU_OFF The Fascia Light is turned off.
WFS_SIU_ON The Fascia Light is turned on.
fwIndicators [WFS_SIU_AUDIO]
Specifies the state of the Audio Indicator as one of the following flags of type A and B, or as WFS_SIU_ CONTINUOUS in combination with one of the flags of type B:
Value Meaning Type
| WFS_SIU_NOT_AVAILABLE | The status is not available. | A |
| WFS_SIU_OFF | The Audio Indicator is turned off. | A |
| WFS_SIU_KEYPRESS | The Audio Indicator sounds a key click signal. | B |
| WFS_SIU_EXCLAMATION | The Audio Indicator sounds a exclamation signal. | B |
| WFS_SIU_WARNING | The Audio Indicator sounds a warning signal. | B |
| WFS_SIU_ERROR | The Audio Indicator sounds a error signal. | B |
| WFS_SIU_CRITICAL | The Audio Indicator sounds a critical signal. | B |
| WFS_SIU_CONTINUOUS | The Audio Indicator sound is turned on continuously. | C |
fwIndicators [WFS_SIU_HEATING]
Specifies the state of the internal heating as one of the following flags:
Value Meaning
WFS_SIU_NOT_AVAILABLE The status is not available.
WFS_SIU_OFF The Heating is turned off.
WFS_SIU_ON The Heating is turned on.
fwAuxiliaries [...]
Specifies the state of the Auxiliary indicators. A number of Auxiliary indicator types are defined below. Vendor specific Auxiliaries are defined starting from the end of the array. The maximum auxiliary index is WFS_SIU_AUXILIARIES_MAX.
fwAuxiliaries [WFS_SIU_VOLUME]
Specifies the value of the volume control. The value of volume control is defined in an interval from 1 to 1000 where 1 is the lowest volume level and 1000 is the highest volume level. The interval is defined in logarithmic steps, e.g. a volume control on a radio. Note: The volume control field is handled as unsigned short.
Value Meaning
WFS_SIU_NOT_AVAILABLE The status is not available.
1, ..., 1000 The volume level. This field is handled as an unsigned short.
fwAuxiliaries [WFS_SIU_UPS]
Specifies the state of the Uninterruptable Power Supply device as WFS_SIU_NOT_AVAILABLE or as a combination of the following flags of type B:
Value Meaning Type
| WFS_SIU_NOT_AVAILABLE | There is no UPS available. | A |
| WFS_SIU_AVAILABLE | The UPS is available | B |
| WFS_SIU_LOW | The charge level of the UPS is low | B |
| WFS_SIU_ENGAGED | The UPS is engaged | B |
| WFS_SIU_POWERING | The UPS is powering the system. The main power supply is off. | B |
| WFS_SIU_RECOVERED | The UPS was engaged when the main power went off | B |
fwGuidLights [...]
Specifies the state of the Guidance Light Indicators. A number of guidance light types are defined below. Vendor specific guidance lights are defined starting from the end of the array. The maximum guidance light index is WFS_SIU_GUIDLIGHTS_MAX. All member elements in this array are specified as one of the following flags:
Value Meaning
WFS_SIU_NOT_AVAILABLE The status is not available.
WFS_SIU_OFF The light is turned off.
WFS_SIU_SLOW_FLASH The light is blinking slowly.
WFS_SIU_MEDIUM_FLASH The light is blinking medium frequency.
WFS_SIU_QUICK_FLASH The light is blinking quickly.
WFS_SIU_CONTINUOUS The light is turned on continuous (steady).
fwGuidLights [WFS_SIU_CARDUNIT]
Specifies the state of the Guidance Light Indicator on the Card Unit (IDC).
fwGuidLights [WFS_SIU_PINPAD]
Specifies the state of the Guidance Light Indicator on the PIN pad unit.
fwGuidLights [WFS_SIU_NOTESDISPENSER]
Specifies the state of the Guidance Light Indicator on the note dispenser unit.
fwGuidLights [WFS_SIU_COINDISPENSER]
Specifies the state of the Guidance Light Indicator on the coin dispenser unit.
fwGuidLights [WFS_SIU_RECEIPTPRINTER]
Specifies the state of the Guidance Light Indicator on the receipt printer unit.
fwGuidLights [WFS_SIU_PASSBOOKPRINTER]
Specifies the state of the Guidance Light Indicator on the passbook printer unit.
fwGuidLights [WFS_SIU_ENVDEPOSITORY]
Specifies the state of the Guidance Light Indicator on the envelope depository unit.
fwGuidLights [WFS_SIU_CHEQUEUNIT]
Specifies the state of the Guidance Light Indicator on the cheque processing unit.
fwGuidLights [WFS_SIU_BILLACCEPTOR]
Specifies the state of the Guidance Light Indicator on the bill acceptor unit.
fwGuidLights [WFS_SIU_ENVDISPENSER]
Specifies the state of the Guidance Light Indicator on the envelope dispenser unit.
lpszExtra
Specifies a list of vendor-specific, or any other extended, information. The information is returned as a series of "key=value" strings so that it is easily extensible by service providers. Each string will be null-terminated, with the final string terminating with two null characters.
Error Codes There are no additional error codes generated by this command.
Comments Applications which require or expect specific information to be present in the lpszExtra parameter may not be device or vendor-independent.