Introduced Ring binary sensors and refactored Ring component #6520

tchellomello · 2017-03-10T21:57:52Z

Description:

Introduced Ring binary sensors.
Added unittest for binary sensors and sensors
Bump ring_doorbell 3rd party Python module
Updated documentation

Example entry for `configuration.yaml` (if applicable):

#configuration.yaml
ring:
    username: !secret ring_username
    password: !secret ring_password

binary_sensor:
  - platform: ring
    monitored_conditions:
      - ding
      - motion

sensor:
  - platform: ring
    monitored_conditions:
      - battery
      - last_activity
      - last_ding
      - last_motion
      - volume

HA Forum thread: https://community.home-assistant.io/t/ring-doorbell/7943

Pull request in home-assistant.github.io with documentation (if applicable): home-assistant/home-assistant.io#2231

Checklist:

If user exposed functionality or configuration variables are added/changed:

Documentation added/updated in home-assistant.github.io

If the code communicates with devices, web services, or third-party tools:

Local tests with tox run successfully. Your PR cannot be merged unless tests pass
New dependencies have been added to the REQUIREMENTS variable ([example][ex-requir]).
New dependencies are only imported inside functions that use them ([example][ex-import]).
New dependencies have been added to requirements_all.txt by running script/gen_requirements_all.py.
New files were added to .coveragerc.

If the code does not interact with devices:

Local tests with tox run successfully. Your PR cannot be merged unless tests pass
Tests have been added to verify that the new code works.

- Added unittest for Ring binary_sensor. - Bumped ring_doorbell 3rd party module.

balloob · 2017-03-17T06:39:08Z

homeassistant/components/binary_sensor/ring.py

+}
+
+PLATFORM_SCHEMA = PLATFORM_SCHEMA.extend({
+    vol.Required(CONF_USERNAME): cv.string,


Instead of having each platform require credentials, please add a component to manage the credentials and share the Ring instance by adding it to hass.data (a dictionary intended for sharing exactly such objects)

That is a good idea @balloob. I will work on that.

- Added unittest for Ring binary_sensor. - Bumped ring_doorbell 3rd party module.

houndci-bot · 2017-03-20T07:25:58Z

tests/components/binary_sensor/test_ring.py

+from unittest import mock
+
+import homeassistant.components.binary_sensor as sensor
+from homeassistant.components.binary_sensor import ring


'homeassistant.components.binary_sensor.ring' imported but unused

balloob · 2017-03-21T03:25:10Z

homeassistant/components/ring.py

+
+        ring = Ring(username, password)
+        if ring.is_connected:
+            RING = RingData(ring)


Use hass.data to store RING. Do not use globals.

I see. Thanks for the heads.

balloob · 2017-03-21T03:27:08Z

homeassistant/components/binary_sensor/ring.py

+
+    def update(self):
+        """Get the latest data and updates the state."""
+        self._data.check_alerts(cache=self._cache)


Why do you need to pass in the cache? That is something that should be handled by the shared data class.

The cache file is required for multiple sensors. It basically will save a pickle data file with the notification state shared by different sensors. The cache if required because it is shared on the object level and not on the account level which is shared by hass.data.

houndci-bot · 2017-03-27T03:12:41Z

homeassistant/components/sensor/ring.py

@@ -90,14 +65,15 @@ def setup_platform(hass, config, add_devices, discovery_info=None):

 class RingSensor(Entity):
    """A sensor implementation for Ring device."""
-
+  


blank line contains whitespace

tchellomello · 2017-03-27T05:55:51Z

@balloob code update. Please let know what you think now.

I'm working to update the documentation to support the new sensors and how to configure it using the hub concept.

Thank you!

balloob · 2017-03-29T06:07:45Z

homeassistant/components/binary_sensor/ring.py

+        self._data.check_alerts(cache=self._cache)
+
+        if self._data.alert:
+            self._state = bool(self._sensor_type ==


The == will always return a boolean, no need to make it one.

balloob · 2017-03-29T06:08:28Z

homeassistant/components/ring.py

+        from ring_doorbell import Ring
+
+        ring = Ring(username, password)
+        if ring.is_connected:


You want to return False if not connected, otherwise the component will be seen as set up correctly but the platforms will not be able to find the entry in hass.data

balloob · 2017-03-29T06:11:49Z

tests/components/test_ring.py

+
+def mocked_requests_get(*args, **kwargs):
+    """Mock requests.get invocations."""
+    class MockResponse:


We have exactly this functionality already available as requests_mock. See this example: https://github.com/home-assistant/home-assistant/blob/dev/tests/util/test_location.py#L62-L66

Thanks for this tip @balloob

tchellomello · 2017-03-31T09:50:58Z

@balloob code updated. Thank you!

balloob · 2017-03-31T15:53:53Z

Looks good! 🐬

- Introduced Ring binary_sensor.

48977f3

- Added unittest for Ring binary_sensor. - Bumped ring_doorbell 3rd party module.

homeassistant added cla-signed new-platform platform: sensor.ring labels Mar 10, 2017

tchellomello mentioned this pull request Mar 10, 2017

Added documentation for Ring binary sensor home-assistant/home-assistant.io#2231

Merged

Updated requirements

9e01fb0

homeassistant added the cla-signed label Mar 10, 2017

tchellomello mentioned this pull request Mar 10, 2017

0.40 #6509

Merged

Added correct file for unittest

10fe2b0

balloob requested changes Mar 17, 2017

View reviewed changes

tchellomello added 8 commits March 19, 2017 23:16

- Introduced Ring binary_sensor.

f9f4a62

- Added unittest for Ring binary_sensor. - Bumped ring_doorbell 3rd party module.

Updated requirements

944bc5e

Added correct file for unittest

b3ebf42

Added extra sensors last_ding and last_motion

85457d6

Modified Ring binary_sensor and sensor to inherit DOMAIN configuration

1970017

Moved static to top ring.py

42b123b

Fixed requirements

c5baa36

Fixing rebase

b9cddc2

homeassistant added the cla-signed label Mar 20, 2017

Merge branch 'dev' into binary_sensor_ring

7b776c5

balloobbot added component platform requirement labels Mar 20, 2017

Bump version ring_doorbell to 0.1.2

f4c1707

homeassistant added the cla-signed label Mar 20, 2017

testing unittests

e381158

houndci-bot reviewed Mar 20, 2017

View reviewed changes

balloob requested changes Mar 21, 2017

View reviewed changes

Use hass.data dict instead GLOBALS

e61015a

houndci-bot reviewed Mar 27, 2017

View reviewed changes

tchellomello force-pushed the binary_sensor_ring branch from 0659774 to e61015a Compare March 27, 2017 03:13

homeassistant added the cla-signed label Mar 27, 2017

tchellomello added 2 commits March 26, 2017 23:16

merge dev

47c2ff1

Fixed unittests

7877450

tchellomello changed the title ~~Introduced Ring binary sensors~~ Introduced Ring binary sensors and refactored Ring component Mar 27, 2017

balloob requested changes Mar 29, 2017

View reviewed changes

tchellomello added 2 commits March 31, 2017 03:39

Bump ring_doorbell to 0.1.3

2c02030

Updated unittest and coverted to use decorator @requests_mock.Mocker()

fcf0725

homeassistant added the cla-signed label Mar 31, 2017

Updated ring_session with lower case

2694aef

balloob merged commit 05398a9 into home-assistant:dev Mar 31, 2017

tchellomello deleted the binary_sensor_ring branch April 1, 2017 03:13

tchellomello restored the binary_sensor_ring branch April 1, 2017 03:17

tchellomello deleted the binary_sensor_ring branch April 1, 2017 03:18

tchellomello mentioned this pull request Apr 1, 2017

Updated Ring component documentation home-assistant/home-assistant.io#2366

Merged

fabaff mentioned this pull request Apr 6, 2017

0.42 #6956

Merged

balloob added the breaking-change label Apr 8, 2017

home-assistant locked and limited conversation to collaborators Jul 17, 2017

ghost added integration: ring and removed platform: binary_sensor.ring labels Mar 21, 2019

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Introduced Ring binary sensors and refactored Ring component #6520

Introduced Ring binary sensors and refactored Ring component #6520

tchellomello commented Mar 10, 2017 •

edited

balloob Mar 17, 2017

tchellomello Mar 17, 2017

houndci-bot Mar 20, 2017

balloob Mar 21, 2017

tchellomello Mar 25, 2017

balloob Mar 21, 2017

tchellomello Mar 25, 2017 •

edited

houndci-bot Mar 27, 2017

tchellomello commented Mar 27, 2017

balloob Mar 29, 2017

balloob Mar 29, 2017

balloob Mar 29, 2017

tchellomello Mar 31, 2017

tchellomello commented Mar 31, 2017

balloob commented Mar 31, 2017

		@@ -90,14 +65,15 @@ def setup_platform(hass, config, add_devices, discovery_info=None):

		class RingSensor(Entity):
		"""A sensor implementation for Ring device."""

Introduced Ring binary sensors and refactored Ring component #6520

Introduced Ring binary sensors and refactored Ring component #6520

Conversation

tchellomello commented Mar 10, 2017 • edited

Description:

Example entry for configuration.yaml (if applicable):

Checklist:

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

tchellomello Mar 25, 2017 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

tchellomello commented Mar 27, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

tchellomello commented Mar 31, 2017

balloob commented Mar 31, 2017

tchellomello commented Mar 10, 2017 •

edited

Example entry for `configuration.yaml` (if applicable):

tchellomello Mar 25, 2017 •

edited