Home Assistant Unofficial Reference 2024.12.1
__init__.py
Go to the documentation of this file.
1 """The StarLine component."""
2 
3 from __future__ import annotations
4 
5 import voluptuous as vol
6 
7 from homeassistant.config_entries import ConfigEntry
8 from homeassistant.const import CONF_SCAN_INTERVAL
9 from homeassistant.core import HomeAssistant, ServiceCall
10 from homeassistant.exceptions import ConfigEntryNotReady
11 from homeassistant.helpers import device_registry as dr
12 
13 from .account import StarlineAccount
14 from .const import (
15  CONF_SCAN_OBD_INTERVAL,
16  DEFAULT_SCAN_INTERVAL,
17  DEFAULT_SCAN_OBD_INTERVAL,
18  DOMAIN,
19  PLATFORMS,
20  SERVICE_SET_SCAN_INTERVAL,
21  SERVICE_SET_SCAN_OBD_INTERVAL,
22  SERVICE_UPDATE_STATE,
23 )
24 
25 
26 async def async_setup_entry(hass: HomeAssistant, entry: ConfigEntry) -> bool:
27  """Set up the StarLine device from a config entry."""
28  account = StarlineAccount(hass, entry)
29  await account.update()
30  await account.update_obd()
31  if not account.api.available:
32  raise ConfigEntryNotReady
33 
34  if DOMAIN not in hass.data:
35  hass.data[DOMAIN] = {}
36  hass.data[DOMAIN][entry.entry_id] = account
37 
38  device_registry = dr.async_get(hass)
39  for device in account.api.devices.values():
40  device_registry.async_get_or_create(
41  config_entry_id=entry.entry_id, **account.device_info(device)
42  )
43 
44  await hass.config_entries.async_forward_entry_setups(entry, PLATFORMS)
45 
46  async def async_set_scan_interval(call: ServiceCall) -> None:
47  """Set scan interval."""
48  options = dict(entry.options)
49  options[CONF_SCAN_INTERVAL] = call.data[CONF_SCAN_INTERVAL]
50  hass.config_entries.async_update_entry(entry=entry, options=options)
51 
52  async def async_set_scan_obd_interval(call: ServiceCall) -> None:
53  """Set OBD info scan interval."""
54  options = dict(entry.options)
55  options[CONF_SCAN_OBD_INTERVAL] = call.data[CONF_SCAN_INTERVAL]
56  hass.config_entries.async_update_entry(entry=entry, options=options)
57 
58  async def async_update(call: ServiceCall | None = None) -> None:
59  """Update all data."""
60  await account.update()
61  await account.update_obd()
62 
63  hass.services.async_register(DOMAIN, SERVICE_UPDATE_STATE, async_update)
64  hass.services.async_register(
65  DOMAIN,
66  SERVICE_SET_SCAN_INTERVAL,
67  async_set_scan_interval,
68  schema=vol.Schema(
69  {
70  vol.Required(CONF_SCAN_INTERVAL): vol.All(
71  vol.Coerce(int), vol.Range(min=10)
72  )
73  }
74  ),
75  )
76  hass.services.async_register(
77  DOMAIN,
78  SERVICE_SET_SCAN_OBD_INTERVAL,
79  async_set_scan_obd_interval,
80  schema=vol.Schema(
81  {
82  vol.Required(CONF_SCAN_INTERVAL): vol.All(
83  vol.Coerce(int), vol.Range(min=180)
84  )
85  }
86  ),
87  )
88 
89  entry.async_on_unload(entry.add_update_listener(async_options_updated))
90  await async_options_updated(hass, entry)
91 
92  return True
93 
94 
95 async def async_unload_entry(hass: HomeAssistant, config_entry: ConfigEntry) -> bool:
96  """Unload a config entry."""
97  unload_ok = await hass.config_entries.async_unload_platforms(
98  config_entry, PLATFORMS
99  )
100 
101  account: StarlineAccount = hass.data[DOMAIN][config_entry.entry_id]
102  account.unload()
103  return unload_ok
104 
105 
106 async def async_options_updated(hass: HomeAssistant, config_entry: ConfigEntry) -> None:
107  """Triggered by config entry options updates."""
108  account: StarlineAccount = hass.data[DOMAIN][config_entry.entry_id]
109  scan_interval = config_entry.options.get(CONF_SCAN_INTERVAL, DEFAULT_SCAN_INTERVAL)
110  scan_obd_interval = config_entry.options.get(
111  CONF_SCAN_OBD_INTERVAL, DEFAULT_SCAN_OBD_INTERVAL
112  )
113  account.set_update_interval(scan_interval)
114  account.set_update_obd_interval(scan_obd_interval)
bool async_unload_entry(HomeAssistant hass, ConfigEntry config_entry)
Definition: __init__.py:95
bool async_setup_entry(HomeAssistant hass, ConfigEntry entry)
Definition: __init__.py:26
None async_options_updated(HomeAssistant hass, ConfigEntry config_entry)
Definition: __init__.py:106