boneIO Documentation | Output Groups

Allows creating a group from several selected outputs. Useful in many different situations.

Web application configuration

Recommended configuration method.

A view allowing for the preview of defined output groups, their types, assigned areas, and all-on behavior.

Output groups menu view

Basic settings view

Option name	Description
ID	Group identifier that will be used in MQTT topics and actions.
Name	Group name visible in the web interface, MQTT, remote devices, and Home Assistant.
Member outputs	List of outputs to be included in the given group.
Output Type	The type of device the group will represent in HA.
Area	Selection of the appropriate area.

Advanced settings view

Option name	Description
All On Behavior	Option allowing to change the group behavior; when enabled, the group has an "on" status only when all its member outputs are on.

You can group outputs of type switch or light.

Sample configuration for an output group

output_group:
  - id: LightsGroup
    output_type: light
    all_on_behaviour: False
    outputs:
      - light1
      - light2

id (Optional, string, default: value {kind}_{pin}) - uniquely identifies this device in MQTT and Home Assistant.
outputs (Required, list) - List of output IDs to group.
output_type (Required, string, allowed_values: ['switch', 'light', 'none']) - The type of output. Switch/light appears as such a device in Home Assistant. The value none means this output is not published to MQTT. It is for internal use by other components only, e.g., covers.
all_on_behaviour (Required, boolean, default: False) - Determines the behavior: whether all outputs must be on, or if any output being on is sufficient. If set to true, the group is displayed as ON when all outputs are on; otherwise, if any output is on, the group is on.