Description This command is used to set or clear one or more output ports (indicators) in the Sensors and Indicators Unit.
Input Param LPWFSSIUSETPORTS lpSetPorts;
typedef struct _wfs_siu_set_ports
{
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;
} WFSSIUSETPORTS, * LPWFSSIUSETPORTS;
fwDoors [WFS_SIU_CABINET]
Specifies whether the Cabinet Doors should be bolted or unbolted. Specified as one of the following flags:
Value Meaning
WFS_SIU_NO_CHANGE Do not change the current status of the Cabinet doors.
WFS_SIU_BOLT The Cabinet doors are bolted.
WFS_SIU_UNBOLT The Cabinet doors are unbolted.
fwDoors [WFS_SIU_SAFE]
Specifies whether the Safe Doors should be bolted or unbolted. Specified as one of the following flags:
Value Meaning
WFS_SIU_NO_CHANGE Do not change the current status of the Safe doors.
WFS_SIU_BOLT The Safe doors are bolted.
WFS_SIU_UNBOLT The Safe doors are unbolted.
fwDoors [WFS_SIU_VANDALSHIELD]
Specifies whether the Vandal Shield should change position. Specified as one of the following flags:
Value Meaning
WFS_SIU_NO_CHANGE Do not change the current position of the Vandal shield.
WFS_SIU_OPEN The Vandal Shield is opened.
WFS_SIU_SERVICE The Vandal Shield is set in service position.
WFS_SIU_KEYBOARD The Vandal Shield is set in position that permits access to the keyboard.
WFS_SIU_CLOSED The Vandal Shield is closed.
fwIndicators [WFS_SIU_OPENCLOSE]
Specifies whether the Open/Closed Indicator should show Open or Close to a consumer. Specified as one of the following flags:
Value Meaning
WFS_SIU_NO_CHANGE Do not change the current status of the indicator.
WFS_SIU_CLOSED The indicator is changed to show that the terminal is closed for a consumer.
WFS_SIU_OPEN The indicator is changed to show that the terminal is open to be used by a consumer.
fwIndicators [WFS_SIU_FASCIALIGHT]
Specifies whether the Fascia Lights should be turned on or off. Specified as one of the following flags:
Value Meaning
WFS_SIU_NO_CHANGE Do not change the current status of the light.
WFS_SIU_OFF The Fascia Light is turned off.
WFS_SIU_ON The Fascia Light is turned on.
fwIndicators [WFS_SIU_AUDIO]
Specifies whether the Audio Indicator should be turned on or off. Specified 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_NO_CHANGE | Do not change the current status of the beeper. | 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 error signal. | B |
| WFS_SIU_CONTINUOUS | The Audio Indicator sound is turned on continuously. | C |
fwIndicators [WFS_SIU_HEATING]
Specifies whether the internal Heating device should be turned on or off. Specified as one of the following flags:
Value Meaning
WFS_SIU_NO_CHANGE Do not change the current status of the light.
WFS_SIU_OFF The Heating is turned off.
WFS_SIU_ON The Heating is turned on.
fwAuxiliaries [WFS_SIU_VOLUME]
Specifies whether the value of the volume control should be changed or not. If so, the value of volume control is defined in an interval from 1 to 1000 were 1 is the lowest volume level and 1000 is the highest volume level. Specified as one of the following values:
Value Meaning
WFS_SIU_NO_CHANGE Do not change the current status of the light.
1, ..., 1000 The volume level. This field is handled as an unsigned short. If a value greater than 1000 is used, the provider will map the value to 1000.
fwAuxiliaries [WFS_SIU_UPS]
Specifies whether the UPS device should be engaged or disengaged. The UPS device should not be engaged when the charge level is low. Specified as one of the following flags:
Value Meaning
WFS_SIU_NO_CHANGE Do not change the current status of the UPS device.
WFS_SIU_ENGAGE Engage the UPS.
WFS_SIU_DISENGAGE Disengage the UPS.
fwGuidLights [...]
Specifies whether the Guidance Light Indicators should be turned on or off, or if they should flash. All member elements of the Guidance Lights structure can be specified as one of the following values:
Value Meaning
| WFS_SIU_NO_CHANGE | Do not change the current status of the Light Indicator. |
| WFS_SIU_OFF | The Light Indicator is turned off. |
| WFS_SIU_SLOW_FLASH | The Light Indicator is set to flash slowly. |
| WFS_SIU_MEDIUM_FLASH | The light is blinking medium frequency. |
| WFS_SIU_QUICK_FLASH | The Light Indicator is set to flash quickly. |
| WFS_SIU_CONTINUOUS | The Light Indicator is turned on continuously (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 passed 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.
Output Param None.
Error Codes The following additional error codes can be generated by this command:
Value Meaning
WFS_ERR_SIU_INVALID_PORT An attempt to set a port to a new value was invalid because the port does not exist or the port is pre-configured as an input port.
WFS_ERR_SIU_SYNTAX The command was invoked with incorrect input data.
Events The following additional events can be generated by this command:
Value Meaning
WFS_EXEE_SIU_PORT_ERROR An error occurred while attempting to set or clear one or more output ports (indicators).
Comments No action has been taken if this command returns an error. If a hardware error occurs while executing the command, the command will return OK, but execute event(s) will be generated which indicate(s) the port(s) which have failed.