Pouzor
b99450db2f
Mirror the Proxmox auto-sync pattern for the Zigbee2MQTT and Z-Wave JS UI mesh imports. Connection config + MQTT credentials live in .env only, are never persisted to scan_config.json, and are never returned by any API or shown in the UI (single source of truth). - config: ZIGBEE_* / ZWAVE_* env settings; only sync_enabled+interval are persisted, connection/credentials stay env-only - routes: GET/POST /config, POST /sync-now; auto-sync reuses the exact manual _background_*_import + _persist_pending_import path (fresh import when empty, update-in-place when nodes exist, ScanRun trace) - scheduler: zigbee_sync / zwave_sync jobs with live enable + reschedule - frontend: reusable MeshAutoSync section in Settings (Zigbee, Z-Wave) - .env.example: documented both blocks - tests: scheduler jobs, router config/sync-now/auth, credential-never- persisted, SettingsModal sections Manual Zigbee/Z-Wave import behaviour is unchanged. ha-relevant: no
113 lines
3.6 KiB
Python
113 lines
3.6 KiB
Python
"""Pydantic v2 schemas for Z-Wave JS UI (zwavejs2mqtt) import."""
|
|
|
|
from pydantic import BaseModel, Field, model_validator
|
|
|
|
|
|
class ZwaveImportRequest(BaseModel):
|
|
mqtt_host: str = Field(..., description="MQTT broker hostname or IP address")
|
|
mqtt_port: int = Field(1883, ge=1, le=65535, description="MQTT broker port")
|
|
mqtt_username: str | None = Field(None, description="MQTT username (optional)")
|
|
mqtt_password: str | None = Field(None, description="MQTT password (optional)")
|
|
prefix: str = Field("zwave", description="Z-Wave JS UI MQTT prefix")
|
|
gateway_name: str = Field("zwavejs2mqtt", description="Z-Wave JS UI gateway name")
|
|
mqtt_tls: bool = Field(False, description="Enable TLS (typically port 8883)")
|
|
mqtt_tls_insecure: bool = Field(
|
|
False, description="Skip TLS certificate verification (self-signed only)"
|
|
)
|
|
|
|
@model_validator(mode="after")
|
|
def _insecure_requires_tls(self) -> "ZwaveImportRequest":
|
|
if self.mqtt_tls_insecure and not self.mqtt_tls:
|
|
raise ValueError("mqtt_tls_insecure requires mqtt_tls=true")
|
|
return self
|
|
|
|
|
|
class ZwaveTestConnectionRequest(BaseModel):
|
|
mqtt_host: str
|
|
mqtt_port: int = Field(1883, ge=1, le=65535)
|
|
mqtt_username: str | None = None
|
|
mqtt_password: str | None = None
|
|
mqtt_tls: bool = False
|
|
mqtt_tls_insecure: bool = False
|
|
|
|
@model_validator(mode="after")
|
|
def _insecure_requires_tls(self) -> "ZwaveTestConnectionRequest":
|
|
if self.mqtt_tls_insecure and not self.mqtt_tls:
|
|
raise ValueError("mqtt_tls_insecure requires mqtt_tls=true")
|
|
return self
|
|
|
|
|
|
class ZwaveNodeOut(BaseModel):
|
|
"""A homelable-ready node representation of a Z-Wave device."""
|
|
|
|
id: str
|
|
label: str
|
|
type: str # zwave_coordinator | zwave_router | zwave_enddevice
|
|
ieee_address: str
|
|
friendly_name: str
|
|
device_type: str
|
|
model: str | None = None
|
|
vendor: str | None = None
|
|
lqi: int | None = None
|
|
parent_id: str | None = None
|
|
|
|
|
|
class ZwaveEdgeOut(BaseModel):
|
|
source: str
|
|
target: str
|
|
|
|
|
|
class ZwaveImportResponse(BaseModel):
|
|
nodes: list[ZwaveNodeOut]
|
|
edges: list[ZwaveEdgeOut]
|
|
device_count: int
|
|
|
|
|
|
class ZwaveTestConnectionResponse(BaseModel):
|
|
connected: bool
|
|
message: str
|
|
|
|
|
|
class ZwaveCoordinatorOut(BaseModel):
|
|
id: str
|
|
label: str
|
|
ieee_address: str
|
|
|
|
|
|
class ZwaveImportPendingResponse(BaseModel):
|
|
"""Result of importing a Z-Wave network into the pending section."""
|
|
|
|
pending_created: int
|
|
pending_updated: int
|
|
coordinator: ZwaveCoordinatorOut | None = None
|
|
coordinator_already_existed: bool = False
|
|
links_recorded: int
|
|
device_count: int
|
|
|
|
|
|
class ZwaveConfig(BaseModel):
|
|
"""Non-secret Z-Wave connection + auto-sync config (GET response).
|
|
|
|
MQTT connection fields (host/port/prefix/gateway_name/tls) are env-only and
|
|
read-only here — surfaced for display. ``host_configured`` reflects whether
|
|
a server-side MQTT host is set (required for auto-sync). MQTT credentials
|
|
(username/password) are never carried."""
|
|
|
|
mqtt_host: str = ""
|
|
mqtt_port: int = Field(1883, ge=1, le=65535)
|
|
prefix: str = "zwave"
|
|
gateway_name: str = "zwavejs2mqtt"
|
|
mqtt_tls: bool = False
|
|
sync_enabled: bool = False
|
|
sync_interval: int = Field(3600, ge=300)
|
|
host_configured: bool = False
|
|
|
|
|
|
class ZwaveSyncConfig(BaseModel):
|
|
"""User-editable auto-sync config (POST body). The ONLY persisted Z-Wave
|
|
settings. Connection fields (host/port/credentials/prefix/gateway/tls) are
|
|
env-only and are deliberately not accepted here."""
|
|
|
|
sync_enabled: bool = False
|
|
sync_interval: int = Field(3600, ge=300)
|