Skip to content

Update sensor.countdown_timer.markdown #1697

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 16 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
49 changes: 49 additions & 0 deletions source/_components/cover.tilt.markdown
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
---
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This file don't belong in this pull request.

layout: page
title: "Tilt Cover"
description: "Tilt Cover for Home Assistant"
date: 2016-12-20 22:00
sidebar: true
comments: false
sharing: true
footer: true
---


**Description:**
Tilt Cover for [Home Assistant](https://github.com/home-assistant/home-assistant)

Combines a tilt sensor and a relay switch to control a garage door opener or motorized gate.
When this switch is turned on it will toggle the relay to activate the garage door if it is
not already open. The reverse will happen when it is turned off.


````yaml
# Example configuration.yaml entry
cover tilt:
platform: tilt
covers:
front_garage_door:
tilt_sensor: binary_sensor.my_tilt_switch
switch: switch.my_relay_switch
contact_delay: 1
run_time: 10
````

- **covers** (*Required*): The array that contains all tilt covers.
- **identifier ** (*Required*): Name of the tilt cover. Multiple entries are possible.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Extra space breaking formatting after "identifier.

- **tilt_sensor** (*Required*): Binary Tilt Sensor.
- **switch** (*Required*): Relay switch that activates opener.
- **contact_delay** (*Optional*): on time for switch to simulate button press. default: 1 second.
- **run_time** (*Optional*): run time for the opener. default: 10 seconds.

**My hardware:**

[Ecolink z-wave tilt sensor](http://amzn.to/2ebYPgU)

[Z-wave relay Switch](http://amzn.to/2ec29bK)

Screenshot:
<p class='img'>
<img src='{{site_root}}/images/components/tilt/tilt-cover-screen.png' />
</p>
95 changes: 95 additions & 0 deletions source/_components/sensor.countdown_timer.markdown
Original file line number Diff line number Diff line change
@@ -0,0 +1,95 @@
---
layout: page
title: "Countdown Timer"
description: "Countdown Time for Home Assistant"
date: 2016-12-20 22:00
sidebar: true
comments: false
sharing: true
footer: true
---


**Description:**
Countdown Timer for [Home Assistant](https://github.com/home-assistant/home-assistant)

Combines one or more binary_sensors (typically PIR sensors)
and a switch to provide a switch that automatically
turns off after a specified delay time.

Creates a sensor that displays the time remaining before the
switch is turned off.

If the sensors detect activity while the switch is on then the timer is
restarted.

The can be accomplished otherwise in Home Assistant. However this component reduces
the user configuration from dozens of lines of automation and scripting
to just a few lines in the configuration.yaml file.

````yaml
# Example configuration.yaml entry
sensor countdown_timer:
platform: countdown_timer
timers:
lr_light:
sensors: binary_sensor.lr_pir1
switch: switch.lr_light_switch
````

- **timers** (*Required*): The array that contains all timers.
- **identifier ** (*Required*): Name of the timer. Multiple entries are possible.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Extra space breaking formatting after "identifier.

- **sensors** (*Required*): One or more binary sensor (comma separated).
- **switch** (*Required*): Light (or other) switch.
- **delay** (*Optional*): delay time. default: 20 seconds.
- **restart** (*Optional*): True/False, restart timer when HA is restarted. Default: False

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Part below this isn't needed in this documentation. In general documentation pages for components are minimized.

**My hardware:**

- [GE Lighting Control On/Off Switch, Z-Wave, In-Wall Switch](http://amzn.to/2ho17cN)
- [Ecolink Z-Wave PIR Motion Detector, Pet Immune - PIRZWAVE2-ECO](http://amzn.to/2il7FHH)

**My Config:**
```yaml
# My configuration.yaml entry

sensor countdown_timer:
platform: countdown_timer
timers:
lr_timed_light:
sensors: binary_sensor.lr_pir_sensor_7_0
switch: switch.lr_wall_light_switch_4_0
fr_timed_light:
sensors: binary_sensor.fr_pir_sensor_9_0 #,binary_sensor.fr_pir_2_sensor_10_0
switch: switch.fr_light_switch_19_0
restart: True
garage_timed_light:
sensors: binary_sensor.garage_side_pir_sensor_14_0 #,binary_sensor.garage_back_pir_sensor_13_0
switch: switch.garage_light_switch_12_0
restart: True
```
**Suggestions:**
```yaml
#In group.yaml something like this:

Living Room Light:
entities:
- binary_sensor.lr_pir_sensor_7_0
- switch.lr_wall_light_switch_4_0
- sensor.lr_timed_light

Living Room:
view: yes
entities:
- sensor.lr_temp
- group.nest_thermostat
- climate.homelr
- group.living_room_light
- group.media
- camera.living_room
```
**Screenshot:**

<p class='img'>
<img src='{{site_root}}/images/components/sensor/countdown-timer.png' />
</p>
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions source/images/components/sensor/countdown-timer.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Stray extra file. I don't think this should be here.

Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.