Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.subaru Namespace Reference

Namespaces

 config_flow
 
 const
 
 device_tracker
 
 diagnostics
 
 lock
 
 remote_service
 
 sensor
 

Functions

bool async_setup_entry (HomeAssistant hass, ConfigEntry entry)
 
bool async_unload_entry (HomeAssistant hass, ConfigEntry entry)
 
def get_device_info (vehicle_info)
 
def get_vehicle_info (controller, vin)
 
def refresh_subaru_data (config_entry, vehicle_info, controller)
 
def update_subaru (vehicle, controller)
 

Variables

 _LOGGER = logging.getLogger(__name__)
 

Detailed Description

The Subaru integration.

Function Documentation

◆ async_setup_entry()

bool homeassistant.components.subaru.async_setup_entry ( HomeAssistant  hass,
ConfigEntry  entry 
)
Set up Subaru from a config entry.

Definition at line 49 of file __init__.py.

◆ async_unload_entry()

bool homeassistant.components.subaru.async_unload_entry ( HomeAssistant  hass,
ConfigEntry  entry 
)
Unload a config entry.

Definition at line 108 of file __init__.py.

◆ get_device_info()

def homeassistant.components.subaru.get_device_info (   vehicle_info)
Return DeviceInfo object based on vehicle info.

Definition at line 167 of file __init__.py.

◆ get_vehicle_info()

def homeassistant.components.subaru.get_vehicle_info (   controller,
  vin 
)
Obtain vehicle identifiers and capabilities.

Definition at line 151 of file __init__.py.

◆ refresh_subaru_data()

def homeassistant.components.subaru.refresh_subaru_data (   config_entry,
  vehicle_info,
  controller 
)
Refresh local data with data fetched via Subaru API.

Subaru API calls assume a server side vehicle context
Data fetch/update must be done for each vehicle

Definition at line 116 of file __init__.py.

◆ update_subaru()

def homeassistant.components.subaru.update_subaru (   vehicle,
  controller 
)
Commands remote vehicle update (polls the vehicle to update subaru API cache).

Definition at line 141 of file __init__.py.

Variable Documentation

◆ _LOGGER

homeassistant.components.subaru._LOGGER = logging.getLogger(__name__)
private

Definition at line 46 of file __init__.py.