Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.starline.account.StarlineAccount Class Reference

Public Member Functions

None __init__ (self, HomeAssistant hass, ConfigEntry config_entry)
 
StarlineApi api (self)
 
None set_update_interval (self, int interval)
 
None set_update_obd_interval (self, int interval)
 
def unload (self)
 
def update (self, unused=None)
 
def update_obd (self, unused=None)
 

Static Public Member Functions

dict[str, Any] balance_attrs (StarlineDevice device)
 
DeviceInfo device_info (StarlineDevice device)
 
dict[str, Any] engine_attrs (StarlineDevice device)
 
dict[str, Any] errors_attrs (StarlineDevice device)
 
dict[str, Any] gps_attrs (StarlineDevice device)
 
dict[str, Any] gsm_attrs (StarlineDevice device)
 

Private Member Functions

None _check_slnet_token (self, int interval)
 
None _save_slnet_token (self, data)
 
def _update_data (self)
 
def _update_obd_data (self)
 
None _update_slnet_token (self)
 

Private Attributes

 _unsubscribe_auto_obd_updater
 
 _unsubscribe_auto_updater
 
 _update_interval
 
 _update_obd_interval
 

Detailed Description

StarLine Account class.

Definition at line 35 of file account.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.components.starline.account.StarlineAccount.__init__ (   self,
HomeAssistant  hass,
ConfigEntry  config_entry 
)
Initialize StarLine account.

Definition at line 38 of file account.py.

Member Function Documentation

◆ _check_slnet_token()

None homeassistant.components.starline.account.StarlineAccount._check_slnet_token (   self,
int  interval 
)
private
Check SLNet token expiration and update if needed.

Definition at line 50 of file account.py.

◆ _save_slnet_token()

None homeassistant.components.starline.account.StarlineAccount._save_slnet_token (   self,
  data 
)
private

Definition at line 81 of file account.py.

◆ _update_data()

def homeassistant.components.starline.account.StarlineAccount._update_data (   self)
private
Update StarLine data.

Definition at line 87 of file account.py.

◆ _update_obd_data()

def homeassistant.components.starline.account.StarlineAccount._update_obd_data (   self)
private
Update StarLine OBD data.

Definition at line 92 of file account.py.

◆ _update_slnet_token()

None homeassistant.components.starline.account.StarlineAccount._update_slnet_token (   self)
private
Update SLNet token.

Definition at line 58 of file account.py.

◆ api()

StarlineApi homeassistant.components.starline.account.StarlineAccount.api (   self)
Return the instance of the API.

Definition at line 98 of file account.py.

◆ balance_attrs()

dict[str, Any] homeassistant.components.starline.account.StarlineAccount.balance_attrs ( StarlineDevice  device)
static
Attributes for balance sensor.

Definition at line 165 of file account.py.

◆ device_info()

DeviceInfo homeassistant.components.starline.account.StarlineAccount.device_info ( StarlineDevice  device)
static
Device information for entities.

Definition at line 145 of file account.py.

◆ engine_attrs()

dict[str, Any] homeassistant.components.starline.account.StarlineAccount.engine_attrs ( StarlineDevice  device)
static
Attributes for engine switch.

Definition at line 184 of file account.py.

◆ errors_attrs()

dict[str, Any] homeassistant.components.starline.account.StarlineAccount.errors_attrs ( StarlineDevice  device)
static
Attributes for errors sensor.

Definition at line 192 of file account.py.

◆ gps_attrs()

dict[str, Any] homeassistant.components.starline.account.StarlineAccount.gps_attrs ( StarlineDevice  device)
static
Attributes for device tracker.

Definition at line 157 of file account.py.

◆ gsm_attrs()

dict[str, Any] homeassistant.components.starline.account.StarlineAccount.gsm_attrs ( StarlineDevice  device)
static
Attributes for GSM sensor.

Definition at line 174 of file account.py.

◆ set_update_interval()

None homeassistant.components.starline.account.StarlineAccount.set_update_interval (   self,
int  interval 
)
Set StarLine API update interval.

Definition at line 110 of file account.py.

◆ set_update_obd_interval()

None homeassistant.components.starline.account.StarlineAccount.set_update_obd_interval (   self,
int  interval 
)
Set StarLine API OBD update interval.

Definition at line 122 of file account.py.

◆ unload()

def homeassistant.components.starline.account.StarlineAccount.unload (   self)
Unload StarLine API.

Definition at line 134 of file account.py.

◆ update()

def homeassistant.components.starline.account.StarlineAccount.update (   self,
  unused = None 
)
Update StarLine data.

Definition at line 102 of file account.py.

◆ update_obd()

def homeassistant.components.starline.account.StarlineAccount.update_obd (   self,
  unused = None 
)
Update StarLine OBD data.

Definition at line 106 of file account.py.

Member Data Documentation

◆ _unsubscribe_auto_obd_updater

homeassistant.components.starline.account.StarlineAccount._unsubscribe_auto_obd_updater
private

Definition at line 130 of file account.py.

◆ _unsubscribe_auto_updater

homeassistant.components.starline.account.StarlineAccount._unsubscribe_auto_updater
private

Definition at line 118 of file account.py.

◆ _update_interval

homeassistant.components.starline.account.StarlineAccount._update_interval
private

Definition at line 113 of file account.py.

◆ _update_obd_interval

homeassistant.components.starline.account.StarlineAccount._update_obd_interval
private

Definition at line 125 of file account.py.


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