Skip to content

Add configuration for extra Unifi device_tracker attributes #15711

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

Closed
cgarwood wants to merge 2 commits into from
Closed

Add configuration for extra Unifi device_tracker attributes #15711

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
3821a12
Add config option for extra unifi attributes
cgarwood Jul 27, 2018
c8b7795
fix lint
cgarwood Jul 27, 2018
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
13 changes: 11 additions & 2 deletions homeassistant/components/device_tracker/unifi.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,12 +21,14 @@
CONF_PORT = 'port'
CONF_SITE_ID = 'site_id'
CONF_DETECTION_TIME = 'detection_time'
CONF_EXTRA_ATTRIBUTES = 'extra_attributes'
CONF_SSID_FILTER = 'ssid_filter'

DEFAULT_HOST = 'localhost'
DEFAULT_PORT = 8443
DEFAULT_VERIFY_SSL = True
DEFAULT_DETECTION_TIME = timedelta(seconds=300)
DEFAULT_EXTRA_ATTRIBUTES = False

NOTIFICATION_ID = 'unifi_notification'
NOTIFICATION_TITLE = 'Unifi Device Tracker Setup'
Expand All @@ -41,6 +43,8 @@
cv.boolean, cv.isfile),
vol.Optional(CONF_DETECTION_TIME, default=DEFAULT_DETECTION_TIME): vol.All(
cv.time_period, cv.positive_timedelta),
vol.Optional(CONF_EXTRA_ATTRIBUTES, default=DEFAULT_EXTRA_ATTRIBUTES):

@awarecan awarecan Aug 3, 2018

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

default=False is better then default=DEFAULT_EXTRA_ATTRIBUTES

@dgomes dgomes Aug 3, 2018

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

It would not be consistent we the remaining DEFAUT_*

cv.boolean,
vol.Optional(CONF_SSID_FILTER): vol.All(cv.ensure_list, [cv.string])
})

Expand All @@ -56,6 +60,7 @@ def get_scanner(hass, config):
port = config[DOMAIN].get(CONF_PORT)
verify_ssl = config[DOMAIN].get(CONF_VERIFY_SSL)
detection_time = config[DOMAIN].get(CONF_DETECTION_TIME)
extra_attributes = config[DOMAIN].get(CONF_EXTRA_ATTRIBUTES)
ssid_filter = config[DOMAIN].get(CONF_SSID_FILTER)

try:
Expand All @@ -72,18 +77,19 @@ def get_scanner(hass, config):
notification_id=NOTIFICATION_ID)
return False

return UnifiScanner(ctrl, detection_time, ssid_filter)
return UnifiScanner(ctrl, detection_time, ssid_filter, extra_attributes)


class UnifiScanner(DeviceScanner):
"""Provide device_tracker support from Unifi WAP client data."""

def __init__(self, controller, detection_time: timedelta,
ssid_filter) -> None:
ssid_filter, extra_attributes) -> None:
"""Initialize the scanner."""
self._detection_time = detection_time
self._controller = controller
self._ssid_filter = ssid_filter
self._extra_attributes = extra_attributes
self._update()

def _update(self):
Expand Down Expand Up @@ -125,6 +131,9 @@ def get_device_name(self, device):

def get_extra_attributes(self, device):
"""Return the extra attributes of the device."""
if not self._extra_attributes:
return {}

client = self._clients.get(device, {})
_LOGGER.debug("Device mac %s attributes %s", device, client)
return client
21 changes: 13 additions & 8 deletions tests/components/device_tracker/test_unifi.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,8 @@ def test_config_valid_verify_ssl(hass, mock_scanner, mock_ctrl):
assert mock_scanner.call_count == 1
assert mock_scanner.call_args == mock.call(mock_ctrl.return_value,
DEFAULT_DETECTION_TIME,
None)
None,
False)


def test_config_minimal(hass, mock_scanner, mock_ctrl):
Expand All @@ -76,7 +77,8 @@ def test_config_minimal(hass, mock_scanner, mock_ctrl):
assert mock_scanner.call_count == 1
assert mock_scanner.call_args == mock.call(mock_ctrl.return_value,
DEFAULT_DETECTION_TIME,
None)
None,
False)


def test_config_full(hass, mock_scanner, mock_ctrl):
Expand All @@ -91,6 +93,7 @@ def test_config_full(hass, mock_scanner, mock_ctrl):
'port': 123,
'site_id': 'abcdef01',
'detection_time': 300,
'extra_attributes': True
})
}
result = unifi.get_scanner(hass, config)
Expand All @@ -103,7 +106,8 @@ def test_config_full(hass, mock_scanner, mock_ctrl):
assert mock_scanner.call_count == 1
assert mock_scanner.call_args == mock.call(mock_ctrl.return_value,
DEFAULT_DETECTION_TIME,
None)
None,
True)


def test_config_error():
Expand Down Expand Up @@ -157,7 +161,7 @@ def test_scanner_update():
'last_seen': dt_util.as_timestamp(dt_util.utcnow())},
]
ctrl.get_clients.return_value = fake_clients
unifi.UnifiScanner(ctrl, DEFAULT_DETECTION_TIME, None)
unifi.UnifiScanner(ctrl, DEFAULT_DETECTION_TIME, None, False)
assert ctrl.get_clients.call_count == 1
assert ctrl.get_clients.call_args == mock.call()

Expand All @@ -167,7 +171,7 @@ def test_scanner_update_error():
ctrl = mock.MagicMock()
ctrl.get_clients.side_effect = APIError(
'/', 500, 'foo', {}, None)
unifi.UnifiScanner(ctrl, DEFAULT_DETECTION_TIME, None)
unifi.UnifiScanner(ctrl, DEFAULT_DETECTION_TIME, None, False)


def test_scan_devices():
Expand All @@ -180,7 +184,7 @@ def test_scan_devices():
'last_seen': dt_util.as_timestamp(dt_util.utcnow())},
]
ctrl.get_clients.return_value = fake_clients
scanner = unifi.UnifiScanner(ctrl, DEFAULT_DETECTION_TIME, None)
scanner = unifi.UnifiScanner(ctrl, DEFAULT_DETECTION_TIME, None, False)
assert set(scanner.scan_devices()) == set(['123', '234'])


Expand All @@ -200,7 +204,8 @@ def test_scan_devices_filtered():

ssid_filter = ['foonet', 'barnet']
ctrl.get_clients.return_value = fake_clients
scanner = unifi.UnifiScanner(ctrl, DEFAULT_DETECTION_TIME, ssid_filter)
scanner = unifi.UnifiScanner(ctrl, DEFAULT_DETECTION_TIME, ssid_filter,
False)
assert set(scanner.scan_devices()) == set(['123', '234', '890'])


Expand All @@ -221,7 +226,7 @@ def test_get_device_name():
'last_seen': '1504786810'},
]
ctrl.get_clients.return_value = fake_clients
scanner = unifi.UnifiScanner(ctrl, DEFAULT_DETECTION_TIME, None)
scanner = unifi.UnifiScanner(ctrl, DEFAULT_DETECTION_TIME, None, False)
assert scanner.get_device_name('123') == 'foobar'
assert scanner.get_device_name('234') == 'Nice Name'
assert scanner.get_device_name('456') is None
Expand Down