group-broadcast

Description

The group-broadcast block accepts a single input and has no outputs. Every value received on the input is broadcast to all matching blocks found within the selected project scope.

This scope can be either an entire flow tab or a single group. As a result, one input signal can control multiple blocks of the same kind at the same time.

The list of recipients is determined dynamically for each new input value. This means the block takes the current project state into account and sends data only to recipients that are currently available.

A recipient may be unavailable, for example, when it exists in the project but has not been configured correctly, is disconnected, or reports an error that prevents normal operation.

Configuration parameters

Parameter name	Value
scope_id	Required parameter specifying the identifier of the scope in which recipients should be searched. It can point to an entire flow tab or to a single group.
block_type	Required parameter specifying the type of target blocks. The value must exactly match the type of the intended recipients, for example dimmer.

Input handling

The block allows multiple connections to its only input.

The block supports all input value types because it forwards exactly the same value that it receives.

Each input value is processed as follows:

• recipients are searched within the configured scope_id,
• only blocks matching the configured block_type are selected,
• recipients that are currently unavailable for control are skipped,
• the same input value is forwarded to all remaining recipients.

Ignored cases:

• recipients that are currently unavailable,
• situations where there is currently no available recipient matching block_type within the selected scope.

Block outputs

The block has no outputs.

Block status description

For a correctly initialized block, the status description has the following form:

X block_type: last_value

where:

• X is the number of currently available recipients included during the last description refresh,
• block_type is the configured target type,
• last_value is the last value actually broadcast by the block or null if nothing has been sent yet.

The recipient count in the description is refreshed after the project starts and after each new input value. Between consecutive input changes, the description may be temporarily outdated if recipient availability changes on its own.

Errors returned by the block

The block can return the following errors:

Error code	Error description
Missing scope_id configuration.	The scope_id parameter was not provided or is empty.
Missing block_type configuration.	The block_type parameter was not provided or is empty.
Input disconnected.	No other block is connected to the block input.
No matching blocks in selected scope.	No block matching the configured block_type was found in the selected scope.
No connected blocks in selected scope.	Matching blocks exist in the selected scope, but none of them is currently available.

Examples

1. If scope_id points to a group containing three dimmer blocks and two of them are currently available, then after initialization the block description will be 2 dimmer: null.

2. If later the value 75 appears on the input, the block will forward it to those two recipients and update the description to 2 dimmer: 75.