Package de.gmxhome.conrad.jpos.jpos_base.lights

Interface LightsInterface

All Superinterfaces:

JposBaseInterface

All Known Implementing Classes:

LightsProperties

public interface LightsInterface
extends JposBaseInterface

Interface for methods that implement property setter and method calls for the Lights device category. For details about properties, methods and method parameters, see UPOS specification, chapter Lights. Further details about error handling can be found in introduction - Device Behavior Models - Errors.

Method Summary

Modifier and Type	Method	Description
void	switchOff(int lightNumber)	Final part of SwitchOff method.
void	switchOffPattern()	Final part of SwitchOn method.
void	switchOn(int lightNumber, int blinkOnCycle, int blinkOffCycle, int color, int alarm)	Final part of SwitchOn method.
void	switchOnMultiple(String lightNumbers, int blinkOnCycle, int blinkOffCycle, int color, int alarm)	Final part of SwitchOn method.
void	switchOnPattern(int pattern, int alarm)	Final part of SwitchOn method.

Methods inherited from interface de.gmxhome.conrad.jpos.jpos_base.JposBaseInterface

asyncMode, autoDisable, checkHealth, claim, clearInput, clearOutput, close, compareFirmwareVersion, dataEventEnabled, deviceEnabled, directIO, directIO, flagWhenIdle, freezeEvents, handlePowerStateOnEnable, newJposOutputRequest, open, powerNotify, release, removeFromPropertySetList, resetStatistics, retrieveStatistics, retryInput, retryOutput, unitDataCount, updateFirmware, updateFirmware, updateStatistics

Method Details

switchOff

void switchOff(int lightNumber)
        throws jpos.JposException

Final part of SwitchOff method. Can be overwritten in derived class, if necessary. This method will be called only if the following plausibility checks lead to a positive result:

• Device is enabled,
• lightNumber is between 1 and MaxLights.

Parameters:

lightNumber - light number between 1 and MaxLights.

Throws:

jpos.JposException - If an error occurs.

switchOn

void switchOn(int lightNumber,
 int blinkOnCycle,
 int blinkOffCycle,
 int color,
 int alarm)
       throws jpos.JposException

Final part of SwitchOn method. Can be overwritten in derived class, if necessary. This method will be called only if the following plausibility checks lead to a positive result:

• Device is enabled,
• lightNumber is between 1 and MaxLights,
• CapColor is COLOR_PRIMARY or color is one of the colors specified by CapColor,
• CapAlarm is ALARM_NOALARM or alarm is one of the alarms specified by CapAlarm.

Parameters:

lightNumber - light number between 1 and MaxLights.

blinkOnCycle - If blinking, light-on time in milliseconds.

blinkOffCycle - If blinking, light-off time in milliseconds.

color - Light color as specified by CapColor.

alarm - Alarm value as specified by CapAlarm.

Throws:

jpos.JposException - If an error occurs.

switchOnMultiple

void switchOnMultiple(String lightNumbers,
 int blinkOnCycle,
 int blinkOffCycle,
 int color,
 int alarm)
               throws jpos.JposException

Final part of SwitchOn method. Can be overwritten in derived class, if necessary. This method will be called only if the following plausibility checks lead to a positive result:

• Device is enabled,
• lightNumbers consists of a comma separated list of numbers between 1 and MaxLights,
• CapColor is COLOR_PRIMARY or color is one of the colors specified by CapColor,
• CapAlarm is ALARM_NOALARM or alarm is one of the alarms specified by CapAlarm.

Parameters:

lightNumbers - light numbers between 1 and MaxLights, separated by comma.

blinkOnCycle - If blinking, light-on time in milliseconds.

blinkOffCycle - If blinking, light-off time in milliseconds.

color - Light color as specified by CapColor.

alarm - Alarm value as specified by CapAlarm.

Throws:

jpos.JposException - If an error occurs.

switchOnPattern

void switchOnPattern(int pattern,
 int alarm)
              throws jpos.JposException

Final part of SwitchOn method. Can be overwritten in derived class, if necessary. This method will be called only if the following plausibility checks lead to a positive result:

• Device is enabled,
• pattern is one of PATTERN_CUSTOM1, PATTERN_CUSTOM2, ..., PATTERN_CUSTOM32.
• Only pattern set in CapPattern are specified in pattern,
• CapAlarm is ALARM_NOALARM or alarm is one of the alarms specified by CapAlarm.

Parameters:

pattern - Lightning pattern to be switched on.

alarm - Alarm value as specified by CapAlarm.

Throws:

jpos.JposException - If an error occurs.

switchOffPattern

void switchOffPattern()
               throws jpos.JposException

Final part of SwitchOn method. Can be overwritten in derived class, if necessary. This method will be called only if the following plausibility checks lead to a positive result:

• Device is enabled,
• CapPattern is not equal to LGT_PATTERN_NOPATTERN.

Throws:

jpos.JposException - If an error occurs.