Home Assistant Unofficial Reference 2024.12.1
switch.py
Go to the documentation of this file.
1 """Support for bypassing Risco alarm zones."""
2 
3 from __future__ import annotations
4 
5 from typing import Any
6 
7 from pyrisco.common import Zone
8 
9 from homeassistant.components.switch import SwitchEntity
10 from homeassistant.config_entries import ConfigEntry
11 from homeassistant.const import EntityCategory
12 from homeassistant.core import HomeAssistant
13 from homeassistant.helpers.entity_platform import AddEntitiesCallback
14 
15 from . import LocalData, is_local
16 from .const import DATA_COORDINATOR, DOMAIN
17 from .coordinator import RiscoDataUpdateCoordinator
18 from .entity import RiscoCloudZoneEntity, RiscoLocalZoneEntity
19 
20 
22  hass: HomeAssistant,
23  config_entry: ConfigEntry,
24  async_add_entities: AddEntitiesCallback,
25 ) -> None:
26  """Set up the Risco switch."""
27  if is_local(config_entry):
28  local_data: LocalData = hass.data[DOMAIN][config_entry.entry_id]
30  RiscoLocalSwitch(local_data.system.id, zone_id, zone)
31  for zone_id, zone in local_data.system.zones.items()
32  )
33  else:
34  coordinator: RiscoDataUpdateCoordinator = hass.data[DOMAIN][
35  config_entry.entry_id
36  ][DATA_COORDINATOR]
38  RiscoCloudSwitch(coordinator, zone_id, zone)
39  for zone_id, zone in coordinator.data.zones.items()
40  )
41 
42 
44  """Representation of a bypass switch for a Risco cloud zone."""
45 
46  _attr_entity_category = EntityCategory.CONFIG
47  _attr_translation_key = "bypassed"
48 
49  def __init__(
50  self, coordinator: RiscoDataUpdateCoordinator, zone_id: int, zone: Zone
51  ) -> None:
52  """Init the zone."""
53  super().__init__(
54  coordinator=coordinator,
55  suffix="_bypassed",
56  zone_id=zone_id,
57  zone=zone,
58  )
59 
60  @property
61  def is_on(self) -> bool | None:
62  """Return true if the zone is bypassed."""
63  return self._zone_zone_zone.bypassed
64 
65  async def async_turn_on(self, **kwargs: Any) -> None:
66  """Turn the entity on."""
67  await self._bypass_bypass(True)
68 
69  async def async_turn_off(self, **kwargs: Any) -> None:
70  """Turn the entity off."""
71  await self._bypass_bypass(False)
72 
73  async def _bypass(self, bypass: bool) -> None:
74  alarm = await self._risco_risco.bypass_zone(self._zone_id_zone_id, bypass)
75  self._zone_zone_zone = alarm.zones[self._zone_id_zone_id]
76  self.async_write_ha_stateasync_write_ha_state()
77 
78 
80  """Representation of a bypass switch for a Risco local zone."""
81 
82  _attr_entity_category = EntityCategory.CONFIG
83  _attr_translation_key = "bypassed"
84 
85  def __init__(self, system_id: str, zone_id: int, zone: Zone) -> None:
86  """Init the zone."""
87  super().__init__(
88  system_id=system_id,
89  suffix="_bypassed",
90  zone_id=zone_id,
91  zone=zone,
92  )
93 
94  @property
95  def is_on(self) -> bool | None:
96  """Return true if the zone is bypassed."""
97  return self._zone_zone.bypassed
98 
99  async def async_turn_on(self, **kwargs: Any) -> None:
100  """Turn the entity on."""
101  await self._bypass_bypass(True)
102 
103  async def async_turn_off(self, **kwargs: Any) -> None:
104  """Turn the entity off."""
105  await self._bypass_bypass(False)
106 
107  async def _bypass(self, bypass: bool) -> None:
108  await self._zone_zone.bypass(bypass)
None __init__(self, RiscoDataUpdateCoordinator coordinator, int zone_id, Zone zone)
Definition: switch.py:51
None __init__(self, str system_id, int zone_id, Zone zone)
Definition: switch.py:85
None async_setup_entry(HomeAssistant hass, ConfigEntry config_entry, AddEntitiesCallback async_add_entities)
Definition: switch.py:25
bool is_local(ConfigEntry entry)
Definition: __init__.py:58