[CMD_LGTG] Command lighting group

Function block CMD_LGTG distributes, at a particular priority, either a Present value or a Control command to multiple analog or binary BACnet lighting output objects for a specific Group data tag.

CMD_LGTG distributes, at a particular priority, either a Present value or a Control command to multiple analog or binary BACnet lighting output objects for a specific Group data tag. Both target state commanding and control command commanding are supported.

Proprietary objects are needed for the grouping infrastructure: one Group manager object and one or more Group member objects. The individual member data points (the lighting output objects) are grouped and referenced via the Group member object(s).

CMD_LGTG writes value / priority pair(s) for a particular Group data tag to the Group command property of the Group manager object. The data is passed from the Group manager object to the Group member object(s) where it is distributed to the intended lighting output objects with matching Group data tag.

Functioning

Compatible data points

Analog lighting output [LgtAOut]
Binary lighting output [LtgBOut]

Required properties of grouped data points

Present value
Control command (structured lighting output command)

Operate with priorities

The function block uses 2 approaches to control if operating with priorities:

1. Exclusive control (planned for priorities 1...5, 9...12, 14...16)

Initialized at startup

Multiple input sets of a function block cannot command the same priority.

2. Last win control (planned for priorities 7, 8, 13)

Not initialized at startup.

	Exclusive control Priorities: 1...5, 9...12, and 14...16	Last win control Priorities: 7, 8, and 13
Behavior at plant startup	[EnIn1] = 0 Release priority	[EnIn1] = 0 No release
Behavior at plant startup	[EnIn1] = 1 Command priority	[EnIn1] = 1 No command
Command process	If [EnIn1] changes from 0 to 1.	If [EnIn1] changes from 0 to 1.
	If [EnIn1] = 1 and [ValIn1] or [OpIn1] or [LvlIn1] or [StepIn1] change.	If [EnIn1] = 1 and [ValIn1] or [OpIn1] or [LvlIn1] or [StepIn1] change.
	If [EnIn1] = 1 and [RptcIn1] = 1.	If [EnIn1] = 1 and [RptcIn1] = 1.
Release	If [EnIn1] changes from 1 to 0.	If [EnIn1] changes from 1 to 0.
Release	If [EnIn1] = 0 and [RptcIn1] = 1.	If [EnIn1] = 0 and [RptcIn1] = 1.
Behavior in the event of commanding from another source	[EnIn1] = 0 Priority is not released by the function block.	[EnIn1] = 0 Priority is not released by the function block.
Behavior in the event of commanding from another source	[EnIn1] = 1 Priority is not commanded by the function block.	[EnIn1] = 1 Priority is not commanded by the function block.

The data point periodically saves the value of priority 8 to the controller memory. After a power outage, the value is restored in the property 'Priority array' and evaluated by the data point. All other priorities are not saved to the controller memory.

The operation with other input sets of the function block ([EnIn2]...[EnIn4], [ValIn2]...[ValIn4], [OpIn2]...[OpIn4], [LvlIn2]...[LvlIn4], [StepIn1]...[StepIn4], [RptcIn2]...[RptcIn4]) is the same.

Pins

Input	Description	Data type	Default value Value range
EnIn1…EnIn4	Enable input 1…Enable input 4 [EnIn1] controls whether [ValIn1] or [OpIn1] are commanded at the priority held by [PrioIn1] or if the priority is released. [EnIn1] belongs to one of four input sets, each containing [EnInX], [ValInX], [OpInX], [LvlInX], [StepInX], [PrioInX], [RptcInX], and [DscdcInX]. These input sets command the grouped lighting output objects at different priorities as needed. [EnIn1] can be parameterized (set by developer) or linked in the programming editor and calculated by the control program during runtime. The functionality of [EnIn2]...[EnIn4] is identical to [EnIn1].	Boolean	0
EnIn1…EnIn4	0 - Priority of [PrioIn1] is released if it is not currently active by a different [EnInX] set to 1. 1 - Priority of [PrioIn1] is commanded.
ValIn1...ValIn4	Value input 1...Value input 4 [ValIn1] is used to command the present value property at [PrioIn1] (target state commanding). [ValIn1] can be parameterized (set by developer) or linked in the programming editor and calculated by the control program during runtime. [ValIn1] is commanded at the present value with the priority held by [PrioIn1] in the following cases: [EnIn1] is 1 and [ValIn1] changes by a value equal or greater than [TshVal]. [EnIn1] is 1 and [ValIn1] changes to a limit value such as 0.0 or 100.0 ([TshVal] is ignored). The functionality of [ValIn2]...[ValIn4] is identical to [ValIn1]. Note If [ValIn1] is used, [OpIn1] must not be used and must remain at default value 32767.	Real	0.0
OpIn1…OpIn4	Operation input 1…Operation input 4 [OpIn1] is used to command the control command property ([LvlIn1] and [StepIn1]) at [PrioIn1]. [OpIn1] can be parameterized (set by developers) or linked in the programming editor and calculated by the control program during runtime. If [OpIn1] is equal to the maximum integer value, the input set runs as a target state command. For all other values, [OpIn1] serves as control command. [OpIn1] commands at the priority held by [PrioIn1], if [OpIn1] changes and [EnIn1] = 1. The functionality of [OpIn2]...[OpIn4] is identical to [OpIn1]. Note If [OpIn1] is used, [Valln1] must not be used.	Integer	32767: None
OpIn1…OpIn4	0: Stop 1: Dimming up 2: Dimming down 3: Step up 4: Step down 5: Switch-on 6: Switch-off 7: Go to level 8: Ramp up to 9: Fade to 32767: None
LvlIn1...LvlIn4	Level input 1...Level input 4 [Lvlln1] is part of the command field [OpIn1] and defines the target level for the input set. It is written to the lighting output object in conjunction with the commanding of [OpIn1] and is used in combination with some of the operation commands (for example Go to level, Fade to, Ramp to). [Lvlln1] can be parameterized (set by developer) or linked in the programming editor and calculated by the control program during runtime. The functionality of [LvlIn2]…[LvlIn4] is identical to [LvlIn1].	Real	0.0
StepIn1...StepIn4	Step input 1...Step input 4 [Stepln1] is part of the command field [OpIn1] and defines the step increment for the input set. It is written to the lighting output object in conjunction with the commanding of [OpIn1] and is used together with some of the operation commands (for example Step up and Step down). [StepIn1] can be parameterized (set by developer) or linked in the programming editor and calculated by the control program during runtime. The functionality of [StepIn2]...[StepIn4] is identical to [StepIn1].	Real	0.0
PrioIn1...PrioIn4	Priority input 1...Priority input 4	Integer	17
PrioIn1...PrioIn4	[PrioIn1] holds the priority that comes with [Valln1] or [OpIn1]. [PrioIn1] can be configured and cannot be changed during runtime. A value of 17 means that the input set is not used. The functionality of [PrioIn2]...[PrioIn4] is identical to [PrioIn1]. Note Input sets on the same function block must not share a common exclusive control priority. Priority range 1...16 (see restrictions on priorities 6 and 8 later). Exclusive control Priorities 1...5, 9...12, and 14...16 During control program startup, the function block uses exclusive control to initialize any assigned priorities in ranges 1...5, 9...12 and 14...16. This function block does not support exclusive priority control during runtime. The last valid command controls or releases priority. Due to exclusive control during startup, two or more input sets on the same function block must not share a common exclusive control priority, as this will result in conflicts. Last wins Priorities 7, 8, and 13 No initialization of priorities during startup. At runtime, the last valid command controls priority. If two or more input sets have the same priority and are commanded at the same time, only the input set with the first numeric order is performed (In1...In4). If two or more input sets have the same priority and conditions for commanding and releasing are given at the same time, the command operation wins. Priority 6 According to the BACnet standard, command priority 6 is reserved for minimum On/Off functionality. Commands at priority 6 are rejected by the BACnet object. For minimum On/Off functions, the control program must contain a logic and use another priority. Priority 8 According to the BACnet standard, command priority 8 is for manual operation use and is not typically assigned on the function block. Last wins functionality allows the control program to change or release an operator command.
RptcIn1...RptcIn4	Repeat command input 1...Repeat command input 4 [RptcIn1] repeats a command or releases a priority. If [RptcIn1] = 1 and [EnIn1] = 1, the function block repeats a command from [ValIn1] or [OpIn1], [LvIIn1], and [StepIn1] in each programming cycle with the priority from [PrioIn1]. If [RptcIn1] = 1 and [EnIn1] = 0, the function block releases the priority from [PrioIn1] in each programming cycle. The functionality of [RptcIn2]...[RptcIn4] is identical to [RptcIn1]. Note [RptcIn1] must not be forced permanently to 1. This may impact the performance or the network traffic. [RptcIn1] can be linked and is typically calculated and set by the control program.	Boolean	0
DscdcIn1...DscdcIn4	Discard command input 1...Discard command input 4 [DscdcIn1] is used to configure the repeat of the command of [ValIn1] on restart or when restoring communication to the automation station of the group manager. [DscdcIn1] can be configured, but cannot be changed during runtime. The functionality of [DscdcIn2]...[DscdcIn4] is identical to [DscdcIn1].	Boolean	0
DscdcIn1...DscdcIn4	0 - The group manager repeats the last command from [ValIn1] at priority [PrioIn1] on restart or once communication is restored to the automation station of the group manager. 1 - The group manager does not repeat the last command from [ValIn1] at priority [PrioIn1] on restart or once communication is restored to the automation station of the group manager.
TshVal	Threshold value [TshVal] is a configured value to control function block write attempts. An attempt is only permitted if the change of value is greater than or equal to [TshVal]. Exception: [TshVal] is ignored if the new value is a limit value such as 0.0 or 100.0. Note [TshVal] must not be set to 0.0.	Real	1.0
GrpTag1	Group data tag 1 [GrpTag1] defines a specific group data for the central distribution by the function block. [GrpTag1] is used only for target state commanding (present value, priority). The system provides predefined and customizable tags. Typically, the application engineer sets [GrpTag1] in the programming editor and it cannot be changed during runtime. A tag that matches the data type of the function block must be set.	Double Word	0
GrpTag2	Group data tag 2 [GrpTag2] defines a specific group data for the central distribution by the function block. [GrpTag2] is used only for control command commanding (control command, priority). The system provides predefined and customizable tags. Typically, the application engineer sets [GrpTag2] in the programming editor and it cannot be changed during runtime. A tag that matches the data type of the function block must be set.	Double Word	0
BaObjRef	BA-Object reference Link between function block and BACnet object.	Structure	---
BaObjRef > DeviceID	Device identifier [DeviceID] includes object type and object instance in one ID. Identifies the device object: local or remote. A local device object can also be identified by value 16#3FFFFF.	Double Word	16#3FFFFF
BaObjRef > ObjectID	Object identifier [ObjectID] includes object type and object instance in one ID. Identifies the object on a device.	Double Word	16#3FFFFF
BaObjRef > ItemID	Item identifier [ItemID] represents an index in a view node object that references the BACnet object. [ObjectID] and [ItemID] together define an indirect reference to the BACnet object. Value -1 indicates a direct interface.	Integer	-1

Output	Description	Data type	Default value Value range
Dstb	Disturbed [Dstb] indicates whether the referenced BACnet object was accessed. [Dstb] = 0, if: BACnet object access = Access successful [Dstb] = 1, if: BACnet object access = Error during access	Boolean	0
ErrCode	Error code indication	Integer	0: No error
= 0 - No error > 0 - Error codes

Output

Description

Data type

Default value
Value range

Dstb

Disturbed

[Dstb] indicates whether the referenced BACnet object was accessed.
[Dstb] = 0, if:
BACnet object access = Access successful
[Dstb] = 1, if:
BACnet object access = Error during access

Boolean

ErrCode

Error code indication

Integer

0: No error

= 0 - No error
> 0 - Error codes