Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.blue_current.Connector Class Reference

Public Member Functions

None __init__ (self, HomeAssistant hass, BlueCurrentConfigEntry config, Client client)
 
None add_charge_point (self, str evse_id, str model, str name)
 
bool connected (self)
 
None dispatch_charge_point_update_signal (self, str evse_id)
 
None dispatch_grid_update_signal (self)
 
None handle_charge_point (self, str evse_id, str model, str name)
 
None handle_charge_point_data (self, list charge_points_data)
 
None on_data (self, dict message)
 
None on_open (self)
 
None run_task (self)
 
None update_charge_point (self, str evse_id, dict data)
 

Public Attributes

 client
 
 config
 
 grid
 
 hass
 

Private Member Functions

None _disconnect (self)
 
None _on_disconnect (self)
 

Detailed Description

Define a class that connects to the Blue Current websocket API.

Definition at line 70 of file __init__.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.components.blue_current.Connector.__init__ (   self,
HomeAssistant  hass,
BlueCurrentConfigEntry  config,
Client   client 
)
Initialize.

Definition at line 73 of file __init__.py.

Member Function Documentation

◆ _disconnect()

None homeassistant.components.blue_current.Connector._disconnect (   self)
private
Disconnect from the websocket.

Definition at line 169 of file __init__.py.

◆ _on_disconnect()

None homeassistant.components.blue_current.Connector._on_disconnect (   self)
private
Dispatch signals to update entity states.

Definition at line 163 of file __init__.py.

◆ add_charge_point()

None homeassistant.components.blue_current.Connector.add_charge_point (   self,
str  evse_id,
str  model,
str  name 
)
Add a charge point to charge_points.

Definition at line 122 of file __init__.py.

◆ connected()

bool homeassistant.components.blue_current.Connector.connected (   self)
Returns the connection status.

Definition at line 176 of file __init__.py.

◆ dispatch_charge_point_update_signal()

None homeassistant.components.blue_current.Connector.dispatch_charge_point_update_signal (   self,
str  evse_id 
)
Dispatch a charge point update signal.

Definition at line 131 of file __init__.py.

◆ dispatch_grid_update_signal()

None homeassistant.components.blue_current.Connector.dispatch_grid_update_signal (   self)
Dispatch a grid update signal.

Definition at line 135 of file __init__.py.

◆ handle_charge_point()

None homeassistant.components.blue_current.Connector.handle_charge_point (   self,
str  evse_id,
str  model,
str  name 
)
Add the chargepoint and request their data.

Definition at line 117 of file __init__.py.

◆ handle_charge_point_data()

None homeassistant.components.blue_current.Connector.handle_charge_point_data (   self,
list  charge_points_data 
)
Handle incoming chargepoint data.

Definition at line 105 of file __init__.py.

◆ on_data()

None homeassistant.components.blue_current.Connector.on_data (   self,
dict  message 
)
Handle received data.

Definition at line 83 of file __init__.py.

◆ on_open()

None homeassistant.components.blue_current.Connector.on_open (   self)
Fetch data when connection is established.

Definition at line 139 of file __init__.py.

◆ run_task()

None homeassistant.components.blue_current.Connector.run_task (   self)
Start the receive loop.

Definition at line 143 of file __init__.py.

◆ update_charge_point()

None homeassistant.components.blue_current.Connector.update_charge_point (   self,
str  evse_id,
dict  data 
)
Update the charge point data.

Definition at line 126 of file __init__.py.

Member Data Documentation

◆ client

homeassistant.components.blue_current.Connector.client

Definition at line 79 of file __init__.py.

◆ config

homeassistant.components.blue_current.Connector.config

Definition at line 77 of file __init__.py.

◆ grid

homeassistant.components.blue_current.Connector.grid

Definition at line 102 of file __init__.py.

◆ hass

homeassistant.components.blue_current.Connector.hass

Definition at line 78 of file __init__.py.


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