https://github.com/depuits/esphome-abutt

Simplefied button sensor for multi clicks in esphome
https://github.com/depuits/esphome-abutt

Last synced: about 2 months ago
JSON representation

Simplefied button sensor for multi clicks in esphome

• Host: GitHub
• URL: https://github.com/depuits/esphome-abutt
• Owner: depuits
• Created: 2021-05-17T08:38:04.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2023-01-12T17:47:10.000Z (almost 2 years ago)
• Last Synced: 2023-02-26T16:56:37.787Z (almost 2 years ago)
• Language: C++
• Size: 25.4 KB
• Stars: 1
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Esphome AButt custom component

Custom component for [esphome](https://esphome.io/) which aims to have a simplified multiclick button component in place of the [binary sensor on multiclick](https://esphome.io/components/binary_sensor/index.html?highlight=binar#binary-sensor-on-multi-click). This implementation uses the [AButt library](https://github.com/depuits/AButt).

## Usage

Button presses are registered as a value change with. The value reporterd is the number of time the butten was clicked in sequence. So a single press will report 1, double click will report 2, tripple click 3 and so on to the maximum defined clicks. When the button is pressed and hold the sensor will report -1 and 0 when it's released again.

### Example

``` YAML

external_components:

  source: github://depuits/esphome-AButt

sensor:

  - platform: AButt

    name: "Button"

    pin:

      number: GPIO0

      inverted: True

      mode: INPUT_PULLUP

    debounce: 50

    on_value:

      then:

        - if:

            condition:

              lambda: 'return x == 1;'

            then:

              - light.toggle: wall

        - if:

            condition:

              lambda: 'return x == 2;'

            then:

              - light.toggle: ceiling

        # add conditions like you wish

        # -1 = hold

        #  0 = release

        # any other number is the number of presses to the max defined

```

### Options

| Option     | Description                                                                                 | Required | Default value |

|------------|---------------------------------------------------------------------------------------------|----------|---------------|

| pin        | Pin conected to the button                                                                  | x        |               |

| debounce   | Amount of ms before a press is registered                                                   |          | 50            |

| clickDelay | Ms before a click is registered as a new sequense                                           |          | 500           |

| holdDelay  | Time before a click is registered as hold                                                   |          | 700           |

| maxClicks  | Maximum number of clicks in a sequence (after this amount a new sequence is always started) |          | 5             |

## Example of same behavior with binary_sensor

``` YAML

binary_sensor:

  - platform: gpio

    pin:

      number: GPIO0

      inverted: True

    name: "Button"

    on_multi_click:

    - timing:

        - ON for at most 1s

        - OFF for at most 1s

        - ON for at most 1s

        - OFF for at least 0.2s

      then:

        - logger.log: "Double Clicked"

        - light.toggle: ceiling

    - timing:

        - ON for 1s to 2s

        - OFF for at least 0.5s

      then:

        - logger.log: "Single Long Clicked"

    - timing:

        - ON for at most 1s

        - OFF for at least 0.5s

      then:

        - logger.log: "Single Short Clicked"

        - light.toggle: wall

```