Description This command is used to enable or disable events from the Sensors and Indicators Unit. The default condition is that all events are disabled.
Input Param LPWFSSIUENABLE lpEnable;
typedef struct _wfs_siu_enable
{
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;
} WFSSIUENABLE, * LPWFSSIUENABLE;
fwSensors [...]
Specifies which of the Sensors that should report changes. 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 should report whenever the switch changes the operating mode. Specified as one of the following flags:
Value Meaning
WFS_SIU_NO_CHANGE Do not change the current reporting status.
WFS_SIU_ENABLE_EVENT The Operators Switch should report whenever it changes mode from Run to Maintenance or Supervisor mode or vice versa.
WFS_SIU_DISABLE_EVENT The Operators Switch should not report any changes of it operating mode.
fwSensors [WFS_SIU_TAMPER]
Specifies whether the Tamper Sensor should report whenever someone tampers with the terminal. Specified as one of the following flags:
Value Meaning
WFS_SIU_NO_CHANGE Do not change the current reporting status.
WFS_SIU_ENABLE_EVENT The Tamper Sensor should report whenever it detects any tampering attempt.
WFS_SIU_DISABLE_EVENT The Tamper Sensor should not report any changes of its status.
fwSensors [WFS_SIU_INTTAMPER]
Specifies whether the internal Tamper Sensor should report whenever someone tampers with the internal alarm. Specified as one of the following flags:
Value Meaning
WFS_SIU_NO_CHANGE Do not change the current reporting status.
WFS_SIU_ENABLE_EVENT The Tamper Sensor should report whenever it detects any tampering attempt.
WFS_SIU_DISABLE_EVENT The Tamper Sensor should not report any changes of its status.
fwSensors [WFS_SIU_SEISMIC]
Specifies whether the Seismic Sensor should report whenever any seismic activity is detected. Specified as one of the following flags:
Value Meaning
WFS_SIU_NO_CHANGE Do not change the current reporting status.
WFS_SIU_ENABLE_EVENT The Seismic Sensor should report whenever it detects any seismic activity.
WFS_SIU_DISABLE_EVENT The Seismic Sensor should not report any changes of its status.
fwSensors [WFS_SIU_HEAT]
Specifies whether the Heat Sensor should report whenever any excessive heat is detected. Specified as one of the following flags:
Value Meaning
WFS_SIU_NO_CHANGE Do not change the current reporting status.
WFS_SIU_ENABLE_EVENT The Heat Sensor should report whenever it detects any excessive heat.
WFS_SIU_DISABLE_EVENT The Heat Sensor should not report any changes of its status.
fwSensors [WFS_SIU_PROXIMITY]
Specifies whether the Proximity Sensor should report whenever any movement is detected close to the terminal. Specified as one of the following flags:
Value Meaning
WFS_SIU_NO_CHANGE Do not change the current reporting status.
WFS_SIU_ENABLE_EVENT The Proximity Sensor should report whenever it detects any movement.
WFS_SIU_DISABLE_EVENT The Proximity Sensor should not report any changes of its status.
fwSensors [WFS_SIU_AMBLIGHT]
Specifies whether the Ambient Light Sensor should report whenever it detects changes in the ambient light. Specified as one of the following flags:
Value Meaning
WFS_SIU_NO_CHANGE Do not change the current reporting status.
WFS_SIU_ENABLE_EVENT The Ambient Light Sensor should report whenever it detects a change.
WFS_SIU_DISABLE_EVENT The Ambient Light Sensor should not report any change.
fwDoors [...]
Specifies which of the Doors that should report changes. 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 sensor should report whenever the doors are opened, closed, bolted or locked. Specified as one of the following flags:
Value Meaning
WFS_SIU_NO_CHANGE Do not change the current reporting status.
WFS_SIU_ENABLE_EVENT The Cabinet Doors should report whenever the doors are opened, closed, locked or bolted.
WFS_SIU_DISABLE_EVENT The Cabinet Doors sensor should not report any changes of the doors status.
fwDoors [WFS_SIU_SAFE]
Specifies whether the Safe Doors should report whenever the doors are opened, closed, bolted or locked. Specified as one of the following flags:
Value Meaning
WFS_SIU_NO_CHANGE Do not change the current reporting status.
WFS_SIU_ENABLE_EVENT The Safe Doors should report whenever the doors are opened, closed, locked or bolted.
WFS_SIU_DISABLE_EVENT The Safe Doors should not report any changes of the doors status.
fwDoors [WFS_SIU_VANDALSHIELD]
Specifies whether the Vandal Shield should report whenever the shield changed position. Specified as one of the following flags:
Value Meaning
WFS_SIU_NO_CHANGE Do not change the current reporting status.
WFS_SIU_ENABLE_EVENT The Vandal Shield should report whenever the doors are opened or closed.
WFS_SIU_DISABLE_EVENT The Vandal Shield should not report any changes of the status.
fwIndicators [...]
Specifies which of the Status Indicators that should report changes. 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 should report whenever it is turned on (set to open) or turned off (set to closed). Specified as one of the following flags:
Value Meaning
WFS_SIU_NO_CHANGE Do not change the current reporting status.
WFS_SIU_ENABLE_EVENT The Open/Closed Indicator should report whenever it is turned on or off.
WFS_SIU_DISABLE_EVENT The Open/Closed Indicator should not report any changes of the indicator.
fwIndicators [WFS_SIU_FASCIALIGHT]
Specifies whether the Fascia Light should report whenever it is turned on or turned off. Specified as one of the following flags:
Value Meaning
WFS_SIU_NO_CHANGE Do not change the current reporting status.
WFS_SIU_ENABLE_EVENT The Fascia Light should report whenever it is turned on or off.
WFS_SIU_DISABLE_EVENT The Fascia Light should not report any changes.
fwIndicators [WFS_SIU_AUDIO]
Specifies whether the Audio Indicator should report whenever it is turned on or turned off. Specified as one of the following flags:
Value Meaning
WFS_SIU_NO_CHANGE Do not change the current reporting status.
WFS_SIU_ENABLE_EVENT The Audio Indicator should report whenever it is turned on or off.
WFS_SIU_DISABLE_EVENT The Audio Indicator should not report any changes.
fwIndicators [WFS_SIU_HEATING]
Specifies whether the Heating device should report whenever it is turned on or turned off. Specified as one of the following flags:
Value Meaning
WFS_SIU_NO_CHANGE Do not change the current reporting status.
WFS_SIU_ENABLE_EVENT The Heating device should report whenever it is turned on or off.
WFS_SIU_DISABLE_EVENT The Heating device should not report any changes.
fwAuxiliaries [...]
Specifies which of the Auxiliary Indicators that should report changes. A number of Auxiliary Indicator types are defined below. Vendor specific indicators are defined starting from the end of the array. The maximum indicator index is WFS_SIU_AUXILIARIES_MAX.
fwAuxiliaries[WFS_SIU_VOLUME]
Specifies whether the Volume control device should report whenever it is changed or not. Specified as one of the following flags:
Value Meaning
WFS_SIU_NO_CHANGE Do not change the current reporting status.
WFS_SIU_ENABLE_EVENT The Volume control device should report whenever it is changed.
WFS_SIU_DISABLE_EVENT The Volume control device should not report any changes.
fwAuxiliaries[WFS_SIU_UPS]
Specifies whether the UPS device should report whenever it is changed or not. Specified as one of the following flags:
Value Meaning
WFS_SIU_NO_CHANGE Do not change the current reporting status.
WFS_SIU_ENABLE_EVENT The UPS device should report whenever it is changed.
WFS_SIU_DISABLE_EVENT The UPS device should not report any changes.
fwGuidLights [...]
Specifies which of the Guidance Light Indicators should report whenever any of them changes its state. Specified as one of the following flags:
Value Meaning
WFS_SIU_NO_CHANGE Do not change the current reporting status.
WFS_SIU_ENABLE_EVENT The Light Indicators should report whenever any of them changes its state.
WFS_SIU_DISABLE_EVENT The Light Indicators should not report any changes of their states.
fwGuidLights [WFS_SIU_CARDUNIT]
Specifies whether the Guidance Light Indicator on the Card Unit (IDC) should report whenever it changes status.
fwGuidLights [WFS_SIU_PINPAD]
Specifies whether the Guidance Light Indicator on the PIN pad unit should report whenever it changes status.
fwGuidLights [WFS_SIU_NOTESDISPENSER]
Specifies whether the Guidance Light Indicator on the note dispenser unit should report whenever it changes status.
fwGuidLights [WFS_SIU_COINDISPENSER]
Specifies whether the Guidance Light Indicator on the coin dispenser unit should report whenever it changes status.
fwGuidLights [WFS_SIU_RECEIPTPRINTER]
Specifies whether the Guidance Light Indicator on the receipt printer unit should report whenever it changes status.
fwGuidLights [WFS_SIU_PASSBOOKPRINTER]
Specifies whether the Guidance Light Indicator on the passbook printer unit should report whenever it changes status.
fwGuidLights [WFS_SIU_ENVDEPOSITORY]
Specifies whether the Guidance Light Indicator on the envelope depository unit should report whenever it changes status.
fwGuidLights [WFS_SIU_CHEQUEUNIT]
Specifies whether the Guidance Light Indicator on the cheque processing unit should report whenever it changes status.
fwGuidLights [WFS_SIU_BILLACCEPTOR]
Specifies whether the Guidance Light Indicator on the bill acceptor unit should report whenever it changes status.
fwGuidLights [WFS_SIU_ENVDISPENSER]
Specifies whether the Guidance Light Indicator on the envelope dispenser unit should report whenever it changes status.
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 enable or disable events to a port was invalid because the port does not exist.
WFS_ERR_SIU_SYNTAX The command was invoked with incorrect input data. E.g. an attempt to both enable and disable events to the same port was made.
Events The following additional events can be generated by this command:
Value Meaning
WFS_EXEE_SIU_PORT_ERROR A error occurred while enabling or disabling events on one or more ports.
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.