Description This command is used to retrieve the capabilities of the Sensors and Indicators Unit.
Input Param None.
Output Param LPWFSSIUCAPS lpCaps;
typedef struct _wfs_siu_caps
{
WORD wClass;
WORD fwType;
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;
} WFSSIUCAPS, * LPWFSSIUCAPS;
wClass
Specifies the logical service class, value is:
WFS_SERVICE_CLASS_SIU
fwType
Specifies the type of sensors and indicators supported by this device as a combination of the following flags:
Value Meaning
WFS_SIU_SENSORS The device supports input Sensors.
WFS_SIU_DOORS The device support Door sensors.
WFS_SIU_INDICATORS The device supports Status Indicators.
WFS_SIU_AUXILIARIES The device supports Auxiliary Indicators.
WFS_SIU_GUIDLIGHTS The device supports Guidance Lights.
fwSensors [...]
Specifies which Sensors that are available, and if so, which states they can take. 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 whether the Operator switch is available, and if so, which states it can take. Specified 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 Operator Switch available. | A |
| WFS_SIU_RUN | The switch can be set in Run mode. | B |
| WFS_SIU_MAINTENANCE | The switch can be set in Maintenance mode. | B |
| WFS_SIU_SUPERVISOR | The switch can be set in Supervisors mode. | B |
fwSensors [WFS_SIU_TAMPER]
Specifies whether the Tamper Sensor for the terminal is available. Specified as one of the following flags:
Value Meaning
WFS_SIU_NOT_AVAILABLE There is no Tamper Sensor available.
WFS_SIU_AVAILABLE The Tamper Sensor is available.
fwSensors [WFS_SIU_INTTAMPER]
Specifies whether the Tamper Sensor for internal alarm is available. Specified as one of the following flags:
Value Meaning
WFS_SIU_NOT_AVAILABLE There is no internal Tamper Sensor available.
WFS_SIU_AVAILABLE The internal Tamper Sensor is available.
fwSensors [WFS_SIU_SEISMIC]
Specifies whether the Seismic Sensor is available. Specified as one of the following flags:
Value Meaning
WFS_SIU_NOT_AVAILABLE There is no Seismic Sensor available.
WFS_SIU_AVAILABLE The Seismic Sensor is available.
fwSensors [WFS_SIU_HEAT]
Specifies whether the Heat Sensor is available. Specified as one of the following flags:
Value Meaning
WFS_SIU_NOT_AVAILABLE There is no Heat Sensor available.
WFS_SIU_AVAILABLE The Heat Sensor is available.
fwSensors [WFS_SIU_PROXIMITY]
Specifies whether the Proximity Sensor is available. Specified as one of the following flags:
Value Meaning
WFS_SIU_NOT_AVAILABLE There is no Proximity Sensor available.
WFS_SIU_AVAILABLE The Proximity Sensor is available.
fwSensors [WFS_SIU_AMBLIGHT]
Specifies whether the Ambient Light Sensor is available. Specified as one of the following flags:
Value Meaning
WFS_SIU_NOT_AVAILABLE There is no Ambient Light Sensor available.
WFS_SIU_AVAILABLE The Ambient Light Sensor is available.
fwDoors [...]
Specifies which Doors that are available, and if so, which states they can take. 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 whether the Cabinet Doors are available, and if so, which states they can take. Specified 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 Cabinet Door available. | A |
| WFS_SIU_LOCKED | The Cabinet Doors can be locked. | B |
| WFS_SIU_BOLTED | The Cabinet Doors can be bolted. | B |
| WFS_SIU_CLOSED | The Cabinet Doors can be closed. | B |
| WFS_SIU_OPEN | The Cabinet Doors can be open. | B |
fwDoors [WFS_SIU_SAFE]
Specifies whether the Safe Doors are available, and if so, which states they can take. Specified 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 Safe Door available. | A |
| WFS_SIU_LOCKED | The Safe Doors can be locked. | B |
| WFS_SIU_BOLTED | The Safe Doors can be bolted. | B |
| WFS_SIU_CLOSED | The Safe Doors can be closed. | B |
| WFS_SIU_OPEN | The Safe Doors can be open. | B |
fwDoors [WFS_SIU_VANDALSHIELD]
Specifies whether the Vandal Shield is available, and if so, which states it can take. Specified 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 Vandal Shield available. | A |
| WFS_SIU_OPEN | The Vandal Shield can be open. | B |
| WFS_SIU_SERVICE | The Vandal Shield can be in service position. | B |
| WFS_SIU_KEYBOARD | The Vandal Shield can be in position that permits access to the keyboard. | B |
| WFS_SIU_CLOSED | The Vandal Shield can be closed. | B |
| WFS_SIU_LOCKED | The Vandal Shield can be locked. | B |
fwIndicators [...]
Specifies which Status Indicators that are available, and if so, which states they can take. 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 whether the Open/Closed Indicator is available. Specified as one of the following flags:
Value Meaning
WFS_SIU_NOT_AVAILABLE There is no Open/Closed Indicator available.
WFS_SIU_AVAILABLE The Open/Closed Indicator is available.
fwIndicators [WFS_SIU_FASCIALIGHT]
Specifies whether the Fascia Light is available. Specified as one of the following flags:
Value Meaning
WFS_SIU_NOT_AVAILABLE There is no Fascia Light available.
WFS_SIU_AVAILABLE The Fascia Light is available.
fwIndicators [WFS_SIU_AUDIO]
Specifies whether the Audio Indicator device is available. Specified as one of the following flags:
Value Meaning
WFS_SIU_NOT_AVAILABLE There is no Audio Indicator available.
WFS_SIU_AVAILABLE The Audio Indicator is available.
fwIndicators [WFS_SIU_HEATING]
Specifies whether the internal Heating device is available. Specified as one of the following flags:
Value Meaning
WFS_SIU_NOT_AVAILABLE There is no Heating device available.
WFS_SIU_AVAILABLE The Heating device is available.
fwAuxiliaries [...]
Specifies which Auxiliaries that are available, and if so, which states they can take. 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 if the volume control is available, and if so, the increment/decrement value recommended by the vendor.
Value Meaning
WFS_SIU_NOT_AVAILABLE There is no volume control available.
1, ..., 1000 The recommended increment/decrement value for the volume control.
fwAuxiliaries [WFS_SIU_UPS]
Specifies if the UPS device is available, and if so, which states it can take. Specified 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 UPS can indicate that its charge level is low | B |
| WFS_SIU_ENGAGED | The UPS can be engaged and disengaged by the application | B |
| WFS_SIU_POWERING | The UPS can indicate that it is powering the system while the main power supply is off. | B |
| WFS_SIU_RECOVERED | The UPS can indicate that it was engaged when the main power went off | B |
fwGuidLights [...]
Specifies which Guidance Lights that are available, and if so, which states they can take. 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. The elements of this array are specified as one of the following flags:
Value Meaning
WFS_SIU_NOT_AVAILABLE There is no Guidance Light available at this position.
WFS_SIU_AVAILABLE A Guidance Light is available at this position.
fwGuidLights [WFS_SIU_CARDUNIT]
Specifies whether the Guidance Light Indicator on the Card Unit (IDC) is available.
fwGuidLights [WFS_SIU_PINPAD]
Specifies whether the Guidance Light Indicator on the PIN pad unit is available.
fwGuidLights [WFS_SIU_NOTESDISPENSER]
Specifies whether the Guidance Light Indicator on the note dispenser unit is available.
fwGuidLights [WFS_SIU_COINDISPENSER]
Specifies whether the Guidance Light Indicator on the coin dispenser unit is available.
fwGuidLights [WFS_SIU_RECEIPTPRINTER]
Specifies whether the Guidance Light Indicator on the receipt printer unit is available.
fwGuidLights [WFS_SIU_PASSBOOKPRINTER]
Specifies whether the Guidance Light Indicator on the passbook printer unit is available.
fwGuidLights [WFS_SIU_ENVDEPOSITORY]
Specifies whether the Guidance Light Indicator on the envelope depository unit is available.
fwGuidLights [WFS_SIU_CHEQUEUNIT]
Specifies whether the Guidance Light Indicator on the cheque processing unit is available.
fwGuidLights [WFS_SIU_BILLACCEPTOR]
Specifies whether the Guidance Light Indicator on the bill acceptor unit is available.
fwGuidLights [WFS_SIU_ENVDISPENSER]
Specifies whether the Guidance Light Indicator on the envelope dispenser unit is available.
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.