https://github.com/syssi/esphome-total-count

https://github.com/syssi/esphome-total-count

esphome esphome-component hacktoberfest

Last synced: about 2 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/syssi/esphome-total-count
• Owner: syssi
• License: apache-2.0
• Created: 2022-04-04T19:06:23.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2024-08-07T16:14:15.000Z (5 months ago)
• Last Synced: 2024-11-02T14:51:31.407Z (2 months ago)
• Topics: esphome, esphome-component, hacktoberfest
• Language: Python
• Homepage:
• Size: 36.1 KB
• Stars: 1
• Watchers: 1
• Forks: 2
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

        
# esphome-total-count

![GitHub actions](https://github.com/syssi/esphome-total-count/actions/workflows/ci.yaml/badge.svg)

![GitHub stars](https://img.shields.io/github/stars/syssi/esphome-total-count)

![GitHub forks](https://img.shields.io/github/forks/syssi/esphome-total-count)

![GitHub watchers](https://img.shields.io/github/watchers/syssi/esphome-total-count)

[!["Buy Me A Coffee"](https://img.shields.io/badge/buy%20me%20a%20coffee-donate-yellow.svg)](https://www.buymeacoffee.com/syssi)

The total count component allows you to count the number of state changes of a binary sensor

```

# Example configuration entry

external_components:

  - source: github://syssi/esphome-total-count@main

total_count:

  binary_sensor_id: barrier

  restore: true

  min_save_interval: 300s

  initial_value: 0

  step: 1

sensor:

  - platform: total_count

    total_count:

      name: "${name} total count"

number:

  - platform: total_count

    total_count:

      name: "${name} total count"

button:

  - platform: total_count

    reset_counter:

      name: "${name} reset counter"

```

## Configuration variables

- **binary_sensor_id** (**Required**): The binary sensor to count state changes on.

- **name** (**Required**, string): The name of the sensor.

- **id** (*Optional*): Manually specify the ID used for code generation.

- **restore** (*Optional*, boolean): Whether to store the intermediate result on the device so

  that the value can be restored upon power cycle or reboot.

  Defaults to ``true``.

- **min_save_interval** (*Optional*, `config-time`): The minimum time span between saving updated values to storage. This is to keep wearout of memory low. Defaults to ``0s``.

- **initial_value** (*Optional*, float): The value to set the state to on setup if not

  restored with ``restore_value``.

## References

- https://github.com/esphome/issues/issues/664

- https://github.com/esphome/issues/issues/663