home-assistant.io/source/_components/counter.markdown

layout, title, description, date, sidebar, comments, sharing, footer, logo, ha_category, ha_release, ha_qa_scale

layout	title	description	date	sidebar	comments	sharing	footer	logo	ha_category	ha_release	ha_qa_scale
page	Counter	Instructions on how to integrate counters into Home Assistant.	2017-08-26 06:00	true	false	true	true	home-assistant.png	Automation	0.53	internal

The counter component allows one to count occurrences fired by automations.

To add a counter to your installation, add the following to your configuration.yaml file:

# Example configuration.yaml entry
counter:
  my_custom_counter:
    initial: 30
    step: 1

{% configuration %}

'alias' should be replaced by the user for their actual value.

"[alias]": description: Alias for the counter. Multiple entries are allowed. required: true type: map keys: name: description: Friendly name of the counter. required: false type: string initial: description: Initial value when Home Assistant starts or the counter is reset. required: false type: integer default: 0 restore: description: Try to restore the last known value when Home Assistant starts. required: false type: boolean default: True step: description: Incremental/step value for the counter. required: false type: integer default: 1 icon: description: Icon to display for the counter. required: false type: icon {% endconfiguration %}

Pick an icon that you can find on materialdesignicons.com to use for your input and prefix the name with mdi:. For example mdi:car, mdi:ambulance or mdi:motorbike.

{% linkable_title Restore State %}

This component will automatically restore the state it had prior to Home Assistant stopping as long as you have the recorder component enabled and your entity has restore set to True which is the default. To disable this feature, set restore to False. Additional information can be found in the Restore state section of the recorder component documentation.

If restore is set to False, the initial value will only be used when no previous state is found or when the counter is reset.

{% linkable_title Services %}

Available services: increment, decrement, and reset.

{% linkable_title Service counter.increment %}

Increments the counter with 1 or the given value for the steps.

Service data attribute	Optional	Description
entity_id	no	Name of the entity to take action, e.g., counter.my_custom_counter.

{% linkable_title Service counter.decrement %}

Decrements the counter with 1 or the given value for the steps.

Service data attribute	Optional	Description
entity_id	no	Name of the entity to take action, e.g., counter.my_custom_counter.

{% linkable_title Service counter.reset %}

With this service the counter is reset to its initial value.

Service data attribute	Optional	Description
entity_id	no	Name of the entity to take action, e.g., counter.my_custom_counter.

{% linkable_title Use the service %}

Select Services from the Developer Tools. Choose counter from the list of Domains, select the Service, enter something like the sample below into the Service Data field, and hit CALL SERVICE.

{
  "entity_id": "counter.my_custom_counter"
}