Skip to content
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.

Sign up for GitHub

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

Added documentation for Ring binary sensor #2231

Merged
merged 1 commit into from
Mar 31, 2017
Merged

Added documentation for Ring binary sensor #2231

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
38 changes: 38 additions & 0 deletions source/_components/binary_sensor.ring.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
---
layout: page
title: "Ring"
description: "Instructions on how to integrate your Ring.com devices within Home Assistant."
date: 2017-03-10 10:00
sidebar: true
comments: false
sharing: true
footer: true
logo: ring.png
ha_category: Binary Sensor
ha_release: 0.40
---

The `ring` binary sensor allows you to integrate your [Ring.com](https://ring.com/) devices in Home Assistant.

Currently only doorbells are supported by this sensor.

To enable device linked in your [Ring.com](https://ring.com/) account, add the following to your `configuration.yaml` file:

```yaml
# Example configuration.yaml entry
binary_sensor:
- platform: ring
username: USERNAME
password: PASSWORD
monitored_conditions:
- ding
- motion
```

Configuration variables:

- **username** (*Required*): The username for accessing your Ring account.
- **password** (*Required*): The password for accessing your Ring account.
- **monitored_conditions** array (*Required*): Conditions to display in the frontend. The following conditions can be monitored.
Copy link
Contributor

Choose a reason for hiding this comment

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

Are both of these required? If not I think It should be marked as optional and to be removed from the minimal example.

If they generally are always monitored I don't see a reason to have them included by default by the component and remove the configuration variable.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Hello @Landrash,

By default there are not included or monitored. The user must specify which sensor to use.

https://github.com/tchellomello/home-assistant/blob/binary_sensor_ring/homeassistant/components/binary_sensor/ring.py#L46

The user can choose only one or 2 sensors. They are not dependent.

- **ding**: Return a boolean value when the doorbell button was pressed.
- **motion**: Return a boolean value when the a moviment was detected by the Ring doorbell.