From edd35b2414c20f12579acec72bfd7eeafbdacc01 Mon Sep 17 00:00:00 2001 From: Fabian Affolter Date: Tue, 29 Aug 2017 21:54:26 +0200 Subject: [PATCH] Add documentation for counter component (#3250) * Add documentation for counter component * Fix typos --- source/_components/counter.markdown | 76 +++++++++++++++++++++++++++++ 1 file changed, 76 insertions(+) create mode 100644 source/_components/counter.markdown diff --git a/source/_components/counter.markdown b/source/_components/counter.markdown new file mode 100644 index 00000000000..7df1c2e6cf5 --- /dev/null +++ b/source/_components/counter.markdown @@ -0,0 +1,76 @@ +--- +layout: page +title: "Counter" +description: "Instructions how to integrate counters into Home Assistant." +date: 2017-08-26 06:00 +sidebar: true +comments: false +sharing: true +footer: true +logo: home-assistant.png +ha_category: Automation +ha_release: 0.53 +--- + +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: + +```yaml +# Example configuration.yaml entry +counter: + counter: + initial: 30 + step: 1 +``` + +Configuration variables: + +- **[alias]** (*Required*): Alias for the slider input. Multiple entries are allowed. + - **name** (*Optional*): Friendly name of the slider input. + - **initial** (*Optional*): Initial value when Home Assistant starts. Defaults to 0. + - **step** (*Optional*): Step value for the slider. Defaults to 1. + - **icon** (*Optional*): Icon for entry. + +Pick an icon that you can find on [materialdesignicons.com](https://materialdesignicons.com/) to use for your input and prefix the name with `mdi:`. For example `mdi:car`, `mdi:ambulance`, or `mdi:motorbike`. + +## {% linkable_title Services %} + +### {% linkable_title Media control 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.count0`. | + +#### {% 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.count0`. | + +#### {% 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.count0`. | + + +### {% linkable_title Use the service %} + +Select service developer tool icon **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**. + +```json +{ + "entitiy": "counter.count0" +} +``` +