Add Discogs Sensor platform (#10957)

* Add Discogs Sensor platform

* Add discogs module to requirements_all

* Fix wrong style var name

* PR Feedback (scan interval, mod. docstring)

* Added sensor.discogs to coveragerc

* Use SERVER_SOFTWARE helper for UA-String

* Don't setup platform if token is invalid

* Fix trailing whitespace for Hound CI

* Move client setup to setup()
This commit is contained in:
Thibault Maekelbergh 2017-12-18 19:10:54 +01:00 committed by Fabian Affolter
parent 05258ea4bf
commit 061395d2f8
3 changed files with 101 additions and 0 deletions

View File

@ -504,6 +504,7 @@ omit =
homeassistant/components/sensor/deluge.py
homeassistant/components/sensor/deutsche_bahn.py
homeassistant/components/sensor/dht.py
homeassistant/components/sensor/discogs.py
homeassistant/components/sensor/dnsip.py
homeassistant/components/sensor/dovado.py
homeassistant/components/sensor/dte_energy_bridge.py

View File

@ -0,0 +1,97 @@
"""
Show the amount of records in a user's Discogs collection.
For more details about this platform, please refer to the documentation at
https://home-assistant.io/components/sensor.discogs/
"""
import asyncio
from datetime import timedelta
import logging
import voluptuous as vol
from homeassistant.components.sensor import PLATFORM_SCHEMA
from homeassistant.const import ATTR_ATTRIBUTION, CONF_NAME, CONF_TOKEN
from homeassistant.helpers.aiohttp_client import SERVER_SOFTWARE
import homeassistant.helpers.config_validation as cv
from homeassistant.helpers.entity import Entity
REQUIREMENTS = ['discogs_client==2.2.1']
_LOGGER = logging.getLogger(__name__)
ATTR_IDENTITY = 'identity'
CONF_ATTRIBUTION = "Data provided by Discogs"
DEFAULT_NAME = 'Discogs'
ICON = 'mdi:album'
SCAN_INTERVAL = timedelta(hours=2)
PLATFORM_SCHEMA = PLATFORM_SCHEMA.extend({
vol.Required(CONF_TOKEN): cv.string,
vol.Optional(CONF_NAME, default=DEFAULT_NAME): cv.string,
})
@asyncio.coroutine
def async_setup_platform(hass, config, async_add_devices, discovery_info=None):
"""Set up the Discogs sensor."""
import discogs_client
name = config.get(CONF_NAME)
token = config.get(CONF_TOKEN)
try:
discogs = discogs_client.Client(SERVER_SOFTWARE, user_token=token)
identity = discogs.identity()
except discogs_client.exceptions.HTTPError:
_LOGGER.error("API token is not valid")
return
async_add_devices([DiscogsSensor(identity, name)], True)
class DiscogsSensor(Entity):
"""Get a user's number of records in collection."""
def __init__(self, identity, name):
"""Initialize the Discogs sensor."""
self._identity = identity
self._name = name
self._state = None
@property
def name(self):
"""Return the name of the sensor."""
return self._name
@property
def state(self):
"""Return the state of the sensor."""
return self._state
@property
def icon(self):
"""Return the icon to use in the frontend, if any."""
return ICON
@property
def unit_of_measurement(self):
"""Return the unit this state is expressed in."""
return 'records'
@property
def device_state_attributes(self):
"""Return the state attributes of the sensor."""
return {
ATTR_ATTRIBUTION: CONF_ATTRIBUTION,
ATTR_IDENTITY: self._identity.name,
}
@asyncio.coroutine
def async_update(self):
"""Set state to the amount of records in user's collection."""
self._state = self._identity.num_collection

View File

@ -208,6 +208,9 @@ denonavr==0.5.5
# homeassistant.components.media_player.directv
directpy==0.2
# homeassistant.components.sensor.discogs
discogs_client==2.2.1
# homeassistant.components.notify.discord
discord.py==0.16.12