diff --git a/source/_components/binary_sensor.insteon_plm.markdown b/source/_components/binary_sensor.insteon_plm.markdown index d06c324a442..9312a66cffd 100644 --- a/source/_components/binary_sensor.insteon_plm.markdown +++ b/source/_components/binary_sensor.insteon_plm.markdown @@ -18,5 +18,4 @@ an INSTEON PowerLinc Modem (PLM) device connected directly to your system on a USB or serial port. To add support, set up the primary [insteon_plm] component. -[insteon_plm]: /components/insteon_plm/ - +[insteon_plm]: /components/insteon_plm/ \ No newline at end of file diff --git a/source/_components/insteon_plm.markdown b/source/_components/insteon_plm.markdown index fff18634a17..53ac5745983 100644 --- a/source/_components/insteon_plm.markdown +++ b/source/_components/insteon_plm.markdown @@ -186,3 +186,57 @@ light: - platform: insteon_plm address: 1a2b3c ``` + +### {% linkable_title Events and Mini-Remotes %} + +Mini-Remote devices do not appear as Home Assistant entities. They generate +events. The following events are available: + +- **insteon_plm.button_on** + - **address**: (required) The Insteon device address in lower case without + dots (e.g. 1a2b3c) + - **button**: (Optional) The button id in lower case. For an 4 button remote + the values are a to d. For an 8 button remote the values are a to g. For + a one button remote this field is not used. +- **insteon_plm.button_of** + - **address**: (required) The Insteon device address in lower case without + dots (e.g. 1a2b3c) + - **button**: (Optional) The button id in lower case. For an 4 button remote + the values are a to d. For an 8 button remote the values are a to g. For + a one button remote this field is not used. + +This allows the mini-remotes to be configured as + +Here is an example of how to use these events for automations: + +``` +automation: + # 4 or 8 button remote with button c pressed + trigger: + platform: event + event_type: insteon_plm.button_on + event_data: + address: 1a2b3c + button: c + condition: + - condition: state + entity_id: light.some_light + state: 'off' + action: + service: light.turn_on + entity_id: light.some_light + + # single button remote + trigger: + platform: event + event_type: insteon_plm.button_on + event_data: + address: 1a2b3c + condition: + - condition: state + entity_id: light.some_light + state: 'off' + action: + service: light.turn_on + entity_id: light.some_light +```