Skip to content

Implemented health parameters reporting (wifi, wifi_rssi) #50

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

Merged
tchellomello merged 2 commits into from
Sep 30, 2017
Merged

Implemented health parameters reporting (wifi, wifi_rssi) #50

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0847b73
Implemented health attributes to Ring devices
tchellomello Sep 30, 2017
9c3472c
Added unittests to wifi health parameters
tchellomello Sep 30, 2017
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
2 changes: 2 additions & 0 deletions README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,6 +84,8 @@ Playing with the attributes and functions
print('ID: %s' % dev.id)
print('Name: %s' % dev.name)
print('Timezone: %s' % dev.timezone)
print('Wifi Name: %s' % dev.wifi_name)
print('Wifi RSSI: %s' % dev.wifi_signal_strength)

# setting dev volume
print('Volume: %s' % dev.volume)
Expand Down
38 changes: 34 additions & 4 deletions ring_doorbell/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,10 +20,10 @@
CHIME_VOL_MIN, CHIME_VOL_MAX,
DEVICES_ENDPOINT, DOORBELLS_ENDPOINT, DOORBELL_VOL_MIN, DOORBELL_VOL_MAX,
DOORBELL_EXISTING_TYPE, DINGS_ENDPOINT, FILE_EXISTS,
HEADERS, LINKED_CHIMES_ENDPOINT, LIVE_STREAMING_ENDPOINT,
NEW_SESSION_ENDPOINT, MSG_BOOLEAN_REQUIRED, MSG_EXISTING_TYPE,
MSG_GENERIC_FAIL, MSG_VOL_OUTBOUND,
NOT_FOUND, URL_DOORBELL_HISTORY, URL_RECORDING,
HEADERS, HEALTH_CHIMES_ENDPOINT, HEALTH_DOORBELL_ENDPOINT,
LINKED_CHIMES_ENDPOINT, LIVE_STREAMING_ENDPOINT, NEW_SESSION_ENDPOINT,
MSG_BOOLEAN_REQUIRED, MSG_EXISTING_TYPE, MSG_GENERIC_FAIL,
MSG_VOL_OUTBOUND, NOT_FOUND, URL_DOORBELL_HISTORY, URL_RECORDING,
POST_DATA, PERSIST_TOKEN_ENDPOINT, PERSIST_TOKEN_DATA,
RETRY_TOKEN, TESTSOUND_CHIME_ENDPOINT, CHIME_TEST_SOUND_KINDS, KIND_DING)

Expand Down Expand Up @@ -266,6 +266,7 @@ def __init__(self, ring, name, shared=False):
self.name = name
self.shared = shared
self._attrs = None
self._health_attrs = None

# alerts notifications
self.alert_expires_at = None
Expand All @@ -285,6 +286,7 @@ def family(self):
def update(self):
"""Refresh attributes."""
self._get_attrs()
self._get_health_attrs()
self._update_alert()

@property
Expand Down Expand Up @@ -325,6 +327,14 @@ def _get_attrs(self):
self._attrs = lst[index]
return True

def _get_health_attrs(self):
"""Return health attributes."""
if self.family == 'doorbots' or self.family == 'stickup_cams':
url = API_URI + HEALTH_DOORBELL_ENDPOINT.format(self.account_id)
elif self.family == 'chimes':
url = API_URI + HEALTH_CHIMES_ENDPOINT.format(self.account_id)
self._health_attrs = self._ring.query(url).get('device_health')

@property
def account_id(self):
"""Return account ID."""
Expand Down Expand Up @@ -366,6 +376,21 @@ def timezone(self):
"""Return timezone."""
return self._attrs.get('time_zone')

@property
def wifi_name(self):
"""Return wifi ESSID name."""
return self._health_attrs.get('wifi_name')

@property
def wifi_signal_strength(self):
"""Return wifi RSSI."""
return self._health_attrs.get('latest_signal_strength')

@property
def wifi_signal_category(self):
"""Return wifi signal category."""
return self._health_attrs.get('latest_signal_category')


class RingChime(RingGeneric):
"""Implementation for Ring Chime."""
Expand All @@ -375,6 +400,11 @@ def family(self):
"""Return Ring device family type."""
return 'chimes'

@property
def battery_life(self):
"""Return battery life."""
return self._health_attrs.get('battery_percentage')

@property
def volume(self):
"""Return if chime volume."""
Expand Down
3 changes: 3 additions & 0 deletions ring_doorbell/const.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,9 +33,12 @@
DOORBELLS_ENDPOINT = '/clients_api/doorbots/{0}'
PERSIST_TOKEN_ENDPOINT = '/clients_api/device'

HEALTH_DOORBELL_ENDPOINT = DOORBELLS_ENDPOINT + '/health'
HEALTH_CHIMES_ENDPOINT = CHIMES_ENDPOINT + '/health'
LINKED_CHIMES_ENDPOINT = CHIMES_ENDPOINT + '/linked_doorbots'
LIVE_STREAMING_ENDPOINT = DOORBELLS_ENDPOINT + '/vod'
NEW_SESSION_ENDPOINT = '/clients_api/session'
RINGTONES_ENDPOINT = '/ringtones'
TESTSOUND_CHIME_ENDPOINT = CHIMES_ENDPOINT + '/play_sound'
URL_DOORBELL_HISTORY = DOORBELLS_ENDPOINT + '/history'
URL_RECORDING = '/clients_api/dings/{0}/recording'
Expand Down
19 changes: 19 additions & 0 deletions tests/fixtures/ring_chime_health_attrs.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
{
"device_health": {
"average_signal_category": "good",
"average_signal_strength": -39,
"battery_percentage": 100,
"battery_percentage_category": null,
"battery_voltage": null,
"battery_voltage_category": null,
"firmware": "1.2.3",
"firmware_out_of_date": false,
"id": 999999,
"latest_signal_category": "good",
"latest_signal_strength": -39,
"updated_at": "2017-09-30T07:05:03Z",
"wifi_is_ring_network": false,
"wifi_name": "ring_mock_wifi"
}
}

19 changes: 19 additions & 0 deletions tests/fixtures/ring_doorboot_health_attrs.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
{
"device_health": {
"average_signal_category": "good",
"average_signal_strength": -39,
"battery_percentage": 100,
"battery_percentage_category": null,
"battery_voltage": null,
"battery_voltage_category": null,
"firmware": "1.9.2",
"firmware_out_of_date": false,
"id": 987652,
"latest_signal_category": "good",
"latest_signal_strength": -58,
"updated_at": "2017-09-30T07:05:03Z",
"wifi_is_ring_network": false,
"wifi_name": "ring_mock_wifi"
}
}

19 changes: 19 additions & 0 deletions tests/fixtures/ring_doorboot_health_attrs_id987653.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
{
"device_health": {
"average_signal_category": "good",
"average_signal_strength": -39,
"battery_percentage": 100,
"battery_percentage_category": null,
"battery_voltage": null,
"battery_voltage_category": null,
"firmware": "1.9.2",
"firmware_out_of_date": false,
"id": 987653,
"latest_signal_category": "good",
"latest_signal_strength": -58,
"updated_at": "2017-09-30T07:05:03Z",
"wifi_is_ring_network": false,
"wifi_name": "ring_mock_wifi"
}
}

26 changes: 26 additions & 0 deletions tests/test_ring.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,12 @@ def test_basic_attributes(self, mock):
"""Test the Ring class and methods."""
mock.get('https://api.ring.com/clients_api/ring_devices',
text=load_fixture('ring_devices.json'))
mock.get('https://api.ring.com/clients_api/chimes/999999/health',
text=load_fixture('ring_chime_health_attrs.json'))
mock.get('https://api.ring.com/clients_api/doorbots/987652/health',
text=load_fixture('ring_doorboot_health_attrs.json'))
mock.get('https://api.ring.com/clients_api/doorbots/987653/health',
text=load_fixture('ring_doorboot_health_attrs_id987653.json'))

data = self.ring
self.assertTrue(data.is_connected)
Expand All @@ -29,6 +35,8 @@ def test_chime_attributes(self, mock):
"""Test the Ring Chime class and methods."""
mock.get('https://api.ring.com/clients_api/ring_devices',
text=load_fixture('ring_devices.json'))
mock.get('https://api.ring.com/clients_api/chimes/999999/health',
text=load_fixture('ring_chime_health_attrs.json'))

data = self.ring
dev = data.chimes[0]
Expand All @@ -40,13 +48,20 @@ def test_chime_attributes(self, mock):
self.assertIsNotNone(dev.latitude)
self.assertEqual('America/New_York', dev.timezone)
self.assertEqual(2, dev.volume)
self.assertEqual('ring_mock_wifi', dev.wifi_name)
self.assertEqual('good', dev.wifi_signal_category)
self.assertNotEqual(100, dev.wifi_signal_strength)

@requests_mock.Mocker()
def test_doorbell_attributes(self, mock):
mock.get('https://api.ring.com/clients_api/ring_devices',
text=load_fixture('ring_devices.json'))
mock.get('https://api.ring.com/clients_api/doorbots/987652/history',
text=load_fixture('ring_doorbots.json'))
mock.get('https://api.ring.com/clients_api/doorbots/987652/health',
text=load_fixture('ring_doorboot_health_attrs.json'))
mock.get('https://api.ring.com/clients_api/doorbots/987653/health',
text=load_fixture('ring_doorboot_health_attrs_id987653.json'))

data = self.ring_persistent
for dev in data.doorbells:
Expand All @@ -66,13 +81,20 @@ def test_doorbell_attributes(self, mock):

self.assertEqual('Mechanical', dev.existing_doorbell_type)
self.assertTrue(data._persist_token)
self.assertEqual('ring_mock_wifi', dev.wifi_name)
self.assertEqual('good', dev.wifi_signal_category)
self.assertEqual(-58, dev.wifi_signal_strength)

@requests_mock.Mocker()
def test_shared_doorbell_attributes(self, mock):
mock.get('https://api.ring.com/clients_api/ring_devices',
text=load_fixture('ring_devices.json'))
mock.get('https://api.ring.com/clients_api/doorbots/987652/history',
text=load_fixture('ring_doorbots.json'))
mock.get('https://api.ring.com/clients_api/doorbots/987652/health',
text=load_fixture('ring_doorboot_health_attrs.json'))
mock.get('https://api.ring.com/clients_api/doorbots/987653/health',
text=load_fixture('ring_doorboot_health_attrs_id987653.json'))

data = self.ring_persistent
for dev in data.doorbells:
Expand All @@ -92,6 +114,10 @@ def test_doorbell_alerts(self, mock):
text=load_fixture('ring_devices.json'))
mock.get('https://api.ring.com/clients_api/dings/active',
text=load_fixture('ring_ding_active.json'))
mock.get('https://api.ring.com/clients_api/doorbots/987652/health',
text=load_fixture('ring_doorboot_health_attrs.json'))
mock.get('https://api.ring.com/clients_api/doorbots/987653/health',
text=load_fixture('ring_doorboot_health_attrs_id987653.json'))

data = self.ring_persistent
for dev in data.doorbells:
Expand Down