4.4 WFS_CMD_SIU_SET_INDICATOR

Description This command is used to set the status of an Indicator.

Input Param LPWFSSIUSETINDICATOR lpSetIndicator;

typedef struct _wfs_siu_set_indicator
{
WORD wIndicator;
WORD fwCommand;
} WFSSIUSETINDICATOR, * LPWFSSIUSETINDICATOR;

wIndicator
Specifies the index of the Status Indicator to set as one of the following values:

Value Meaning

WFS_SIU_OPENCLOSE Set Open/Close indicator for the consumer.

WFS_SIU_FASCIALIGHT Turn on/off the fascia light.

WFS_SIU_AUDIO Turn on/off the audio indicator.

WFS_SIU_HEATING Turn on/off the heating device.

fwCommand
Specifies the commands for the open/close indicator, fascia light, audio indicator and heating device, as one of the following flags:

Value Meaning

WFS_SIU_CLOSED The Open/Close indicator is changed to show that the terminal is closed for a consumer.

WFS_SIU_OPEN The Open/Close indicator is changed to show that the terminal is open to be used by a consumer.

WFS_SIU_OFF The Audio Indicator, Fascia Light or Heating is turned off.

WFS_SIU_ON The Fascia Light or Heating is turned on.

WFS_SIU_KEYPRESS The Audio Indicator sounds a key click signal.

WFS_SIU_EXCLAMATION The Audio Indicator sounds a exclamation signal.

WFS_SIU_WARNING The Audio Indicator sounds a warning signal.

WFS_SIU_ERROR The Audio Indicator sounds a error signal.

WFS_SIU_CRITICAL The Audio Indicator sounds a critical error signal.

WFS_SIU_CONTINUOUS The Audio Indicator sound is turned on continuously.

See WFS_CMD_SIU_SET_PORTS command for a detailed description.

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.

WFS_ERR_SIU_PORT_ERROR A hardware error occurred while executing the command.

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 the status of the indicator.

Comments None.