smart_plug.py 8.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213
  1. from datetime import datetime
  2. from typing import Literal
  3. from pydantic import BaseModel, Field, model_validator
  4. class SmartPlugBase(BaseModel):
  5. name: str = Field(..., min_length=1, max_length=100)
  6. plug_type: Literal["tasmota", "homeassistant", "mqtt"] = "tasmota"
  7. # Tasmota fields (required when plug_type="tasmota")
  8. ip_address: str | None = Field(default=None, pattern=r"^\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}$")
  9. username: str | None = None
  10. password: str | None = None
  11. # Home Assistant fields (required when plug_type="homeassistant")
  12. ha_entity_id: str | None = Field(default=None, pattern=r"^(switch|light|input_boolean|script)\.[a-z0-9_]+$")
  13. # Home Assistant energy sensor entities (optional, for separate energy sensors)
  14. ha_power_entity: str | None = Field(default=None, pattern=r"^sensor\.[a-z0-9_]+$")
  15. ha_energy_today_entity: str | None = Field(default=None, pattern=r"^sensor\.[a-z0-9_]+$")
  16. ha_energy_total_entity: str | None = Field(default=None, pattern=r"^sensor\.[a-z0-9_]+$")
  17. # MQTT fields (required when plug_type="mqtt")
  18. # Legacy field - kept for backward compatibility
  19. mqtt_topic: str | None = Field(default=None, max_length=200) # Deprecated, use mqtt_power_topic
  20. # Power monitoring
  21. mqtt_power_topic: str | None = Field(default=None, max_length=200) # Topic for power data
  22. mqtt_power_path: str | None = Field(default=None, max_length=100) # e.g., "power_l1" or "data.power"
  23. mqtt_power_multiplier: float = Field(default=1.0, ge=0.0001, le=10000) # Unit conversion for power
  24. # Energy monitoring
  25. mqtt_energy_topic: str | None = Field(default=None, max_length=200) # Topic for energy data
  26. mqtt_energy_path: str | None = Field(default=None, max_length=100) # e.g., "energy_l1"
  27. mqtt_energy_multiplier: float = Field(default=1.0, ge=0.0001, le=10000) # Unit conversion for energy
  28. # State monitoring
  29. mqtt_state_topic: str | None = Field(default=None, max_length=200) # Topic for state data
  30. mqtt_state_path: str | None = Field(default=None, max_length=100) # e.g., "state_l1" for ON/OFF
  31. mqtt_state_on_value: str | None = Field(
  32. default=None, max_length=50
  33. ) # What value means "ON" (e.g., "ON", "true", "1")
  34. # Legacy multiplier - kept for backward compatibility
  35. mqtt_multiplier: float = Field(default=1.0, ge=0.0001, le=10000) # Deprecated, use mqtt_power_multiplier
  36. printer_id: int | None = None
  37. enabled: bool = True
  38. auto_on: bool = True
  39. auto_off: bool = True
  40. auto_off_persistent: bool = False
  41. off_delay_mode: Literal["time", "temperature"] = "time"
  42. off_delay_minutes: int = Field(default=5, ge=0, le=60)
  43. off_temp_threshold: int = Field(default=70, ge=30, le=150)
  44. # Power alerts
  45. power_alert_enabled: bool = False
  46. power_alert_high: float | None = Field(default=None, ge=0, le=5000) # Alert when power > this (watts)
  47. power_alert_low: float | None = Field(default=None, ge=0, le=5000) # Alert when power < this (watts)
  48. # Schedule
  49. schedule_enabled: bool = False
  50. schedule_on_time: str | None = Field(default=None, pattern=r"^([01]\d|2[0-3]):[0-5]\d$") # HH:MM format
  51. schedule_off_time: str | None = Field(default=None, pattern=r"^([01]\d|2[0-3]):[0-5]\d$") # HH:MM format
  52. # Visibility options
  53. show_in_switchbar: bool = False
  54. show_on_printer_card: bool = True # For scripts: show on printer card
  55. @model_validator(mode="after")
  56. def validate_plug_type_fields(self) -> "SmartPlugBase":
  57. if self.plug_type == "tasmota" and not self.ip_address:
  58. raise ValueError("ip_address is required for Tasmota plugs")
  59. if self.plug_type == "homeassistant" and not self.ha_entity_id:
  60. raise ValueError("ha_entity_id is required for Home Assistant plugs")
  61. if self.plug_type == "mqtt":
  62. # Determine the effective power topic (new field takes priority, fall back to legacy)
  63. power_topic = self.mqtt_power_topic or self.mqtt_topic
  64. # Path is optional - if not set, raw MQTT payload value will be used
  65. has_power = bool(power_topic)
  66. has_energy = bool(self.mqtt_energy_topic)
  67. has_state = bool(self.mqtt_state_topic)
  68. # At least one data source must be configured (path is optional)
  69. if not has_power and not has_energy and not has_state:
  70. raise ValueError("At least one MQTT topic must be configured for power, energy, or state monitoring")
  71. return self
  72. class SmartPlugCreate(SmartPlugBase):
  73. pass
  74. class SmartPlugUpdate(BaseModel):
  75. name: str | None = None
  76. plug_type: Literal["tasmota", "homeassistant", "mqtt"] | None = None
  77. ip_address: str | None = None
  78. ha_entity_id: str | None = None
  79. # Home Assistant energy sensor entities (optional)
  80. ha_power_entity: str | None = None
  81. ha_energy_today_entity: str | None = None
  82. ha_energy_total_entity: str | None = None
  83. # MQTT fields (legacy)
  84. mqtt_topic: str | None = None
  85. mqtt_multiplier: float | None = Field(default=None, ge=0.0001, le=10000)
  86. # MQTT power fields
  87. mqtt_power_topic: str | None = None
  88. mqtt_power_path: str | None = None
  89. mqtt_power_multiplier: float | None = Field(default=None, ge=0.0001, le=10000)
  90. # MQTT energy fields
  91. mqtt_energy_topic: str | None = None
  92. mqtt_energy_path: str | None = None
  93. mqtt_energy_multiplier: float | None = Field(default=None, ge=0.0001, le=10000)
  94. # MQTT state fields
  95. mqtt_state_topic: str | None = None
  96. mqtt_state_path: str | None = None
  97. mqtt_state_on_value: str | None = None
  98. printer_id: int | None = None
  99. enabled: bool | None = None
  100. auto_on: bool | None = None
  101. auto_off: bool | None = None
  102. auto_off_persistent: bool | None = None
  103. off_delay_mode: Literal["time", "temperature"] | None = None
  104. off_delay_minutes: int | None = Field(default=None, ge=0, le=60)
  105. off_temp_threshold: int | None = Field(default=None, ge=30, le=150)
  106. username: str | None = None
  107. password: str | None = None
  108. # Power alerts
  109. power_alert_enabled: bool | None = None
  110. power_alert_high: float | None = Field(default=None, ge=0, le=5000)
  111. power_alert_low: float | None = Field(default=None, ge=0, le=5000)
  112. # Schedule
  113. schedule_enabled: bool | None = None
  114. schedule_on_time: str | None = Field(default=None, pattern=r"^([01]\d|2[0-3]):[0-5]\d$")
  115. schedule_off_time: str | None = Field(default=None, pattern=r"^([01]\d|2[0-3]):[0-5]\d$")
  116. # Visibility options
  117. show_in_switchbar: bool | None = None
  118. show_on_printer_card: bool | None = None
  119. class SmartPlugResponse(SmartPlugBase):
  120. id: int
  121. last_state: str | None = None
  122. last_checked: datetime | None = None
  123. auto_off_executed: bool = False # True when auto-off was triggered after print
  124. power_alert_last_triggered: datetime | None = None
  125. created_at: datetime
  126. updated_at: datetime
  127. class Config:
  128. from_attributes = True
  129. class SmartPlugControl(BaseModel):
  130. action: Literal["on", "off", "toggle"]
  131. class SmartPlugEnergy(BaseModel):
  132. """Energy monitoring data from a smart plug."""
  133. power: float | None = None # Current watts
  134. voltage: float | None = None # Volts
  135. current: float | None = None # Amps
  136. today: float | None = None # kWh used today
  137. yesterday: float | None = None # kWh used yesterday
  138. total: float | None = None # Total kWh
  139. factor: float | None = None # Power factor (0-1)
  140. apparent_power: float | None = None # VA
  141. reactive_power: float | None = None # VAr
  142. class SmartPlugStatus(BaseModel):
  143. state: str | None = None # "ON", "OFF", or None if unreachable
  144. reachable: bool = True
  145. device_name: str | None = None
  146. energy: SmartPlugEnergy | None = None # Energy data if available
  147. class SmartPlugTestConnection(BaseModel):
  148. ip_address: str = Field(..., pattern=r"^\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}$")
  149. username: str | None = None
  150. password: str | None = None
  151. # Home Assistant schemas
  152. class HATestConnectionRequest(BaseModel):
  153. """Request to test Home Assistant connection."""
  154. url: str = Field(..., min_length=1)
  155. token: str = Field(..., min_length=1)
  156. class HATestConnectionResponse(BaseModel):
  157. """Response from HA connection test."""
  158. success: bool
  159. message: str | None = None
  160. error: str | None = None
  161. class HAEntity(BaseModel):
  162. """A Home Assistant entity that can be used as a smart plug."""
  163. entity_id: str
  164. friendly_name: str
  165. state: str | None = None
  166. domain: str # "switch", "light", "input_boolean", "script"
  167. class HASensorEntity(BaseModel):
  168. """A Home Assistant sensor entity for energy monitoring."""
  169. entity_id: str
  170. friendly_name: str
  171. state: str | None = None
  172. unit_of_measurement: str | None = None # "W", "kW", "kWh", "Wh"