Compare commits
6 Commits
0.14.3-con
...
0.15.1
| Author | SHA1 | Date | |
|---|---|---|---|
|
38762d60f2
|
|||
|
4f5bcd7dbf
|
|||
|
3bcaa93570
|
|||
|
331945f789
|
|||
|
52235be637
|
|||
|
94589f52d7
|
@@ -1,6 +1,9 @@
|
|||||||
when:
|
when:
|
||||||
event: [tag]
|
event: [tag]
|
||||||
|
|
||||||
|
depends_on:
|
||||||
|
- namespace
|
||||||
|
|
||||||
steps:
|
steps:
|
||||||
apply_configuration:
|
apply_configuration:
|
||||||
image: quay.io/wollud1969/k8s-admin-helper:0.3.4
|
image: quay.io/wollud1969/k8s-admin-helper:0.3.4
|
||||||
|
|||||||
@@ -15,7 +15,7 @@ import uuid
|
|||||||
from aiomqtt import Client
|
from aiomqtt import Client
|
||||||
from pydantic import ValidationError
|
from pydantic import ValidationError
|
||||||
|
|
||||||
from packages.home_capabilities import LightState, ThermostatState, ContactState, TempHumidityState, RelayState, ThreePhasePowerState, SwitchState
|
from packages.home_capabilities import LightState, ThermostatState, ContactState, TempHumidityState, RelayState, ThreePhasePowerState
|
||||||
from apps.abstraction.transformation import (
|
from apps.abstraction.transformation import (
|
||||||
transform_abstract_to_vendor,
|
transform_abstract_to_vendor,
|
||||||
transform_vendor_to_abstract
|
transform_vendor_to_abstract
|
||||||
@@ -174,10 +174,6 @@ async def handle_abstract_set(
|
|||||||
# Contact sensors are read-only - SET commands should not occur
|
# Contact sensors are read-only - SET commands should not occur
|
||||||
logger.warning(f"Contact sensor {device_id} received SET command - ignoring (read-only device)")
|
logger.warning(f"Contact sensor {device_id} received SET command - ignoring (read-only device)")
|
||||||
return
|
return
|
||||||
elif device_type == "switch":
|
|
||||||
# Switches are read-only - SET commands should not occur
|
|
||||||
logger.warning(f"Switch {device_id} received SET command - ignoring (read-only device)")
|
|
||||||
return
|
|
||||||
except ValidationError as e:
|
except ValidationError as e:
|
||||||
logger.error(f"Validation failed for {device_type} SET {device_id}: {e}")
|
logger.error(f"Validation failed for {device_type} SET {device_id}: {e}")
|
||||||
return
|
return
|
||||||
@@ -231,9 +227,6 @@ async def handle_vendor_state(
|
|||||||
elif device_type == "three_phase_powermeter":
|
elif device_type == "three_phase_powermeter":
|
||||||
# Validate three-phase powermeter state
|
# Validate three-phase powermeter state
|
||||||
ThreePhasePowerState.model_validate(abstract_payload)
|
ThreePhasePowerState.model_validate(abstract_payload)
|
||||||
elif device_type == "switch":
|
|
||||||
# Validate switch state
|
|
||||||
SwitchState.model_validate(abstract_payload)
|
|
||||||
except ValidationError as e:
|
except ValidationError as e:
|
||||||
logger.error(f"Validation failed for {device_type} STATE {device_id}: {e}")
|
logger.error(f"Validation failed for {device_type} STATE {device_id}: {e}")
|
||||||
return
|
return
|
||||||
|
|||||||
@@ -15,6 +15,7 @@ from apps.abstraction.vendors import (
|
|||||||
simulator,
|
simulator,
|
||||||
zigbee2mqtt,
|
zigbee2mqtt,
|
||||||
max,
|
max,
|
||||||
|
test,
|
||||||
shelly,
|
shelly,
|
||||||
tasmota,
|
tasmota,
|
||||||
hottis_pv_modbus,
|
hottis_pv_modbus,
|
||||||
@@ -40,6 +41,7 @@ for vendor_name, vendor_module in [
|
|||||||
("simulator", simulator),
|
("simulator", simulator),
|
||||||
("zigbee2mqtt", zigbee2mqtt),
|
("zigbee2mqtt", zigbee2mqtt),
|
||||||
("max", max),
|
("max", max),
|
||||||
|
("test", test),
|
||||||
("shelly", shelly),
|
("shelly", shelly),
|
||||||
("tasmota", tasmota),
|
("tasmota", tasmota),
|
||||||
("hottis_pv_modbus", hottis_pv_modbus),
|
("hottis_pv_modbus", hottis_pv_modbus),
|
||||||
|
|||||||
62
apps/abstraction/vendors/test.py
vendored
Normal file
62
apps/abstraction/vendors/test.py
vendored
Normal file
@@ -0,0 +1,62 @@
|
|||||||
|
"""test vendor transformations."""
|
||||||
|
|
||||||
|
import json
|
||||||
|
import logging
|
||||||
|
from typing import Any
|
||||||
|
|
||||||
|
logger = logging.getLogger(__name__)
|
||||||
|
|
||||||
|
|
||||||
|
def transform_contact_sensor_to_vendor(payload: dict[str, Any]) -> str:
|
||||||
|
"""Transform abstract contact sensor payload to MAX! format.
|
||||||
|
|
||||||
|
Contact sensors are read-only.
|
||||||
|
"""
|
||||||
|
logger.warning("Contact sensors are read-only - SET commands should not be used")
|
||||||
|
return json.dumps(payload)
|
||||||
|
|
||||||
|
|
||||||
|
def transform_contact_sensor_to_abstract(payload: str) -> dict[str, Any]:
|
||||||
|
try:
|
||||||
|
contact_value = payload.strip().lower()
|
||||||
|
return {
|
||||||
|
"contact": "open" if (contact_value == "open") else "closed"
|
||||||
|
}
|
||||||
|
except (ValueError, TypeError) as e:
|
||||||
|
logger.error(f"contact sensor failed to parse: {payload}, error: {e}")
|
||||||
|
return {"contact": "closed"}
|
||||||
|
|
||||||
|
|
||||||
|
def transform_thermostat_to_vendor(payload: dict[str, Any]) -> str:
|
||||||
|
if "target" not in payload:
|
||||||
|
logger.warning(f"thermostat payload missing 'target': {payload}")
|
||||||
|
return "21"
|
||||||
|
|
||||||
|
target_temp = payload["target"]
|
||||||
|
|
||||||
|
if isinstance(target_temp, (int, float)):
|
||||||
|
int_temp = int(round(target_temp))
|
||||||
|
return str(int_temp)
|
||||||
|
|
||||||
|
logger.warning(f"invalid target temperature type: {type(target_temp)}")
|
||||||
|
return "21"
|
||||||
|
|
||||||
|
|
||||||
|
def transform_thermostat_to_abstract(payload: str) -> dict[str, Any]:
|
||||||
|
target_temp = float(payload.strip())
|
||||||
|
|
||||||
|
return {
|
||||||
|
"target": target_temp,
|
||||||
|
"mode": "heat"
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
# Registry of handlers for this vendor
|
||||||
|
HANDLERS = {
|
||||||
|
("contact_sensor", "to_vendor"): transform_contact_sensor_to_vendor,
|
||||||
|
("contact_sensor", "to_abstract"): transform_contact_sensor_to_abstract,
|
||||||
|
("contact", "to_vendor"): transform_contact_sensor_to_vendor,
|
||||||
|
("contact", "to_abstract"): transform_contact_sensor_to_abstract,
|
||||||
|
("thermostat", "to_vendor"): transform_thermostat_to_vendor,
|
||||||
|
("thermostat", "to_abstract"): transform_thermostat_to_abstract,
|
||||||
|
}
|
||||||
20
apps/abstraction/vendors/zigbee2mqtt.py
vendored
20
apps/abstraction/vendors/zigbee2mqtt.py
vendored
@@ -161,24 +161,6 @@ def transform_temp_humidity_sensor_to_abstract(payload: str) -> dict[str, Any]:
|
|||||||
return payload
|
return payload
|
||||||
|
|
||||||
|
|
||||||
def transform_switch_to_vendor(payload: dict[str, Any]) -> str:
|
|
||||||
"""Transform abstract switch payload to zigbee2mqtt format.
|
|
||||||
|
|
||||||
Switches are read-only, so this should not be called for SET commands.
|
|
||||||
"""
|
|
||||||
logger.warning("Switches are read-only - SET commands should not be used")
|
|
||||||
return json.dumps(payload)
|
|
||||||
|
|
||||||
|
|
||||||
def transform_switch_to_abstract(payload: str) -> dict[str, Any]:
|
|
||||||
"""Transform zigbee2mqtt switch payload to abstract format.
|
|
||||||
|
|
||||||
Passthrough - zigbee2mqtt provides action, battery, linkquality directly.
|
|
||||||
"""
|
|
||||||
payload = json.loads(payload)
|
|
||||||
return payload
|
|
||||||
|
|
||||||
|
|
||||||
def transform_relay_to_vendor(payload: dict[str, Any]) -> str:
|
def transform_relay_to_vendor(payload: dict[str, Any]) -> str:
|
||||||
"""Transform abstract relay payload to zigbee2mqtt format.
|
"""Transform abstract relay payload to zigbee2mqtt format.
|
||||||
|
|
||||||
@@ -222,8 +204,6 @@ HANDLERS = {
|
|||||||
("temp_humidity_sensor", "to_abstract"): transform_temp_humidity_sensor_to_abstract,
|
("temp_humidity_sensor", "to_abstract"): transform_temp_humidity_sensor_to_abstract,
|
||||||
("temp_humidity", "to_vendor"): transform_temp_humidity_sensor_to_vendor,
|
("temp_humidity", "to_vendor"): transform_temp_humidity_sensor_to_vendor,
|
||||||
("temp_humidity", "to_abstract"): transform_temp_humidity_sensor_to_abstract,
|
("temp_humidity", "to_abstract"): transform_temp_humidity_sensor_to_abstract,
|
||||||
("switch", "to_vendor"): transform_switch_to_vendor,
|
|
||||||
("switch", "to_abstract"): transform_switch_to_abstract,
|
|
||||||
("relay", "to_vendor"): transform_relay_to_vendor,
|
("relay", "to_vendor"): transform_relay_to_vendor,
|
||||||
("relay", "to_abstract"): transform_relay_to_abstract,
|
("relay", "to_abstract"): transform_relay_to_abstract,
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -18,6 +18,19 @@ class WindowSetbackObjects(BaseModel):
|
|||||||
thermostats: list[str] = Field(..., min_length=1, description="Thermostats to control")
|
thermostats: list[str] = Field(..., min_length=1, description="Thermostats to control")
|
||||||
|
|
||||||
|
|
||||||
|
def __get_redis_key_current_target(rule_id: str, thermo_id: str) -> str:
|
||||||
|
"""Get Redis key for current target temperature of a thermostat"""
|
||||||
|
return f"rule:{rule_id}:thermo:{thermo_id}:current_target"
|
||||||
|
def __get_redis_key_previous_target(rule_id: str, thermo_id: str) -> str:
|
||||||
|
"""Get Redis key for previous target temperature of a thermostat"""
|
||||||
|
return f"rule:{rule_id}:thermo:{thermo_id}:previous"
|
||||||
|
def __get_redis_key_contact_state(rule_id: str, contact_id: str) -> str:
|
||||||
|
"""Get Redis key for contact sensor state"""
|
||||||
|
return f"rule:{rule_id}:contact:{contact_id}:is_open"
|
||||||
|
def __get_redis_key_rule_state(rule_id: str) -> str:
|
||||||
|
"""Get Redis key for overall rule state"""
|
||||||
|
return f"rule:{rule_id}:state"
|
||||||
|
|
||||||
class WindowSetbackRule(Rule):
|
class WindowSetbackRule(Rule):
|
||||||
"""
|
"""
|
||||||
Window setback automation rule.
|
Window setback automation rule.
|
||||||
@@ -31,15 +44,13 @@ class WindowSetbackRule(Rule):
|
|||||||
thermostats: List of thermostat device IDs to control (required, min 1)
|
thermostats: List of thermostat device IDs to control (required, min 1)
|
||||||
params:
|
params:
|
||||||
eco_target: Temperature to set when window opens (default: 16.0)
|
eco_target: Temperature to set when window opens (default: 16.0)
|
||||||
open_min_secs: Minimum seconds window must be open before triggering (default: 20)
|
|
||||||
close_min_secs: Minimum seconds window must be closed before restoring (default: 20)
|
|
||||||
previous_target_ttl_secs: How long to remember previous temperature (default: 86400)
|
previous_target_ttl_secs: How long to remember previous temperature (default: 86400)
|
||||||
|
|
||||||
State storage (Redis keys):
|
State storage (Redis keys):
|
||||||
rule:{rule_id}:contact:{device_id}:state -> "open" | "closed"
|
|
||||||
rule:{rule_id}:contact:{device_id}:ts -> ISO timestamp of last change
|
|
||||||
rule:{rule_id}:thermo:{device_id}:current_target -> Current target temp (updated on every STATE)
|
rule:{rule_id}:thermo:{device_id}:current_target -> Current target temp (updated on every STATE)
|
||||||
rule:{rule_id}:thermo:{device_id}:previous -> Previous target temp (saved on window open, deleted on restore)
|
rule:{rule_id}:thermo:{device_id}:previous -> Previous target temp (saved on window open, deleted on restore)
|
||||||
|
rule:{rule_id}:contact:{device_id}:is_open -> "1" if open, "0" if closed
|
||||||
|
rule:{rule_id}:state -> Overall rule state -> "1" if thermostats set to eco, "0" otherwise
|
||||||
|
|
||||||
Logic:
|
Logic:
|
||||||
1. Thermostat STATE events → update current_target in Redis
|
1. Thermostat STATE events → update current_target in Redis
|
||||||
@@ -130,17 +141,29 @@ class WindowSetbackRule(Rule):
|
|||||||
ctx.logger.warning(f"Contact event missing 'contact' field: {evt}")
|
ctx.logger.warning(f"Contact event missing 'contact' field: {evt}")
|
||||||
return
|
return
|
||||||
|
|
||||||
# Store current state and timestamp
|
contact_state_key = __get_redis_key_contact_state(desc.id, device_id)
|
||||||
state_key = f"rule:{desc.id}:contact:{device_id}:state"
|
await ctx.redis.set(contact_state_key, '1' if contact_state == 'open' else '0')
|
||||||
ts_key = f"rule:{desc.id}:contact:{device_id}:ts"
|
|
||||||
|
|
||||||
await ctx.redis.set(state_key, contact_state)
|
# Check if any contact is open
|
||||||
await ctx.redis.set(ts_key, event_ts)
|
is_open = False
|
||||||
|
for contact_id in desc.objects.get('contacts', []):
|
||||||
|
state_key = __get_redis_key_contact_state(desc.id, contact_id)
|
||||||
|
state_val = await ctx.redis.get(state_key)
|
||||||
|
if state_val == '1':
|
||||||
|
is_open = True
|
||||||
|
break
|
||||||
|
|
||||||
|
rule_state_key = __get_redis_key_rule_state(desc.id)
|
||||||
|
current_rule_state = await ctx.redis.get(rule_state_key)
|
||||||
|
if is_open and current_rule_state != '1':
|
||||||
|
# At least one contact is open, and we are not already in eco mode
|
||||||
|
await self._set_eco_mode(desc, ctx)
|
||||||
|
await ctx.redis.set(rule_state_key, '1')
|
||||||
|
elif not is_open and current_rule_state != '0':
|
||||||
|
# All contacts are closed, and we are currently in eco mode
|
||||||
|
await self._unset_eco_mode(desc, ctx)
|
||||||
|
await ctx.redis.set(rule_state_key, '0')
|
||||||
|
|
||||||
if contact_state == 'open':
|
|
||||||
await self._on_window_opened(desc, ctx)
|
|
||||||
elif contact_state == 'closed':
|
|
||||||
await self._on_window_closed(desc, ctx)
|
|
||||||
|
|
||||||
async def _on_window_opened(self, desc: RuleDescriptor, ctx: RuleContext) -> None:
|
async def _on_window_opened(self, desc: RuleDescriptor, ctx: RuleContext) -> None:
|
||||||
"""
|
"""
|
||||||
@@ -160,12 +183,12 @@ class WindowSetbackRule(Rule):
|
|||||||
|
|
||||||
# FIRST: Save current target temperatures as "previous" (before we change them!)
|
# FIRST: Save current target temperatures as "previous" (before we change them!)
|
||||||
for thermo_id in target_thermostats:
|
for thermo_id in target_thermostats:
|
||||||
current_key = f"rule:{desc.id}:thermo:{thermo_id}:current_target"
|
current_key = __get_redis_key_current_target(desc.id, thermo_id)
|
||||||
current_temp_str = await ctx.redis.get(current_key)
|
current_temp_str = await ctx.redis.get(current_key)
|
||||||
|
|
||||||
if current_temp_str:
|
if current_temp_str:
|
||||||
# Save current as previous (with TTL)
|
# Save current as previous (with TTL)
|
||||||
prev_key = f"rule:{desc.id}:thermo:{thermo_id}:previous"
|
prev_key = __get_redis_key_previous_target(desc.id, thermo_id)
|
||||||
await ctx.redis.set(prev_key, current_temp_str, ttl_secs=ttl_secs)
|
await ctx.redis.set(prev_key, current_temp_str, ttl_secs=ttl_secs)
|
||||||
ctx.logger.debug(
|
ctx.logger.debug(
|
||||||
f"Saved previous target for {thermo_id}: {current_temp_str}°C"
|
f"Saved previous target for {thermo_id}: {current_temp_str}°C"
|
||||||
@@ -199,7 +222,7 @@ class WindowSetbackRule(Rule):
|
|||||||
|
|
||||||
# Restore previous temperatures
|
# Restore previous temperatures
|
||||||
for thermo_id in target_thermostats:
|
for thermo_id in target_thermostats:
|
||||||
prev_key = f"rule:{desc.id}:thermo:{thermo_id}:previous"
|
prev_key = __get_redis_key_previous_target(desc.id, thermo_id)
|
||||||
prev_temp_str = await ctx.redis.get(prev_key)
|
prev_temp_str = await ctx.redis.get(prev_key)
|
||||||
|
|
||||||
if prev_temp_str:
|
if prev_temp_str:
|
||||||
@@ -240,7 +263,7 @@ class WindowSetbackRule(Rule):
|
|||||||
return # No target in this state update
|
return # No target in this state update
|
||||||
|
|
||||||
# Store current target (always update, even if it's the eco temperature)
|
# Store current target (always update, even if it's the eco temperature)
|
||||||
current_key = f"rule:{desc.id}:thermo:{device_id}:current_target"
|
current_key = __get_redis_key_current_target(desc.id, device_id)
|
||||||
ttl_secs = desc.params.get('previous_target_ttl_secs', 86400)
|
ttl_secs = desc.params.get('previous_target_ttl_secs', 86400)
|
||||||
|
|
||||||
await ctx.redis.set(current_key, str(current_target), ttl_secs=ttl_secs)
|
await ctx.redis.set(current_key, str(current_target), ttl_secs=ttl_secs)
|
||||||
|
|||||||
@@ -1152,3 +1152,38 @@ devices:
|
|||||||
topics:
|
topics:
|
||||||
state: "zigbee2mqtt/0x842e14fffefe4ba4"
|
state: "zigbee2mqtt/0x842e14fffefe4ba4"
|
||||||
set: "zigbee2mqtt/0x842e14fffefe4ba4/set"
|
set: "zigbee2mqtt/0x842e14fffefe4ba4/set"
|
||||||
|
|
||||||
|
- device_id: kontakt_test_1
|
||||||
|
homekit_aid: 97
|
||||||
|
name: Kontakt Test 1
|
||||||
|
type: contact
|
||||||
|
cap_version: contact_sensor@1.0.0
|
||||||
|
technology: test
|
||||||
|
topics:
|
||||||
|
state: test/kontakt1/state
|
||||||
|
features: {}
|
||||||
|
- device_id: kontakt_test_2
|
||||||
|
homekit_aid: 98
|
||||||
|
name: Kontakt Test 2
|
||||||
|
type: contact
|
||||||
|
cap_version: contact_sensor@1.0.0
|
||||||
|
technology: test
|
||||||
|
topics:
|
||||||
|
state: test/kontakt2/state
|
||||||
|
features: {}
|
||||||
|
- device_id: thermostat_test
|
||||||
|
homekit_aid: 99
|
||||||
|
name: Thermostat Test
|
||||||
|
type: thermostat
|
||||||
|
cap_version: "thermostat@1.0.0"
|
||||||
|
technology: test
|
||||||
|
features:
|
||||||
|
heating: true
|
||||||
|
temperature_range:
|
||||||
|
- 5
|
||||||
|
- 30
|
||||||
|
temperature_step: 0.5
|
||||||
|
topics:
|
||||||
|
state: "test/thermostat1/state"
|
||||||
|
set: "test/thermostat1/set"
|
||||||
|
|
||||||
@@ -115,3 +115,17 @@ rules:
|
|||||||
eco_target: 5.0
|
eco_target: 5.0
|
||||||
open_min_secs: 20
|
open_min_secs: 20
|
||||||
close_min_secs: 20
|
close_min_secs: 20
|
||||||
|
- id: window_setback_test
|
||||||
|
enabled: true
|
||||||
|
name: Fensterabsenkung Test
|
||||||
|
type: window_setback@1.0
|
||||||
|
objects:
|
||||||
|
contacts:
|
||||||
|
- kontakt_test_1
|
||||||
|
- kontakt_test_2
|
||||||
|
thermostats:
|
||||||
|
- thermostat_test
|
||||||
|
params:
|
||||||
|
eco_target: 7.0
|
||||||
|
open_min_secs: 20
|
||||||
|
close_min_secs: 20
|
||||||
|
|||||||
@@ -8,8 +8,6 @@ from packages.home_capabilities.contact_sensor import CAP_VERSION as CONTACT_SEN
|
|||||||
from packages.home_capabilities.contact_sensor import ContactState
|
from packages.home_capabilities.contact_sensor import ContactState
|
||||||
from packages.home_capabilities.temp_humidity_sensor import CAP_VERSION as TEMP_HUMIDITY_SENSOR_VERSION
|
from packages.home_capabilities.temp_humidity_sensor import CAP_VERSION as TEMP_HUMIDITY_SENSOR_VERSION
|
||||||
from packages.home_capabilities.temp_humidity_sensor import TempHumidityState
|
from packages.home_capabilities.temp_humidity_sensor import TempHumidityState
|
||||||
from packages.home_capabilities.switch import CAP_VERSION as SWITCH_VERSION
|
|
||||||
from packages.home_capabilities.switch import SwitchState
|
|
||||||
from packages.home_capabilities.relay import CAP_VERSION as RELAY_VERSION
|
from packages.home_capabilities.relay import CAP_VERSION as RELAY_VERSION
|
||||||
from packages.home_capabilities.relay import RelayState
|
from packages.home_capabilities.relay import RelayState
|
||||||
from packages.home_capabilities.three_phase_powermeter import CAP_VERSION as THREE_PHASE_POWERMETER_VERSION
|
from packages.home_capabilities.three_phase_powermeter import CAP_VERSION as THREE_PHASE_POWERMETER_VERSION
|
||||||
@@ -44,8 +42,6 @@ __all__ = [
|
|||||||
"CONTACT_SENSOR_VERSION",
|
"CONTACT_SENSOR_VERSION",
|
||||||
"TempHumidityState",
|
"TempHumidityState",
|
||||||
"TEMP_HUMIDITY_SENSOR_VERSION",
|
"TEMP_HUMIDITY_SENSOR_VERSION",
|
||||||
"SwitchState",
|
|
||||||
"SWITCH_VERSION",
|
|
||||||
"RelayState",
|
"RelayState",
|
||||||
"RELAY_VERSION",
|
"RELAY_VERSION",
|
||||||
"DeviceTile",
|
"DeviceTile",
|
||||||
|
|||||||
@@ -1,69 +0,0 @@
|
|||||||
"""Switch Capability - Wireless Button/Switch (read-only).
|
|
||||||
|
|
||||||
This module defines the SwitchState model for wireless switches/buttons.
|
|
||||||
These devices report action events (e.g., button presses) and are read-only devices.
|
|
||||||
|
|
||||||
Capability Version: switch@1.0.0
|
|
||||||
"""
|
|
||||||
|
|
||||||
from datetime import datetime
|
|
||||||
from typing import Annotated
|
|
||||||
|
|
||||||
from pydantic import BaseModel, Field
|
|
||||||
|
|
||||||
|
|
||||||
# Capability metadata
|
|
||||||
CAP_VERSION = "switch@1.0.0"
|
|
||||||
DISPLAY_NAME = "Switch"
|
|
||||||
|
|
||||||
|
|
||||||
class SwitchState(BaseModel):
|
|
||||||
"""State model for wireless switches/buttons.
|
|
||||||
|
|
||||||
Wireless switches are read-only devices that report button actions such as
|
|
||||||
single press, double press, long press, etc. They typically also report
|
|
||||||
battery level and signal quality.
|
|
||||||
|
|
||||||
Attributes:
|
|
||||||
action: Action type (e.g., "single", "double", "long", "hold", etc.)
|
|
||||||
battery: Battery level percentage (0-100), optional
|
|
||||||
linkquality: MQTT link quality indicator, optional
|
|
||||||
voltage: Battery voltage in mV, optional
|
|
||||||
ts: Timestamp of the action event, optional
|
|
||||||
|
|
||||||
Examples:
|
|
||||||
>>> SwitchState(action="single")
|
|
||||||
SwitchState(action='single', battery=None, ...)
|
|
||||||
|
|
||||||
>>> SwitchState(action="double", battery=95, linkquality=87)
|
|
||||||
SwitchState(action='double', battery=95, linkquality=87, ...)
|
|
||||||
"""
|
|
||||||
|
|
||||||
action: str = Field(
|
|
||||||
...,
|
|
||||||
description="Action type: 'single', 'double', 'long', 'hold', etc."
|
|
||||||
)
|
|
||||||
|
|
||||||
battery: Annotated[int, Field(ge=0, le=100)] | None = Field(
|
|
||||||
None,
|
|
||||||
description="Battery level in percent (0-100)"
|
|
||||||
)
|
|
||||||
|
|
||||||
linkquality: int | None = Field(
|
|
||||||
None,
|
|
||||||
description="Link quality indicator (typically 0-255)"
|
|
||||||
)
|
|
||||||
|
|
||||||
voltage: int | None = Field(
|
|
||||||
None,
|
|
||||||
description="Battery voltage in millivolts"
|
|
||||||
)
|
|
||||||
|
|
||||||
ts: datetime | None = Field(
|
|
||||||
None,
|
|
||||||
description="Timestamp of the action event"
|
|
||||||
)
|
|
||||||
|
|
||||||
|
|
||||||
# Public API
|
|
||||||
__all__ = ["SwitchState", "CAP_VERSION", "DISPLAY_NAME"]
|
|
||||||
Reference in New Issue
Block a user