jeans/core
jeans/core
1
0
Fork 0
mirror of https://github.com/home-assistant/core.git synced 2025-07-27 15:17:35 +00:00
Code Issues Packages Projects Releases Wiki Activity

Use EntityDescription - bitcoin (#54320)

Browse Source 
* Use EntityDescription - bitcoin

* Remove default values
This commit is contained in:
Marc Mueller 2021-08-09 23:54:07 +02:00 committed by GitHub
parent b42ac8b48f
commit aeb7a6c090
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 139 additions and 54 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

193
homeassistant/components/bitcoin/sensor.py
View File

@ -1,11 +1,17 @@
"""Bitcoin information service that uses blockchain.com.""" """Bitcoin information service that uses blockchain.com."""
from __future__ import annotations
from datetime import timedelta from datetime import timedelta
import logging import logging
from blockchain import exchangerates, statistics from blockchain import exchangerates, statistics
import voluptuous as vol import voluptuous as vol
from homeassistant.components.sensor import PLATFORM_SCHEMA, SensorEntity from homeassistant.components.sensor import (
PLATFORM_SCHEMA,
SensorEntity,
SensorEntityDescription,
)
from homeassistant.const import ( from homeassistant.const import (
ATTR_ATTRIBUTION, ATTR_ATTRIBUTION,
CONF_CURRENCY, CONF_CURRENCY,
@ -25,34 +31,112 @@ ICON = "mdi:currency-btc"
SCAN_INTERVAL = timedelta(minutes=5) SCAN_INTERVAL = timedelta(minutes=5)
OPTION_TYPES = { SENSOR_TYPES: tuple[SensorEntityDescription, ...] = (
"exchangerate": ["Exchange rate (1 BTC)", None], SensorEntityDescription(
"trade_volume_btc": ["Trade volume", "BTC"], key="exchangerate",
"miners_revenue_usd": ["Miners revenue", "USD"], name="Exchange rate (1 BTC)",
"btc_mined": ["Mined", "BTC"], ),
"trade_volume_usd": ["Trade volume", "USD"], SensorEntityDescription(
"difficulty": ["Difficulty", None], key="trade_volume_btc",
"minutes_between_blocks": ["Time between Blocks", TIME_MINUTES], name="Trade volume",
"number_of_transactions": ["No. of Transactions", None], unit_of_measurement="BTC",
"hash_rate": ["Hash rate", f"PH/{TIME_SECONDS}"], ),
"timestamp": ["Timestamp", None], SensorEntityDescription(
"mined_blocks": ["Mined Blocks", None], key="miners_revenue_usd",
"blocks_size": ["Block size", None], name="Miners revenue",
"total_fees_btc": ["Total fees", "BTC"], unit_of_measurement="USD",
"total_btc_sent": ["Total sent", "BTC"], ),
"estimated_btc_sent": ["Estimated sent", "BTC"], SensorEntityDescription(
"total_btc": ["Total", "BTC"], key="btc_mined",
"total_blocks": ["Total Blocks", None], name="Mined",
"next_retarget": ["Next retarget", None], unit_of_measurement="BTC",
"estimated_transaction_volume_usd": ["Est. Transaction volume", "USD"], ),
"miners_revenue_btc": ["Miners revenue", "BTC"], SensorEntityDescription(
"market_price_usd": ["Market price", "USD"], key="trade_volume_usd",
} name="Trade volume",
unit_of_measurement="USD",
),
SensorEntityDescription(
key="difficulty",
name="Difficulty",
),
SensorEntityDescription(
key="minutes_between_blocks",
name="Time between Blocks",
unit_of_measurement=TIME_MINUTES,
),
SensorEntityDescription(
key="number_of_transactions",
name="No. of Transactions",
),
SensorEntityDescription(
key="hash_rate",
name="Hash rate",
unit_of_measurement=f"PH/{TIME_SECONDS}",
),
SensorEntityDescription(
key="timestamp",
name="Timestamp",
),
SensorEntityDescription(
key="mined_blocks",
name="Mined Blocks",
),
SensorEntityDescription(
key="blocks_size",
name="Block size",
),
SensorEntityDescription(
key="total_fees_btc",
name="Total fees",
unit_of_measurement="BTC",
),
SensorEntityDescription(
key="total_btc_sent",
name="Total sent",
unit_of_measurement="BTC",
),
SensorEntityDescription(
key="estimated_btc_sent",
name="Estimated sent",
unit_of_measurement="BTC",
),
SensorEntityDescription(
key="total_btc",
name="Total",
unit_of_measurement="BTC",
),
SensorEntityDescription(
key="total_blocks",
name="Total Blocks",
),
SensorEntityDescription(
key="next_retarget",
name="Next retarget",
),
SensorEntityDescription(
key="estimated_transaction_volume_usd",
name="Est. Transaction volume",
unit_of_measurement="USD",
),
SensorEntityDescription(
key="miners_revenue_btc",
name="Miners revenue",
unit_of_measurement="BTC",
),
SensorEntityDescription(
key="market_price_usd",
name="Market price",
unit_of_measurement="USD",
),
)
OPTION_KEYS = [desc.key for desc in SENSOR_TYPES]
PLATFORM_SCHEMA = PLATFORM_SCHEMA.extend( PLATFORM_SCHEMA = PLATFORM_SCHEMA.extend(
{ {
vol.Required(CONF_DISPLAY_OPTIONS, default=[]): vol.All( vol.Required(CONF_DISPLAY_OPTIONS, default=[]): vol.All(
cv.ensure_list, [vol.In(OPTION_TYPES)] cv.ensure_list, [vol.In(OPTION_KEYS)]
), ),
vol.Optional(CONF_CURRENCY, default=DEFAULT_CURRENCY): cv.string, vol.Optional(CONF_CURRENCY, default=DEFAULT_CURRENCY): cv.string,
} }
@ -69,11 +153,13 @@ def setup_platform(hass, config, add_entities, discovery_info=None):
currency = DEFAULT_CURRENCY currency = DEFAULT_CURRENCY
data = BitcoinData() data = BitcoinData()
dev = [] entities = [
for variable in config[CONF_DISPLAY_OPTIONS]: BitcoinSensor(data, currency, description)
dev.append(BitcoinSensor(data, variable, currency)) for description in SENSOR_TYPES
if description.key in config[CONF_DISPLAY_OPTIONS]
]
add_entities(dev, True) add_entities(entities, True)
class BitcoinSensor(SensorEntity): class BitcoinSensor(SensorEntity):
@ -82,13 +168,11 @@ class BitcoinSensor(SensorEntity):
_attr_extra_state_attributes = {ATTR_ATTRIBUTION: ATTRIBUTION} _attr_extra_state_attributes = {ATTR_ATTRIBUTION: ATTRIBUTION}
_attr_icon = ICON _attr_icon = ICON
def __init__(self, data, option_type, currency): def __init__(self, data, currency, description: SensorEntityDescription):
"""Initialize the sensor.""" """Initialize the sensor."""
self.entity_description = description
self.data = data self.data = data
self._attr_name = OPTION_TYPES[option_type][0]
self._attr_unit_of_measurement = OPTION_TYPES[option_type][1]
self._currency = currency self._currency = currency
self.type = option_type
def update(self): def update(self):
"""Get the latest data and updates the states.""" """Get the latest data and updates the states."""
@ -96,48 +180,49 @@ class BitcoinSensor(SensorEntity):
stats = self.data.stats stats = self.data.stats
ticker = self.data.ticker ticker = self.data.ticker
if self.type == "exchangerate": sensor_type = self.entity_description.key
if sensor_type == "exchangerate":
self._attr_state = ticker[self._currency].p15min self._attr_state = ticker[self._currency].p15min
self._attr_unit_of_measurement = self._currency self._attr_unit_of_measurement = self._currency
elif self.type == "trade_volume_btc": elif sensor_type == "trade_volume_btc":
self._attr_state = f"{stats.trade_volume_btc:.1f}" self._attr_state = f"{stats.trade_volume_btc:.1f}"
elif self.type == "miners_revenue_usd": elif sensor_type == "miners_revenue_usd":
self._attr_state = f"{stats.miners_revenue_usd:.0f}" self._attr_state = f"{stats.miners_revenue_usd:.0f}"
elif self.type == "btc_mined": elif sensor_type == "btc_mined":
self._attr_state = str(stats.btc_mined * 0.00000001) self._attr_state = str(stats.btc_mined * 0.00000001)
elif self.type == "trade_volume_usd": elif sensor_type == "trade_volume_usd":
self._attr_state = f"{stats.trade_volume_usd:.1f}" self._attr_state = f"{stats.trade_volume_usd:.1f}"
elif self.type == "difficulty": elif sensor_type == "difficulty":
self._attr_state = f"{stats.difficulty:.0f}" self._attr_state = f"{stats.difficulty:.0f}"
elif self.type == "minutes_between_blocks": elif sensor_type == "minutes_between_blocks":
self._attr_state = f"{stats.minutes_between_blocks:.2f}" self._attr_state = f"{stats.minutes_between_blocks:.2f}"
elif self.type == "number_of_transactions": elif sensor_type == "number_of_transactions":
self._attr_state = str(stats.number_of_transactions) self._attr_state = str(stats.number_of_transactions)
elif self.type == "hash_rate": elif sensor_type == "hash_rate":
self._attr_state = f"{stats.hash_rate * 0.000001:.1f}" self._attr_state = f"{stats.hash_rate * 0.000001:.1f}"
elif self.type == "timestamp": elif sensor_type == "timestamp":
self._attr_state = stats.timestamp self._attr_state = stats.timestamp
elif self.type == "mined_blocks": elif sensor_type == "mined_blocks":
self._attr_state = str(stats.mined_blocks) self._attr_state = str(stats.mined_blocks)
elif self.type == "blocks_size": elif sensor_type == "blocks_size":
self._attr_state = f"{stats.blocks_size:.1f}" self._attr_state = f"{stats.blocks_size:.1f}"
elif self.type == "total_fees_btc": elif sensor_type == "total_fees_btc":
self._attr_state = f"{stats.total_fees_btc * 0.00000001:.2f}" self._attr_state = f"{stats.total_fees_btc * 0.00000001:.2f}"
elif self.type == "total_btc_sent": elif sensor_type == "total_btc_sent":
self._attr_state = f"{stats.total_btc_sent * 0.00000001:.2f}" self._attr_state = f"{stats.total_btc_sent * 0.00000001:.2f}"
elif self.type == "estimated_btc_sent": elif sensor_type == "estimated_btc_sent":
self._attr_state = f"{stats.estimated_btc_sent * 0.00000001:.2f}" self._attr_state = f"{stats.estimated_btc_sent * 0.00000001:.2f}"
elif self.type == "total_btc": elif sensor_type == "total_btc":
self._attr_state = f"{stats.total_btc * 0.00000001:.2f}" self._attr_state = f"{stats.total_btc * 0.00000001:.2f}"
elif self.type == "total_blocks": elif sensor_type == "total_blocks":
self._attr_state = f"{stats.total_blocks:.0f}" self._attr_state = f"{stats.total_blocks:.0f}"
elif self.type == "next_retarget": elif sensor_type == "next_retarget":
self._attr_state = f"{stats.next_retarget:.2f}" self._attr_state = f"{stats.next_retarget:.2f}"
elif self.type == "estimated_transaction_volume_usd": elif sensor_type == "estimated_transaction_volume_usd":
self._attr_state = f"{stats.estimated_transaction_volume_usd:.2f}" self._attr_state = f"{stats.estimated_transaction_volume_usd:.2f}"
elif self.type == "miners_revenue_btc": elif sensor_type == "miners_revenue_btc":
self._attr_state = f"{stats.miners_revenue_btc * 0.00000001:.1f}" self._attr_state = f"{stats.miners_revenue_btc * 0.00000001:.1f}"
elif self.type == "market_price_usd": elif sensor_type == "market_price_usd":
self._attr_state = f"{stats.market_price_usd:.2f}" self._attr_state = f"{stats.market_price_usd:.2f}"