Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.atome.sensor.AtomeData Class Reference

Public Member Functions

None __init__ (self, AtomeClient client)
 
def day_price (self)
 
def day_usage (self)
 
def is_connected (self)
 
def live_power (self)
 
def month_price (self)
 
def month_usage (self)
 
def subscribed_power (self)
 
def update_day_usage (self)
 
def update_live_usage (self)
 
def update_month_usage (self)
 
def update_week_usage (self)
 
def update_year_usage (self)
 
def week_price (self)
 
def week_usage (self)
 
def year_price (self)
 
def year_usage (self)
 

Public Attributes

 atome_client
 

Private Member Functions

def _retrieve_live (self)
 
def _retrieve_period_usage (self, period_type)
 
def _retrieve_period_usage_with_retry (self, period_type)
 

Private Attributes

 _day_price
 
 _day_usage
 
 _is_connected
 
 _live_power
 
 _month_price
 
 _month_usage
 
 _subscribed_power
 
 _week_price
 
 _week_usage
 
 _year_price
 
 _year_usage
 

Detailed Description

Stores data retrieved from Neurio sensor.

Definition at line 90 of file sensor.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.components.atome.sensor.AtomeData.__init__ (   self,
AtomeClient  client 
)
Initialize the data.

Definition at line 93 of file sensor.py.

Member Function Documentation

◆ _retrieve_live()

def homeassistant.components.atome.sensor.AtomeData._retrieve_live (   self)
private

Definition at line 123 of file sensor.py.

◆ _retrieve_period_usage()

def homeassistant.components.atome.sensor.AtomeData._retrieve_period_usage (   self,
  period_type 
)
private
Return current daily/weekly/monthly/yearly power usage.

Definition at line 152 of file sensor.py.

◆ _retrieve_period_usage_with_retry()

def homeassistant.components.atome.sensor.AtomeData._retrieve_period_usage_with_retry (   self,
  period_type 
)
private
Return current daily/weekly/monthly/yearly power usage with one retry.

Definition at line 164 of file sensor.py.

◆ day_price()

def homeassistant.components.atome.sensor.AtomeData.day_price (   self)
Return latest daily usage value.

Definition at line 187 of file sensor.py.

◆ day_usage()

def homeassistant.components.atome.sensor.AtomeData.day_usage (   self)
Return latest daily usage value.

Definition at line 182 of file sensor.py.

◆ is_connected()

def homeassistant.components.atome.sensor.AtomeData.is_connected (   self)
Return latest active power value.

Definition at line 119 of file sensor.py.

◆ live_power()

def homeassistant.components.atome.sensor.AtomeData.live_power (   self)
Return latest active power value.

Definition at line 109 of file sensor.py.

◆ month_price()

def homeassistant.components.atome.sensor.AtomeData.month_price (   self)
Return latest monthly usage value.

Definition at line 223 of file sensor.py.

◆ month_usage()

def homeassistant.components.atome.sensor.AtomeData.month_usage (   self)
Return latest monthly usage value.

Definition at line 218 of file sensor.py.

◆ subscribed_power()

def homeassistant.components.atome.sensor.AtomeData.subscribed_power (   self)
Return latest active power value.

Definition at line 114 of file sensor.py.

◆ update_day_usage()

def homeassistant.components.atome.sensor.AtomeData.update_day_usage (   self)
Return current daily power usage.

Definition at line 192 of file sensor.py.

◆ update_live_usage()

def homeassistant.components.atome.sensor.AtomeData.update_live_usage (   self)
Return current power value.

Definition at line 145 of file sensor.py.

◆ update_month_usage()

def homeassistant.components.atome.sensor.AtomeData.update_month_usage (   self)
Return current monthly power usage.

Definition at line 228 of file sensor.py.

◆ update_week_usage()

def homeassistant.components.atome.sensor.AtomeData.update_week_usage (   self)
Return current weekly power usage.

Definition at line 210 of file sensor.py.

◆ update_year_usage()

def homeassistant.components.atome.sensor.AtomeData.update_year_usage (   self)
Return current yearly power usage.

Definition at line 246 of file sensor.py.

◆ week_price()

def homeassistant.components.atome.sensor.AtomeData.week_price (   self)
Return latest weekly usage value.

Definition at line 205 of file sensor.py.

◆ week_usage()

def homeassistant.components.atome.sensor.AtomeData.week_usage (   self)
Return latest weekly usage value.

Definition at line 200 of file sensor.py.

◆ year_price()

def homeassistant.components.atome.sensor.AtomeData.year_price (   self)
Return latest yearly usage value.

Definition at line 241 of file sensor.py.

◆ year_usage()

def homeassistant.components.atome.sensor.AtomeData.year_usage (   self)
Return latest yearly usage value.

Definition at line 236 of file sensor.py.

Member Data Documentation

◆ _day_price

homeassistant.components.atome.sensor.AtomeData._day_price
private

Definition at line 100 of file sensor.py.

◆ _day_usage

homeassistant.components.atome.sensor.AtomeData._day_usage
private

Definition at line 99 of file sensor.py.

◆ _is_connected

homeassistant.components.atome.sensor.AtomeData._is_connected
private

Definition at line 98 of file sensor.py.

◆ _live_power

homeassistant.components.atome.sensor.AtomeData._live_power
private

Definition at line 96 of file sensor.py.

◆ _month_price

homeassistant.components.atome.sensor.AtomeData._month_price
private

Definition at line 104 of file sensor.py.

◆ _month_usage

homeassistant.components.atome.sensor.AtomeData._month_usage
private

Definition at line 103 of file sensor.py.

◆ _subscribed_power

homeassistant.components.atome.sensor.AtomeData._subscribed_power
private

Definition at line 97 of file sensor.py.

◆ _week_price

homeassistant.components.atome.sensor.AtomeData._week_price
private

Definition at line 102 of file sensor.py.

◆ _week_usage

homeassistant.components.atome.sensor.AtomeData._week_usage
private

Definition at line 101 of file sensor.py.

◆ _year_price

homeassistant.components.atome.sensor.AtomeData._year_price
private

Definition at line 106 of file sensor.py.

◆ _year_usage

homeassistant.components.atome.sensor.AtomeData._year_usage
private

Definition at line 105 of file sensor.py.

◆ atome_client

homeassistant.components.atome.sensor.AtomeData.atome_client

Definition at line 95 of file sensor.py.


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