Ryan Malloy
57b8aa4b04
custom_components/omni_pca/ — six new platform modules wrapping the
v1.0 client surface. Every command method catches CommandFailedError
and re-raises HomeAssistantError so panel rejections (bad code, etc.)
become user-friendly HA errors instead of silent failures.
alarm_control_panel.py — OmniAreaAlarmPanel per discovered area.
Supports ARM_HOME (Day) / ARM_NIGHT / ARM_AWAY / ARM_VACATION /
ARM_CUSTOM_BYPASS (Day-Instant). State derives from area_status via
pure helpers.security_mode_to_alarm_state which handles arming-in-
progress, entry/exit timers, and active-alarm overrides.
light.py — OmniUnitLight per discovered unit (every unit; non-dimmable
units silently ignore brightness, no harm done). Brightness conversion
via helpers.omni_state_to_ha_brightness / ha_brightness_to_omni_percent
(Omni state byte: 0=off, 1=on, 100..200=brightness percent).
switch.py — OmniZoneBypassSwitch per binary zone. CONFIG entity_category;
pairs with the existing diagnostic 'zone bypassed' binary_sensor.
climate.py — OmniThermostatClimate per discovered thermostat.
Supports OFF / HEAT / COOL / HEAT_COOL hvac_modes; auto / on / diffuse
fan_modes; none / hold / vacation preset_modes. Single-setpoint and
range setpoint via TARGET_TEMPERATURE_RANGE. Fahrenheit native (Omni
panels are F-native; HA handles unit conversion downstream).
sensor.py — analog zones (temperature/humidity/power) + per-thermostat
diagnostic temp/humidity/outdoor sensors + OmniSystemModelSensor
+ OmniLastEventSensor (event_class + parsed event fields as attrs).
button.py — OmniPanelButton per discovered button macro. Programs not
yet exposed because the library lacks RequestProperties for Programs.
event.py — single OmniPanelEvent per panel relaying typed SystemEvents
via _trigger_event. event_types: zone_state_changed, unit_state_changed,
arming_changed, alarm_activated/cleared, ac_lost/restored,
battery_low/restored, user_macro_button, phone_line_dead/restored.
Automations key off platform: event + event_type filter.
helpers.py — extended with security_mode_to_alarm_state,
ARM_SERVICE_TO_SECURITY_MODE, omni_state_to_ha_brightness +
ha_brightness_to_omni_percent, omni/ha_{hvac,fan,hold} round-trips,
fahrenheit_to_omni_raw / celsius_to_omni_raw, analog_zone_device_class,
EVENT_TYPES tuple, event_type_for(class_name).
__init__.py — PLATFORMS extended to all 8 entity types.
scene.py intentionally NOT created — Omni 'scenes' are user-defined
button macros, already covered by the button platform. Documented in
README; revisit if/when the library gains scene-discovery opcodes.
tests/test_ha_helpers.py: +67 unit tests covering every new helper.
331 tests pass (was 264). Ruff clean across src/ tests/ custom_components/.
90 lines
3.2 KiB
Python
90 lines
3.2 KiB
Python
"""Switch platform — per-zone bypass control.
|
|
|
|
Lights are exposed via the ``light`` platform. The switch platform is
|
|
reserved for *configuration* toggles like zone bypass, where the user
|
|
wants a write surface that pairs with the diagnostic ``zone bypassed``
|
|
binary sensor for read.
|
|
"""
|
|
|
|
from __future__ import annotations
|
|
|
|
from typing import TYPE_CHECKING, Any
|
|
|
|
from homeassistant.components.switch import SwitchEntity
|
|
from homeassistant.exceptions import HomeAssistantError
|
|
from homeassistant.helpers.entity import EntityCategory
|
|
from homeassistant.helpers.update_coordinator import CoordinatorEntity
|
|
|
|
from omni_pca.commands import CommandFailedError
|
|
|
|
from .const import DOMAIN
|
|
from .coordinator import OmniDataUpdateCoordinator
|
|
from .helpers import is_binary_zone_type, prettify_name
|
|
|
|
if TYPE_CHECKING:
|
|
from homeassistant.config_entries import ConfigEntry
|
|
from homeassistant.core import HomeAssistant
|
|
from homeassistant.helpers.entity_platform import AddEntitiesCallback
|
|
|
|
|
|
async def async_setup_entry(
|
|
hass: HomeAssistant,
|
|
entry: ConfigEntry,
|
|
async_add_entities: AddEntitiesCallback,
|
|
) -> None:
|
|
coordinator: OmniDataUpdateCoordinator = hass.data[DOMAIN][entry.entry_id]
|
|
entities: list[SwitchEntity] = []
|
|
for index in sorted(coordinator.data.zones):
|
|
props = coordinator.data.zones[index]
|
|
if not is_binary_zone_type(props.zone_type):
|
|
continue
|
|
entities.append(OmniZoneBypassSwitch(coordinator, index))
|
|
async_add_entities(entities)
|
|
|
|
|
|
class OmniZoneBypassSwitch(CoordinatorEntity[OmniDataUpdateCoordinator], SwitchEntity):
|
|
"""Toggle that bypasses or restores a single zone."""
|
|
|
|
_attr_has_entity_name = True
|
|
_attr_entity_category = EntityCategory.CONFIG
|
|
|
|
def __init__(
|
|
self, coordinator: OmniDataUpdateCoordinator, index: int
|
|
) -> None:
|
|
super().__init__(coordinator)
|
|
self._index = index
|
|
self._attr_unique_id = f"{coordinator.unique_id}-zone-{index}-bypass"
|
|
props = coordinator.data.zones[index]
|
|
base = prettify_name(props.name) or f"Zone {index}"
|
|
self._attr_name = f"{base} Bypass"
|
|
self._attr_device_info = coordinator.device_info
|
|
|
|
@property
|
|
def available(self) -> bool:
|
|
return (
|
|
super().available
|
|
and self.coordinator.data is not None
|
|
and self._index in self.coordinator.data.zones
|
|
)
|
|
|
|
@property
|
|
def is_on(self) -> bool | None:
|
|
status = self.coordinator.data.zone_status.get(self._index)
|
|
if status is None:
|
|
return None
|
|
return status.is_bypassed
|
|
|
|
async def async_turn_on(self, **kwargs: Any) -> None:
|
|
try:
|
|
await self.coordinator.client.bypass_zone(self._index)
|
|
except CommandFailedError as err:
|
|
raise HomeAssistantError(f"Panel rejected bypass: {err}") from err
|
|
await self.coordinator.async_request_refresh()
|
|
|
|
async def async_turn_off(self, **kwargs: Any) -> None:
|
|
try:
|
|
await self.coordinator.client.restore_zone(self._index)
|
|
except CommandFailedError as err:
|
|
raise HomeAssistantError(f"Panel rejected restore: {err}") from err
|
|
await self.coordinator.async_request_refresh()
|