LightA Function Block
This function block is used to control a light for On/Off, dimming or for a staircase application. To reliably detect a short push-button action, directly wired push-buttons are read in directly within the function block (do not enter the function block via an input slot). The wired outputs are also provided within the function block (not via output slots). The function block should be able to recognize a short keystroke with >= 50 msec. There will be fast reaction in the light output level, if the light is dimmed by the push button. Maximum 8 LightA function blocks can be used in an application.
Note: To achieve the best performance for the operation of light, the light function block must be put into the Event program folder. As soon as a wired button is pressed or a Modbus message is received (the Modbus function block must also be in the Event Program Folder for this to happen), the Event Program Folder is executed immediately
LightA has input slots with different priorities: Emergency, Motion Brightness Sensor, Manual, and Application.
The emergency input has the highest priority. If the emergency command command is active, motion brightness sensor, manual override command and application command inputs are deactivated. It is used during fire alarm, where all buttons and motion sensors are deactivated. After termination of the Emergency condition the Emergency Input must be set to "101=DoNothing".
A motion detector can be connected. This allows the light to be switched on and the logic to prevent it being switched off if motion is detected during darkness. It can also be used only for switching off. The detailed operation can be set of the FunctionBits. It should prevent people from standing in the dark. If auto off timer is activated via function bits, then the light will switch off after the auto off timer expires and there is no motion detected.
The manual input is used to enable manual operation. For example, via external BACnet pushbuttons or via Niagara graphics. The manual input and the directly wired keys work as per the "Last Wins" principle. Commands via the manual input are executed once when the input is changed. The manual command has higher priority than the application input. As soon as the manual input receives a command, a LockTime is started. This ensures that the manual command (e.g. the button) is valid for a certain time and is not immediately overwritten by the application. Normally, the Manual Ovrd Cmd input is always set to "Do Nothing". Only when the manual command is triggered by pressing an external button or by an external wall module, the command is converted into a valid command (i.e. 50%) for a DDC cycle. Afterwards the input at the function block must be set to DoNothing again.
The application input serves as input of the self-programmed "automatic" logic. The input has the lowest priority. Depending on brightness, room occupancy, different Logic can be programmed which can be overridden by a manual operation (directly wired or over manual inputs). While the optional LockTime is running, various automatic commands can be set on the application input, e.g. Light Off because it is bright outside. All these commands are not executed if the LockTime is running. As soon as the LockTime has expired, the last valid Application command is executed. Here, too, the principle applies that normally a "Do Nothing" is present at the input and only when a change occurs, e.g. a change from dark to bright, a valid light command is set for one DDC cycle. Afterwards the application input at the function block must be set to "DoNothing" again.
An important feature in this cause. The programmer can optionally add a cause to the function block. Depending on which input is currently being used (whether via one of the 2 input slots or directly wired), the correct cause is given to the output. This makes it easy to see why the function block behaves like this.
Figure 3: LightA Function Block |
Figure 4: LightA Property Sheet |
Inputs
Input Name |
Description |
Emergency Cmd |
The emergency input has the highest priority. The manual operation (wired or via manual) as well as the application cmd are ignored.
|
Emergency Cause |
For debug reasons it is good to have a cause to understand why the light is in this state. This input is looped through to the Out Cause when the EmergencyCmd is executed. Since many causes can also be used for the BlindA function block, it is recommended to use the same values for both function blocks. User defined causes start with the value >= 100. Examples:
|
Motion Brightness Sensor |
This is used to connect a motion detector including a brightness sensor, as it is typically offered in DIY stores. Depending on the FunctionBits, the light can, for example, only be switched On or only switched Off or both On and Off. 1 means that the light can be Off because there is no occupancy or because it is bright. 2 - 4 means that there is Occupancy detected during darkness and depending on the Function Bits, the light behaves accordingly for switching ON or it ignores some Off commands. Note: If an ON-command (2-5) occurs while the light is already ON, then there is no need to switch the light ON; the light keeps on the current light level.
|
Manual Override Cmd |
This input serves as manual operation via an external wall module or external push-buttons (BACnet, Modbus etc) or via a Niagara graphic. The input is only evaluated in the DDC cycle, where this input receives a new value e.g. from "Do Nothing"-> "80%" or from "ManOn" -> "ManOff". To repeat a command, a "Do Nothing (101)" must be set in between. Please also look for the "3 upper bits" description in the command list. (See *1).
The command does exactly what the wired button with a short press would do. Between the command and the wired button there is a Last Wins mechanism. It’s not possible to enable the Extension or Permanent time feature with this command. The command does also not dim the light. If the (Modbus) Button is released, then DoNothing is expected. If after 109 a 309 command is received, then the AutoOffTime should be restarted. Note: If the Command 104 (Start Dimming) is given, but Command 110 (ManRelease) is not given, then the light dims max. 10x and then it sets to light to the Switch On value and the Cause to 28. |
Manual Addressed Cmd Bits |
This input is used if a pushbutton connected to another light function block should operate with this function block. The value is bitcoded and contains the light address and the light value. This input has the same priority like Manual Override Cmd and the hardwired Push Buttons. The value "null" deactivates the Addressing Feature |
Application Cmd |
The application input has the lowest priority. The manual operation (wired or via manual) is still working. The input is used to set the automatic control to fullfill i.e. EN15232 programmed in the wiresheet. The last command before DoNothing is stored in RAM so that it can be executed when the Locktime has expired or if the command is Last Valid Application Cmd i.e. from EmergencyCmd or Manual Override Cmd. Note: If the last command is a 0% command to turn off the light, the command will be ignored if the MotionBrightness sensor is configured accordingly and detecting Occupied+Dark.
|
Application Cause |
For debug reasons it is good to have a cause to understand why the light is in this state. This input is looped through to the Out Cause when the Application Cmd is executed. Since many causes can also be used for the BlindA function block, it is recommended to use the same values for both function blocks. User defined causes start with the value >= 100. Examples:
|
Lock Time (In & Par) |
After a manual command (wired or via Manual Override), a Lock Time is activated to ignore the application cmd for this time. This prevents the application from immediately overriding / canceling the manual command. 0 min and "null" means No Lock. Range: 0-1080min, default=Null |
Reset Bits |
This can be used to reset various states. 1=Reset Auto off Timer (including permanent and extension time). If a SwitchOffWarning is configured, then the switch off warning is started. 2=ResetSwitchOffDelay 4=ResetLockTime 8=ResetLastValidApplicationCmd |
Min Output (In & Par) |
Dimming is performed between Min Output and Max Output if the corresponding FunctionBits are set. 0-100%, default=Null |
Max Output (In & Par) |
Dimming is performed between Min Output and Max Output if the corresponding Function Bits are set. 0-100%, default=Null |
Switch On Output (In & Par) |
This defines the switch-on Output for a dimmable lamp. The lamp is switched on with this value. If the Operation Mode Bit "Memory" is activated, the SwitchOnValue is used until a "Memory" value has been learned after manual dimming. 0-100%, default=Null |
Auto Off Time |
The AutoOffTime is used to automatically switch off a lamp after a time period that can be set here. This function can be used in a staircase with a short time, but also for an office with a long time (e.g. 12 or 24 hours). Switching Off is prevented via the Motion Brightness Sensor input. In addition, an OFF warning can be activated so that the room user is warned before switching off. In this case, the switch-off warning is issued after the Auto Off Time has expired. The Operation Mode Bit and Auto Off Time needs to be set. In the staircase, the time can be extended up to 4 times by pressing the button. 0-7200.0 min, Default=Null |
Switch Off Delay Time |
The Switch Off Time can be used to delay the automatic switch-off by a few seconds. If, for example, several lamps in an office are switched off by the same Application Logic, you can achieve that they are switched off in a time sequence and not simultaneously. This prevents that all lamps perform the OffWarning at the same time or that someone is in the dark. 0-86400sec, Default=Null |
Function Bits (In & Par) |
This configures the behaviour of the lamp under various conditions.
|
Operating Mode Bits |
Sometimes the given priority of the emergency, manual and application command inputs does not fit. Certain operating modes or enabling and disabling of some extra features are necessary in order to implement the desired function.
|
Table 1: Inputs of LightA Function
*1 These values can also be used alternatively. If you want to repeat the same command, you can alternately use one and the other value.
*2
Function Bits for Automatic switching On or Off within the Functionblock:
Function Bits to enable additional Features:
For Staircase only:
Output
Output Name |
Description |
Out Feedback |
The output indicates the current controlled light value, which is output at the terminals.
|
Out Button Bits |
Often it is important to know whether the button has been pressed, e.g. to restart timers in the application logic,
The detection of a button press happens after releasing the button or after 2sec. The output is set only for 1 DDC cycle. Example: After releasing a long button press, Out Button Bits = 5. |
Out Status Bits |
Various states can be read from the function block via this output.See also Out Remaining Time.
|
Out Remaining Time |
There are different timers, but only 1 timer is running at a certain time:
Whenever one of these timers is running, the remaining time in seconds is shown here. The Lock Time is not shown. See also Out Status Bits. |
Out Cause |
The Out Cause provides different states for diagnosis to see at a glance what is currently happening in the FB. Since the Emergency and Application Logic is programmed by the user, the Cause inputs of Emergency and Application are looped through to Out Cause when the corresponding Cmd has been executed (and the Light is controlled). If the Cause inputs have the value null and an Emergency Cmd or Application Cmd was executed, then Out cause is set to the values Emergency Cmd or Application Cmd.
Reserved until 99 for firmware enhancements. |
Out Manual Addressed Cmd Bits |
The connected push button can be used for other lamps represented by other function blocks. The value is bit-coded and serves as input signal for other light function blocks. The value contains the light address and the light value. The meaning of the individual bits is explained separately. |
Table 2: Outputs of LightA Function
Parameter
Parameter Name |
Description |
Light Control Type |
Set the Light control type.
Note: If the light contol type is set to Not used, then function block will be disabled. |
Lock Time Par (In & Par) |
Type the manual command Lock Time in minutes. After a manual command (wired or via Manual Override), a lock time is activated to ignore the application cmd for this time. This prevents the application from immediately overriding / canceling the manual command. 0 min and "null" means No Lock. Default=0min. |
Expert Mode |
Set the mode Standard / Expert The expert mode will enable the light addressing. |
Push Button 1 Terminal |
Basically, 2 inputs are supported to switch or dim the light. According to the configured button behaviour, only 1 input or 2 inputs are necessary. The inputs are typically connected with pushbuttons, but it is also possible to connect the inputs to another controller to switch the light via pulses. 1=UI1, 2=UI2, 255=NotConnected |
Push Button 1 Behavior |
The configuration is intended to adapt the button operation to different needs. If the same functionality can be performed from both inputs via the same configuration, then the inputs are ored. Enum: 1=IgnoreButtonForLight, 2=OnOff, 3=OnOffDimming, 4=On, 5=Off, 6=OnDimmingUp, 7=OffDimmungDn, 8=Staircase |
Push Button 2 Terminal |
See description of Push Button 1 Terminal |
Push Button 2 Behavior |
See description of PushButton 1 Behavior |
Light Address |
Set the light address decimal value. If the push button input is shared from one LightA function block to another LightA function block , then light address needs to be set. A maximum of 16 lights can be controlled from a single push button. NotUsed = 0, 1, 2, 4, 8, 16, 32, 64, 128, 256, 512, 1024, 2048, 4096, 8192, 16384, 32768. |
Push Button1 Address Bits |
Normally there are 1 or 2 push buttons for each light function block, which can only switch the light which is controlled by the function block. However, if a pushbutton is to switch a light in another function block, then address of the other light must be selected here. Example: This push button should work with this light (i.e. LightAddress = 01) and with Light 02 and Light 08 => Enter 1 + 2 + 8 = 11.0 |
Push Button2 Address Bits |
See description of Push Button1 Address Bits. |
Push Button Dimming Send On Delta |
This setting is only used, if one of the buttons is used to switch a light from another function block. When dimming, the current value is sent to the other lamp when a certain change occurs. If the other lamp is in the same controller, the offset is only 1 DDC cycle (500msec). Default=1%. |
Power Terminal |
This defines the terminal that supplies the lamp with power to drive the lamp. In the case of an on/off lamp, this is used to switch the lamp on and off. In the case of a dimmable lamp, this is used for the power supply while the Light Dimming Terminal is used to adjust the brightness. A dimming lamp dim between 0.1 - 100%. RO1, RO2, RO3, RO4, TO1, TO2, TO3, TO4, Default=NotConnected |
Dimming Terminal |
This terminal is only used with a dimmable lamp. AO1, AO2, AO3, AO4, AO5, AO6, Default=NotConnected |
Dimming Terminal Characteristics |
Set the characteristics. See also Min Output and Max Output.
|
Min Output Par (In & Par) |
Dimming is performed between Min Output and Max Output, if the corresponding Function Bits are set. Default=10%. |
Max Output Par (In & Par) |
Dimming is performed between Min Output and Max Output if the corresponding Function Bits are set. Default=100%. |
Switch On Output Par (In & Par) |
Set the Switch On Output value in percentage. This defines the Switch On Output for a dimmable lamp. The lamp is switched on with this value. If the Operation Mode Bit "Memory" is activated, the Switch On Value is used until a "Memory" value has been learned after manual dimming. Note: The memory value is lost after Power Up. The Switch On Output value should be between Min Output and Max Output. If "On_After_PowerUp" is enabled, then the light is switched on to this value too. Default=100%. |
Dimming Speed |
The "Dimming Speed" is only relevant when dimming via the push buttons. According to the PushButtonBehavior, dimming only takes place when the Push Buttons are pressed for a long time, i.e. only then will the dimming take place between 0.1-100% or between MinOutput and MaxOutput according the dimming speed. For all other commands via EmergencyCmd, MotionBrightnessSensor, ManualOverrideCmd, ApplicationCmd the DimmingSpeed is ignored, but the SoftSpeed is relevant. Example: A short press switches the light On or Off immediately according the SoftSpeed, but without the DimmingSpeed. A long press dims the light between MinOutput and MaxOutput according to the DimmingSpeed but without the SoftSpeed. The DimmingSpeed always refers to a dimming range of 0.1-100% or 100-0%, independent of MinOutput and MaxOutput. Example: DimmingSpeed=10sec, Min=10%, Max=90% => Dimming between 10% and 90% requires 8sec. 1-300.0sec, 10.0sec |
Soft Speed |
If the operation mode bits Enable_SoftOn_DimUp, Enable_SoftOn_DimDown or Enable_Soft_Off are activated, the light is not switched on or off abruptly, but the light is softly dimmed up or down. The time describes the speed of dimming from 0.1-100% and vice versa. 1-300.0sec, 2.0sec |
Auto Off Time Par (In & Par) |
See the Input Auto Off Time for description. Default= 1440min. |
Permanent Time |
The Permanent Time is activated and deactivated in the staircase via a long press. This allows the staircase light to be switched on for a long period of time if required. See OperationModeBit Enable_PermanentTime. 0-10000min, 180 min |
Switch Off Delay Time Par
|
See the Input Switch Off Delay Time for description. Default= 30sec. |
Function Bits Par (In & Par) |
This configures the behaviour of the lamp under various conditions.
|
Operating Mode Bits Par
|
See the Input Operating Mode Bits for description. Default= 0. |
Table 3: Parameter of LightA Function
The below diagram explains the light addressing.
Figure 5: Example: LightA Function Block
Examples
Lights Simple On/Off
Below is the example for simple light on/Off. Any input terminal will be configured as push button Eg: UI1 is configured as an OnOff push button. First press switches the light "On". Second press "Off". If a Lock Time is entered, then the light remains for the Lock Time in the manually switched position (if no Emergency Command comes in). An Application Cmd on the input is ignored then. If the lock time is expired, then the light switches to the last application command. Any output terminal will be configured as output Eg: "R01".
LightOnOff (Light Ref 01) |
|
LightOnOffTimer / LightDimmingTimer (Light Ref. 05) +On_If_Occ_and_Dark |
LightOnOffTimer / LightDimmingTimer (Light Ref. 06) +Off_If_Unocc_or_Bright
+On_If_Occ_and_Dark |
Figure 6: Example- Light OnOffTimer / LightDimmingTimer
Below is an example for an application command. An Application command is on based on the combination of conditions like Occupancy schedule, brightness, darkness, time, etc.
Figure 7: Light A function Block- Application Command
Light OnOffTimer / LightDimmingTimer
The below example is for light OnOffTimer/ LightDimmingTimer+Off_If_AutoOffTime_is_expired. Any input terminal will be configured as push button Eg: UI1 configured as "On dimming Up" UI2. configured as "Off dimming down" and once the PB is pressed or application or manual command is on then the light will be ON until the auto off time par is expired then it will back to application command. Any output terminal will be configured as output Eg: "R01".
Light OnOffTimer / LightDimmingTimer (Light Ref. 02)
+Off_If_AutoOffTime_is_expired |
LightOnOffTimer / LightDimmingTimer (Light Ref 07)
+Off_If_AutoOffTime_is_expired +Enable_SwitchOffWarning
+On_and_Restart_AutoOffTimer_If_Occ_and_Dark +Off_If_Unocc_or_Bright |
|
Figure 8: Example- Light OnOffTimer / LightDimmingTimer
Light OnOffTimer / LightDimmingTimer with off delay timer
The below example is for Light OnOffTimer/ Light DimmingTimer=Off_If_AutoOfftime_is_expired with swith of delay timer. Any input terminal will be configured as push button Eg: UI1. will be On dimming Up UI2. will be Off dimming down and once the PB is pressed or application or manual command is on then the light will be ON until the auto off time par is expired then it will back to application command. Any output terminal will be configured as output Eg: "R01" and A01 is configured as dimming terminal. Switch off warning will three time turn off and turn on the lights with default of 30 secs delay.
LightOnOffTimer / LightDimmingTimer (Light Ref. 03) +Off_If_AutoOffTime_is_expired
+Enable_SwitchOffWarning |
LightOnOffTimer / LightDimmingTimer (Light Ref. 07) +Off_If_AutoOffTime_is_expired
+Enable_SwitchOffWarning +On_and_Restart_AutoOffTimer_If_Occ_and_Dark +Off_If_Unocc_or_Bright |
Light OnOffTimer / LightDimmingTimer (Light Ref. 12) + Off_If_AutoOffTime_is_expired=1
+ On_and_Restart_AutoOffTimer_If_Occ_and_Dark=1 + Off_If_Unocc_or_Bright=1 + Enable_Off_If_AutoOffTimer_is_expired_during_Occ_and_Dark=0 + Enable_SwitchOff30secDelay=1 + Enable_SwitchOffWarning=1 |
|
Figure 9: Example- Light OnOffTimer / LightDimmingTimer with off delay timer
The below example is for Light OnOff staircase. Any input terminal will be configured as push button Eg: UI1 will be configured as on switch or manual command or emergency command is on then the light will be ON until the auto off time par is expired. Any output terminal will be configured as output Eg: “R01 is configured as Light On. after the auto off time expired Switch off warning will three time turn off and turn on the lights with default of 30 secs delay.
LightOnOffStaircase / LightDimmingStaircase (Light Ref. 13) + Off_If_AutoOffTime_is_expired + Enable_SwitchOffWarning |
Figure 10: Example - LightA OnOff staircase |
|
LightOnOffStaircase / LightDimmingStaircase
The below is the example for Light OnOff staircase / LightDimming staircase. Any input terminal will be configured as push button Eg: UI1 will be configured as stair case and UI2 is configured as lights Off or manual command or emergency command is on then the light will be ON until the auto off time par is expired. Any output terminal will be configured as output Eg: "R01" is configured as Light On, A01 is configured as Dimming. After the auto off time expired Switch off warning will three time turn off and turn on the lights with default of 30 secs delay.
LightOnOffStaircase / LightDimmingStaircase (Light Ref. 14) + Off_If_AutoOffTime_is_expired + Enable_SwitchOffWarning + Enable_PermanentLight |
Figure 11: Example: LightOnOffStaircase / LightDimmingStaircase |
Staircase Ligh On /Off Auto off Timer extension
After each press of stair case pusbutton the auto off timer value will be multiplied.
LightOnOffStaircase / LightDimmingStaircase (Light Ref. 15) +Off_If_AutoOffTime_is_expired +Enable_SwitchOffWarning + ExtensionLight |
|
|
Figure 12: Example- LightA OnOff staircase
Push Button Behaviour:
Push Button Behavior |
Short Press (< 2sec) |
Long Press (>2sec-5sec) |
IgnoreButton |
This input is not used. |
This input is not used. |
OnOff |
Toggle the lamp value between Off and On. |
Toggle the lamp value between Off and On. |
OnOffDimming |
Toggle the lamp value between Off and the SwitchOnOutput or the Memory value if the OperationModeBit "Enable_On_With_Menmory_value" is enabled After power up the Memory value = SwitchOnOutput until is is dimmed manually. |
Dim the lamp between 0.100% or between Min and Max if theFunctionBits "Enable_LimitToMin"/ "Enable_LimitToMax" are enabled. |
On |
A rising edge from a pulse switches On the light. |
A rising edge from a pulse switches On the light. |
Off |
A rising edge from a pulse switches On the light. |
A rising edge from a pulse switches Off the light. |
OnDimmingUp |
If the light is Off: Switches On the light to the SwitchOnOutput or the Memory value if the OperationModeBit "Enable_On_With_Memory_Value" is enabled. |
If the light is Off: Switches On the light to 1% or to the Min value if the OperationModeBit "Enable_LimitToMin" is enabled (Do not switch On to the SwitchOnOutput or the Memory value). If the light is already On, then the light is dimmed up to 100% or to the Max value if the OperationModeBit "Enable_LimitToMax"is enabled. |
Staircase |
If the light is Off, then the light is switched On with 1 short button press. If the OperationModeBit "Extension" is enabled, the light is switched on in addition with a double click, triple click or quad click. Double click->2xAutoOffTime;tripe-> 3xAutoOffTime; quad -> 4xAutoOffTime). Double/Triple/Quad click means that the button is pressed within a shorter time frame than 1sec after the light is switched on with the first short button press. If the light is On for >1sec and the running Off timer is < 1xAutoOffTime, then a short button press sets the running Off timer to 1xAutoOffTime. If the PermanentMode is active, the short button press is ignored. See description on the right column. In principle the light can never be switched off via the push-button! |
If the OperationModeBit "Enable_PermanentTime" is enabled, then the Timer is started with the PermanentTime. This time is usually considerably longer (several hours), so that, for example, greater work can be carried out in the staircase without the light being switched off periodically. If the PermanentTime is already running, then a short press is ignored while a long press exits the permanent mode and restarts the timer with the AutoOffTime. |
Light Dimming (Light Ref 17) |
LightDimming (Light Ref. 19) +Enable_SoftOn_DimUp +Enable_Soft_Off |
LightDimming (Light Ref. 20) +SoftOnDimDn (Tubes) +Enable_Soft_Off +Enable_LimitToMin +Enable_LimitToMax |
Dimming with 1 Push Button (Light Ref. 21) + Enable_LimitToMin + Enable_LimitToMax |
Refer to General Description for general information about IRMN4 Function Blocks.