Skip to content
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
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
1 change: 1 addition & 0 deletions .coveragerc
Original file line number Diff line number Diff line change
Expand Up @@ -197,6 +197,7 @@ omit =
homeassistant/components/binary_sensor/pilight.py
homeassistant/components/binary_sensor/ping.py
homeassistant/components/binary_sensor/rest.py
homeassistant/components/binary_sensor/tapsaff.py
homeassistant/components/browser.py
homeassistant/components/camera/amcrest.py
homeassistant/components/camera/bloomsky.py
Expand Down
85 changes: 85 additions & 0 deletions homeassistant/components/binary_sensor/tapsaff.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,85 @@
"""
Support for Taps Aff binary sensor.

For more details about this platform, please refer to the documentation at
https://home-assistant.io/components/binary_sensor.tapsaff/
"""
from datetime import timedelta
import logging

import voluptuous as vol

from homeassistant.components.binary_sensor \
import (BinarySensorDevice, PLATFORM_SCHEMA)

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

The \ is not needed if the line break is moved.

from homeassistant.components.binary_sensor import (
    BinarySensorDevice, ...)

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Fixed

from homeassistant.const import (CONF_NAME)
import homeassistant.helpers.config_validation as cv
from homeassistant.util import Throttle

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Not needed when going with SCAN_INTERVAL.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

I've moved to SCAN_INTERVAL will use this for future sensors.


REQUIREMENTS = ['tapsaff==0.1.0']

CONF_LOCATION = "location"

_LOGGER = logging.getLogger(__name__)

DEFAULT_NAME = 'Taps Aff'

MIN_TIME_BETWEEN_UPDATES = timedelta(minutes=30)

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Please use SCAN_INTERVAL.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Updated


PLATFORM_SCHEMA = PLATFORM_SCHEMA.extend({
vol.Optional(CONF_NAME, default=DEFAULT_NAME): cv.string,
vol.Required(CONF_LOCATION): cv.string,
})


def setup_platform(hass, config, add_devices, discovery_info=None):
"""Set up the taps aff sensor."""
name = config.get(CONF_NAME)
location = config.get(CONF_LOCATION)

taps_aff_data = TapsAffData(location)

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

I guess that there will be an exception if the location is not available. For users it will be helpful if there is a log entry that indicate this. Make the setup return if the location is not present this will ensure that the users are not having a non-functional platform for their instance.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

An exception is thrown, but I've improved the base library as I found a case where an exception slipped through. I've caught RuntimeException and provide a log message to explain what is wrong.


add_devices([TapsAffSensor(taps_aff_data, name)], True)


class TapsAffSensor(BinarySensorDevice):
"""Implementation of a taps aff sensor."""

def __init__(self, taps_aff_data, name):
"""Initialize the sensor."""
self.data = taps_aff_data
self._name = name

@property
def name(self):
"""Return the name of the sensor."""
return '{}'.format(self._name)

@property
def is_on(self):
"""Return true if taps aff."""
return self.data.is_taps_aff

def update(self):
"""Get the latest data."""
self.data.update()


class TapsAffData(object):
"""Class for handling the data retrieval for pins."""

def __init__(self, location):
"""Initialize the sensor."""
from tapsaff import TapsAff

self._is_taps_aff = None
self.taps_aff = TapsAff(location)

@property
def is_taps_aff(self):
"""Return true if taps aff."""
return self._is_taps_aff

@Throttle(MIN_TIME_BETWEEN_UPDATES)

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Not needed when going with SCAN_INTERVAL.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Updated

def update(self):
"""Get the latest data from the Taps Aff API and updates the states."""
self._is_taps_aff = self.taps_aff.is_taps_aff
3 changes: 3 additions & 0 deletions requirements_all.txt
Original file line number Diff line number Diff line change
Expand Up @@ -805,6 +805,9 @@ statsd==3.2.1
# homeassistant.components.sensor.steam_online
steamodd==4.21

# homeassistant.components.binary_sensor.tapsaff
tapsaff==0.1.0

# homeassistant.components.tellstick
# homeassistant.components.sensor.tellstick
tellcore-py==1.1.2
Expand Down