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

Jump to bottom

Added documentation for Ring binary sensor #2231

Merged
merged 1 commit into from
Mar 31, 2017
Merged

Added documentation for Ring binary sensor #2231

merged 1 commit into from
Mar 31, 2017

Conversation

tchellomello
Copy link
Contributor

Description:
Added documentation for Ring binary sensors

Pull request in home-assistant (if applicable): home-assistant/core#6520

https://community-home-assistant-assets.s3.amazonaws.com/original/2X/f/f32ab302af330212fd4e6b69194a9e6961cd7131.png

Configuration

#configuration.yaml
binary_sensor:
  - platform: ring
    username: !secret ring_username
    password: !secret ring_password
    monitored_conditions:
      - ding
      - motion

@tchellomello tchellomello mentioned this pull request Mar 10, 2017
Merged
8 tasks
Landrash
Landrash approved these changes Mar 11, 2017
View reviewed changes
Copy link
Contributor

@Landrash Landrash left a comment

Choose a reason for hiding this comment

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

This can be merged if the parent pr isn't changed.
Some minor question about the config variables.

source/_components/binary_sensor.ring.markdown

- **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.

@Landrash Landrash added the new-integration This PR adds documentation for a new Home Assistant integration label Mar 11, 2017
fabaff
fabaff approved these changes Mar 13, 2017
View reviewed changes
Copy link
Member

@fabaff fabaff left a comment

Choose a reason for hiding this comment

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

Looks good to me 🐦

@fabaff fabaff merged commit 03c579a into home-assistant:next Mar 31, 2017
@tchellomello tchellomello deleted the ring_binary_sensor branch April 1, 2017 03:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Landrash Landrash Landrash approved these changes

@fabaff fabaff fabaff approved these changes

Assignees
No one assigned
Labels
new-integration This PR adds documentation for a new Home Assistant integration
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@tchellomello @fabaff @Landrash