Add configurable decimal rounding of display value for CoinMarketCap sensor and upgrade to 5.0.3 (#14437) (#14604)
This commit is contained in:
parent
143be49c66
commit
b4f8d52fb1
5 changed files with 93 additions and 53 deletions
|
@ -13,64 +13,78 @@ import voluptuous as vol
|
|||
import homeassistant.helpers.config_validation as cv
|
||||
from homeassistant.components.sensor import PLATFORM_SCHEMA
|
||||
from homeassistant.const import (
|
||||
ATTR_ATTRIBUTION, CONF_CURRENCY, CONF_DISPLAY_CURRENCY)
|
||||
ATTR_ATTRIBUTION, CONF_DISPLAY_CURRENCY)
|
||||
from homeassistant.helpers.entity import Entity
|
||||
|
||||
REQUIREMENTS = ['coinmarketcap==4.2.1']
|
||||
REQUIREMENTS = ['coinmarketcap==5.0.3']
|
||||
|
||||
_LOGGER = logging.getLogger(__name__)
|
||||
|
||||
ATTR_24H_VOLUME = '24h_volume'
|
||||
ATTR_VOLUME_24H = 'volume_24h'
|
||||
ATTR_AVAILABLE_SUPPLY = 'available_supply'
|
||||
ATTR_CIRCULATING_SUPPLY = 'circulating_supply'
|
||||
ATTR_MARKET_CAP = 'market_cap'
|
||||
ATTR_PERCENT_CHANGE_24H = 'percent_change_24h'
|
||||
ATTR_PERCENT_CHANGE_7D = 'percent_change_7d'
|
||||
ATTR_PERCENT_CHANGE_1H = 'percent_change_1h'
|
||||
ATTR_PRICE = 'price'
|
||||
ATTR_RANK = 'rank'
|
||||
ATTR_SYMBOL = 'symbol'
|
||||
ATTR_TOTAL_SUPPLY = 'total_supply'
|
||||
|
||||
CONF_ATTRIBUTION = "Data provided by CoinMarketCap"
|
||||
CONF_CURRENCY_ID = 'currency_id'
|
||||
CONF_DISPLAY_CURRENCY_DECIMALS = 'display_currency_decimals'
|
||||
|
||||
DEFAULT_CURRENCY = 'bitcoin'
|
||||
DEFAULT_CURRENCY_ID = 1
|
||||
DEFAULT_DISPLAY_CURRENCY = 'USD'
|
||||
DEFAULT_DISPLAY_CURRENCY_DECIMALS = 2
|
||||
|
||||
ICON = 'mdi:currency-usd'
|
||||
|
||||
SCAN_INTERVAL = timedelta(minutes=15)
|
||||
|
||||
|
||||
PLATFORM_SCHEMA = PLATFORM_SCHEMA.extend({
|
||||
vol.Optional(CONF_CURRENCY, default=DEFAULT_CURRENCY): cv.string,
|
||||
vol.Optional(CONF_CURRENCY_ID, default=DEFAULT_CURRENCY_ID):
|
||||
cv.positive_int,
|
||||
vol.Optional(CONF_DISPLAY_CURRENCY, default=DEFAULT_DISPLAY_CURRENCY):
|
||||
cv.string,
|
||||
vol.Optional(CONF_DISPLAY_CURRENCY_DECIMALS,
|
||||
default=DEFAULT_DISPLAY_CURRENCY_DECIMALS):
|
||||
vol.All(vol.Coerce(int), vol.Range(min=1)),
|
||||
})
|
||||
|
||||
|
||||
def setup_platform(hass, config, add_devices, discovery_info=None):
|
||||
"""Set up the CoinMarketCap sensor."""
|
||||
currency = config.get(CONF_CURRENCY)
|
||||
display_currency = config.get(CONF_DISPLAY_CURRENCY).lower()
|
||||
currency_id = config.get(CONF_CURRENCY_ID)
|
||||
display_currency = config.get(CONF_DISPLAY_CURRENCY).upper()
|
||||
display_currency_decimals = config.get(CONF_DISPLAY_CURRENCY_DECIMALS)
|
||||
|
||||
try:
|
||||
CoinMarketCapData(currency, display_currency).update()
|
||||
CoinMarketCapData(currency_id, display_currency).update()
|
||||
except HTTPError:
|
||||
_LOGGER.warning("Currency %s or display currency %s is not available. "
|
||||
"Using bitcoin and USD.", currency, display_currency)
|
||||
currency = DEFAULT_CURRENCY
|
||||
_LOGGER.warning("Currency ID %s or display currency %s "
|
||||
"is not available. Using 1 (bitcoin) "
|
||||
"and USD.", currency_id, display_currency)
|
||||
currency_id = DEFAULT_CURRENCY_ID
|
||||
display_currency = DEFAULT_DISPLAY_CURRENCY
|
||||
|
||||
add_devices([CoinMarketCapSensor(
|
||||
CoinMarketCapData(currency, display_currency))], True)
|
||||
CoinMarketCapData(
|
||||
currency_id, display_currency), display_currency_decimals)], True)
|
||||
|
||||
|
||||
class CoinMarketCapSensor(Entity):
|
||||
"""Representation of a CoinMarketCap sensor."""
|
||||
|
||||
def __init__(self, data):
|
||||
def __init__(self, data, display_currency_decimals):
|
||||
"""Initialize the sensor."""
|
||||
self.data = data
|
||||
self.display_currency_decimals = display_currency_decimals
|
||||
self._ticker = None
|
||||
self._unit_of_measurement = self.data.display_currency.upper()
|
||||
self._unit_of_measurement = self.data.display_currency
|
||||
|
||||
@property
|
||||
def name(self):
|
||||
|
@ -80,8 +94,9 @@ class CoinMarketCapSensor(Entity):
|
|||
@property
|
||||
def state(self):
|
||||
"""Return the state of the sensor."""
|
||||
return round(float(self._ticker.get(
|
||||
'price_{}'.format(self.data.display_currency))), 2)
|
||||
return round(float(
|
||||
self._ticker.get('quotes').get(self.data.display_currency)
|
||||
.get('price')), self.display_currency_decimals)
|
||||
|
||||
@property
|
||||
def unit_of_measurement(self):
|
||||
|
@ -97,15 +112,24 @@ class CoinMarketCapSensor(Entity):
|
|||
def device_state_attributes(self):
|
||||
"""Return the state attributes of the sensor."""
|
||||
return {
|
||||
ATTR_24H_VOLUME: self._ticker.get(
|
||||
'24h_volume_{}'.format(self.data.display_currency)),
|
||||
ATTR_VOLUME_24H:
|
||||
self._ticker.get('quotes').get(self.data.display_currency)
|
||||
.get('volume_24h'),
|
||||
ATTR_ATTRIBUTION: CONF_ATTRIBUTION,
|
||||
ATTR_AVAILABLE_SUPPLY: self._ticker.get('available_supply'),
|
||||
ATTR_MARKET_CAP: self._ticker.get(
|
||||
'market_cap_{}'.format(self.data.display_currency)),
|
||||
ATTR_PERCENT_CHANGE_24H: self._ticker.get('percent_change_24h'),
|
||||
ATTR_PERCENT_CHANGE_7D: self._ticker.get('percent_change_7d'),
|
||||
ATTR_PERCENT_CHANGE_1H: self._ticker.get('percent_change_1h'),
|
||||
ATTR_CIRCULATING_SUPPLY: self._ticker.get('circulating_supply'),
|
||||
ATTR_MARKET_CAP:
|
||||
self._ticker.get('quotes').get(self.data.display_currency)
|
||||
.get('market_cap'),
|
||||
ATTR_PERCENT_CHANGE_24H:
|
||||
self._ticker.get('quotes').get(self.data.display_currency)
|
||||
.get('percent_change_24h'),
|
||||
ATTR_PERCENT_CHANGE_7D:
|
||||
self._ticker.get('quotes').get(self.data.display_currency)
|
||||
.get('percent_change_7d'),
|
||||
ATTR_PERCENT_CHANGE_1H:
|
||||
self._ticker.get('quotes').get(self.data.display_currency)
|
||||
.get('percent_change_1h'),
|
||||
ATTR_RANK: self._ticker.get('rank'),
|
||||
ATTR_SYMBOL: self._ticker.get('symbol'),
|
||||
ATTR_TOTAL_SUPPLY: self._ticker.get('total_supply'),
|
||||
}
|
||||
|
@ -113,20 +137,20 @@ class CoinMarketCapSensor(Entity):
|
|||
def update(self):
|
||||
"""Get the latest data and updates the states."""
|
||||
self.data.update()
|
||||
self._ticker = self.data.ticker[0]
|
||||
self._ticker = self.data.ticker.get('data')
|
||||
|
||||
|
||||
class CoinMarketCapData(object):
|
||||
"""Get the latest data and update the states."""
|
||||
|
||||
def __init__(self, currency, display_currency):
|
||||
def __init__(self, currency_id, display_currency):
|
||||
"""Initialize the data object."""
|
||||
self.currency = currency
|
||||
self.currency_id = currency_id
|
||||
self.display_currency = display_currency
|
||||
self.ticker = None
|
||||
|
||||
def update(self):
|
||||
"""Get the latest data from blockchain.info."""
|
||||
"""Get the latest data from coinmarketcap.com."""
|
||||
from coinmarketcap import Market
|
||||
self.ticker = Market().ticker(
|
||||
self.currency, limit=1, convert=self.display_currency)
|
||||
self.currency_id, convert=self.display_currency)
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue