Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.bitcoin.sensor Namespace Reference

Classes

class  BitcoinData
 
class  BitcoinSensor
 

Functions

None setup_platform (HomeAssistant hass, ConfigType config, AddEntitiesCallback add_entities, DiscoveryInfoType|None discovery_info=None)
 

Variables

 _LOGGER = logging.getLogger(__name__)
 
string DEFAULT_CURRENCY = "USD"
 
list OPTION_KEYS = [desc.key for desc in SENSOR_TYPES]
 
 PLATFORM_SCHEMA
 
 SCAN_INTERVAL = timedelta(minutes=5)
 

Detailed Description

Bitcoin information service that uses blockchain.com.

Function Documentation

◆ setup_platform()

None homeassistant.components.bitcoin.sensor.setup_platform ( HomeAssistant  hass,
ConfigType  config,
AddEntitiesCallback  add_entities,
DiscoveryInfoType | None   discovery_info = None 
)
Set up the Bitcoin sensors.

Definition at line 140 of file sensor.py.

Variable Documentation

◆ _LOGGER

homeassistant.components.bitcoin.sensor._LOGGER = logging.getLogger(__name__)
private

Definition at line 22 of file sensor.py.

◆ DEFAULT_CURRENCY

string homeassistant.components.bitcoin.sensor.DEFAULT_CURRENCY = "USD"

Definition at line 24 of file sensor.py.

◆ OPTION_KEYS

list homeassistant.components.bitcoin.sensor.OPTION_KEYS = [desc.key for desc in SENSOR_TYPES]

Definition at line 128 of file sensor.py.

◆ PLATFORM_SCHEMA

homeassistant.components.bitcoin.sensor.PLATFORM_SCHEMA
Initial value:
1 = SENSOR_PLATFORM_SCHEMA.extend(
2  {
3  vol.Required(CONF_DISPLAY_OPTIONS, default=[]): vol.All(
4  cv.ensure_list, [vol.In(OPTION_KEYS)]
5  ),
6  vol.Optional(CONF_CURRENCY, default=DEFAULT_CURRENCY): cv.string,
7  }
8 )

Definition at line 130 of file sensor.py.

◆ SCAN_INTERVAL

homeassistant.components.bitcoin.sensor.SCAN_INTERVAL = timedelta(minutes=5)

Definition at line 26 of file sensor.py.