Event

Digital inputs used in the controller, presented as an Event entity in Home Assistant. Only works with Home Assistant version 2023.8 and newer! The Event entity sends an MQTT message for single, double, triple, long press actions, as well as action sequences.

Web application configuration

Recommended configuration method.

Sample webui configuration

View allowing for a preview of defined event entities, a preview of assigned actions, and the addition of new event entities. Additionally, it allows for their export and import.

Basic settings

Single / Double / Triple / Long

Action type - Opens a list of defined actions (available here). Depending on the selected action type, the available options change. Their list is in the tables below.

Output Action:

Cover Action:

Cover Over Mqtt Action:

Mqtt Action:

For Output Over Mqtt action:

For Remote Output action:

For Remote Cover action:

Sequences

The sequence view allows performing similar actions as the previous ones (single, double, etc.). In the case of sequences, after selecting the MQTT option - sequence action will be send in mqtt

Advanced Settings

YAML Editor

Sample configuration

event:
  - boneio_input: in_29
    name: Kitchen Button
    actions:
      single:
        - action: output
          boneio_output: OUT_01
          action_output: toggle

Configuration variables:

• name (string) - Display name in Home Assistant.

• boneio_input (Optional, string) - Reference to a predefined input configuration (e.g., in_01, in_02).

• area (Optional, string) - Reference to an area ID defined in the areas section. Creates a sub-device associated with the main BoneIO device.

• id (Optional, string) - Technical identifier used in MQTT topics and actions.

  • If boneio_input is set: id is optional (defaults to boneio_input value).
  • If boneio_input is NOT set: id is REQUIRED.
  • If both are set: id overrides boneio_input as the identifier.

• Available only when the boneio: section is configured. Used as the default ID if the id field is not specified.

• pin (Optional, string) - GPIO pin ID on the Beaglebone board, e.g., P9_33. Not needed when using boneio_input.

• gpio_mode (Optional, string, default: gpio, allowed_values: ['gpio', 'gpio_pu', 'gpio_pd', 'gpio_input']) - How to initialize this GPIO. gpio means default gpio mode. gpio_pu = gpio pull up, gpio_pd = gpio pull down, gpio_input - to be checked.

• clear_message (Optional, boolean, default: False) - Decides whether to send an empty message to MQTT after a pressed/released callback. Same as Zigbee2Mqtt does in button actions. Up to version 0.6.x, this was 'true' by default.

• bounce_time (Optional, timeperiod, default: 30ms) - Debounce time for GPIO in milliseconds. For advanced use only.

• double_click_duration (Optional, timeperiod, default: 220ms) - Time window in milliseconds to detect a double click. If a second click occurs within this time, it will be detected as a double click.

• long_press_duration (Optional, timeperiod, default: 400ms) - Time in milliseconds to detect a long press. If the button is held longer than this time, it will be detected as a long press.

• show_in_ha (Optional, boolean, default: True) - Send autodiscovery message to Home Assistant.

• device_class (Optional, string, default: button, allowed_values: ["button", "doorbell", "motion"]) - Type of device to be visible in Home Assistant.

• inverted (Optional, boolean, default: False) - Inverts the sensor input value displayed in MQTT.

• actions (Optional, dictionary) - Dictionary of predefined actions ([single, double, long]).

Configuration variables that can be omitted if using boneio: and boneio_input: configuration:

• pin (Required, string) - GPIO pin ID on the Beaglebone board, e.g., P9_33.
• gpio_mode (Optional, string, default: gpio, allowed_values: ['gpio', 'gpio_pu', 'gpio_pd', 'gpio_input']) - How to initialize this GPIO. gpio means default gpio mode. gpio_pu = gpio pull up, gpio_pd = gpio pull down, gpio_input - to be checked.

Actions

• single (Optional, list): List of actions to perform if the switch is pressed once.
• double (Optional, list): List of actions to perform if the switch is double-clicked.
• long (Optional, list): List of actions to perform if the switch is long-pressed.

Action variables for action list

• action (Optional, string, default: output, allowed_values: ['mqtt', 'output', 'cover']) - Action type. 'Output' and 'cover' mean the command is sent directly to the output relay or cover. This mode does not require a network to function. 'Mqtt' means an additional action is sent to MQTT. For example, you can directly control a second boneIO!
• boneio_output (Optional, string) - Reference to the output ID where the action is to be performed. Use with output action type. Recommended over the deprecated pin field.
• boneio_cover (Optional, string) - Reference to the cover ID where the action is to be performed. Use with cover action type. Recommended over the deprecated pin field.
• pin (Deprecated, string) - Older field for output/cover ID. Use boneio_output or boneio_cover instead.
• topic (Optional, string) - Topic to use if mqtt action is selected.
• action_cover (Optional, string, allowed_values: ['toggle', 'open', 'close', 'stop', 'toggle_open', 'toggle_close']) - Action to perform for the cover action type. toggle cycles between open/close. toggle_open alternates between open/stop, toggle_close alternates between close/stop.
• action_output (Optional, string, allowed_values: ['toggle', 'on', 'off']) - Action to perform for the output action type.
• action_mqtt_msg (Optional, string) - Message to send to the MQTT topic if the action is mqtt.

Binary

Digital inputs used in the controller, presented as a Binary sensor in Home Assistant. They send MQTT messages for pressed and released actions.

Web application configuration

Recommended configuration method.

Sample webui configuration

View allowing for a preview of defined binary inputs, a preview of assigned actions, and the addition of new binary inputs. Additionally, it allows for their export and import.

Basic Settings

Pressed Actions / Released Actions

Action type - Opens a list of defined actions (available here). Depending on the selected action type, the available options change. Their list is in the tables below.

Output Action:

Cover Action:

Cover Over Mqtt Action:

Mqtt Action:

For Output Over Mqtt action:

For Remote Output action:

For Remote Cover action:

YAML Editor

Sample configuration

    - name: IN_01
      boneio_input: IN_01
      actions:
        pressed:
          - action: output
            boneio_output: OUT_01

Configuration variables:

• name Name of the input defined by us in MQTT and Home Assistant.

• boneio_input (Optional, string, default) - Name of the boneIO controller input. Use underscore for spaces.

• pin (Required, string) - GPIO pin ID on the Beaglebone board, e.g., P9_33.

• actions (Optional, dictionary) - Dictionary of predefined actions ([pressed, released]).

• clear_message (Optional, boolean, default: False) - Decides whether to send an empty message to MQTT after a pressed/released callback. Same as Zigbee2Mqtt does in button actions.

• bounce_time (Optional, timeperiod, default: 120 ms) - Debounce time for GPIO before the callback. Use if the default value does not work for you. Setting it too high may interfere with "click" type events for the switch kind.

• show_in_ha (Optional, boolean, default: True) - Send autodiscovery message to Home Assistant.

• device_class (Optional, string, allowed_values: ['battery', 'battery_charging', 'carbon_monoxide', 'cold', 'connectivity', 'door', 'garage_door', 'gas', 'heat', 'light', 'lock', 'moisture', 'motion', 'moving', 'occupancy', 'opening', 'plug', 'power', 'presence', 'problem', 'running', 'safety', 'smoke', 'sound', 'tamper', 'vibration', 'window']) - Type of device to be visible in Home Assistant.

• inverted (Optional, boolean, default: False) - Inverts the sensor input value displayed in MQTT.

• initial_send (Optional, boolean, default: False) - If set to true, the initial status of the binary sensor will be sent to MQTT during application startup.

• kind (Optional, string, default: switch, allowed_values: ['switch', 'sensor']) - Type of device to send to Home Assistant. This kind indicates which actions you can use.

Actions

• pressed (Optional, list): List of actions to perform if the sensor is pressed.
• released (Optional, list): List of actions to perform if the sensor is released.

Action variables for action list

• action (Optional, string, default: output, allowed_values: ['mqtt', 'output', 'cover']) - Action type. 'Output' and 'cover' mean the command is sent directly to the output relay or cover. This mode does not require a network to function. 'Mqtt' means an additional action is sent to MQTT. For example, you can directly control a second boneIO!
• pin (Optional, string) - Output pin ID where the action is to be performed. Use only with output or cover action types.
• topic (Optional, string) - Topic to use if mqtt action is selected.
• action_cover (Optional, string, allowed_values: ['toggle', 'open', 'close', 'stop', 'toggle_open', 'toggle_close']) - Action to perform for the cover action type. toggle cycles between open/close. toggle_open alternates between open/stop, toggle_close alternates between close/stop.
• action_output (Optional, string, allowed_values: ['toggle', 'on', 'off']) - Action to perform for the output action type.
• action_mqtt_msg (Optional, string) - Message to send to the MQTT topic if the action is mqtt.