Version
0.8.x
Event entity for Input board¶
GPIO Inputs used in input board, presented as Event entity in Home Assistant. It works only with Home Assistant 2023.8 and newer!
Event entity sends mqtt message for actions single, double and long presses.
Example config¶
event:
- id: IN_29
pin: P8_36
actions:
single:
- action: output
pin: light
action_output: toggle
Configuration variables:¶
- id (Optional, string, default: value of
{pin}) - uniquely identifies this device in MQTT and Home Assistant. - pin (Required, string) - GPIO id of Beaglebone board eg
P9_33. - gpio_mode (Optional, string, default:
gpio, allowed_values:['gpio', 'gpio_pu', 'gpio_pd', 'gpio_input']) - How to run this gpio. gpio means default gpio mode. gpio_pu = gpio pull up, gpio_pd = gpio pull down, gpio_input - to be checked. - detection_type (Optional, string, default: new, allowed_values:
['new', 'old']) - There are 2 detector algorithms in dev version. Old consumes more CPU, but we got feedback that it works for everyone. new is more optimized, but needed users to test it. To get it done we introduced this option. - clear_message (Optional, boolean, default: False) - Decide if after press/release callback send empty message to mqtt. Same as Zigbee2Mqtt is doing in button actions. Till 0.6.x it was true by default.
- bounce_time (Optional, timeperiod, default: 25 ms) - bounce time for GPIO to invoke callback. Use if default doesn’t work for you. Making it to high might break click events functions for switch kind.
- 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 see in Home Assistant. - inverted (Optional, boolean, default: False) - Invert value of sensor input displayed in MQTT.
- kind (Optional, string, default: switch, allowed_values:
['switch', 'sensor']) - Type of device to send to Home Assistant. This kind indicate actions you can use. - actions (Optional, dictionary) - dictionary of predefined actions ([single, double, long]).
Actions¶
- single (Optional, list): list of actions to use if switch is single pressed.
- double (Optional, list): list of actions to use if switch is double pressed.
- long (Optional, list): list of actions to use if switch is long pressed.
Action variables for action list¶
- action (Optional, string, default: output, allowed_values:
['mqtt', 'output', 'cover']) - action type. Output and cover means that command is send directly to output relay or cover. This mode doesn’t need network to work. Mqtt mean that there is extra action send to mqtt. For example you can directly control second boneIO! - pin (Optional, string) - output pin id to perform action on. Use only with action type
outputorcover. - topic (Optional, string) - topic to use if
mqttaction is chosen - action_cover (Optional, string, allowed_values:
['toggle', 'open', 'close', 'stop', 'toggle_open', 'toggle_close']) - action to perform oncovertype action.toggleis actions between open/close.toggle_openmeans actions between open/stop,toggle_closemeans actions between close/stop. - action_output (Optional, string, allowed_values:
['toggle', 'on', 'off']) - action to perform onoutputtype action. - action_mqtt_msg (Optional, string) - message to send to mqtt topic if action is
mqtt.