Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.kraken.KrakenData Class Reference

Public Member Functions

None __init__ (self, HomeAssistant hass, ConfigEntry config_entry)
 
None async_setup (self)
 
KrakenResponse|None async_update (self)
 
None set_update_interval (self, int update_interval)
 

Public Attributes

 coordinator
 
 tradable_asset_pairs
 

Private Member Functions

None _async_refresh_tradable_asset_pairs (self)
 
KrakenResponse _get_kraken_data (self)
 
str _get_websocket_name_asset_pairs (self)
 

Private Attributes

 _api
 
 _config_entry
 
 _hass
 

Detailed Description

Define an object to hold kraken data.

Definition at line 56 of file __init__.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.components.kraken.KrakenData.__init__ (   self,
HomeAssistant  hass,
ConfigEntry  config_entry 
)
Initialize.

Definition at line 59 of file __init__.py.

Member Function Documentation

◆ _async_refresh_tradable_asset_pairs()

None homeassistant.components.kraken.KrakenData._async_refresh_tradable_asset_pairs (   self)
private

Definition at line 116 of file __init__.py.

◆ _get_kraken_data()

KrakenResponse homeassistant.components.kraken.KrakenData._get_kraken_data (   self)
private

Definition at line 96 of file __init__.py.

◆ _get_websocket_name_asset_pairs()

str homeassistant.components.kraken.KrakenData._get_websocket_name_asset_pairs (   self)
private

Definition at line 147 of file __init__.py.

◆ async_setup()

None homeassistant.components.kraken.KrakenData.async_setup (   self)
Set up the Kraken integration.

Definition at line 121 of file __init__.py.

◆ async_update()

KrakenResponse | None homeassistant.components.kraken.KrakenData.async_update (   self)
Get the latest data from the Kraken.com REST API.

All tradeable asset pairs are retrieved, not the tracked asset pairs
selected by the user. This enables us to check for an unknown and
thus likely removed asset pair in sensor.py and only log a warning
once.

Definition at line 67 of file __init__.py.

◆ set_update_interval()

None homeassistant.components.kraken.KrakenData.set_update_interval (   self,
int  update_interval 
)
Set the coordinator update_interval to the supplied update_interval.

Definition at line 150 of file __init__.py.

Member Data Documentation

◆ _api

homeassistant.components.kraken.KrakenData._api
private

Definition at line 63 of file __init__.py.

◆ _config_entry

homeassistant.components.kraken.KrakenData._config_entry
private

Definition at line 62 of file __init__.py.

◆ _hass

homeassistant.components.kraken.KrakenData._hass
private

Definition at line 61 of file __init__.py.

◆ coordinator

homeassistant.components.kraken.KrakenData.coordinator

Definition at line 134 of file __init__.py.

◆ tradable_asset_pairs

homeassistant.components.kraken.KrakenData.tradable_asset_pairs

Definition at line 117 of file __init__.py.


The documentation for this class was generated from the following file: