smart_plug.py 13 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298
  1. from datetime import datetime
  2. from typing import Literal
  3. from pydantic import BaseModel, Field, field_validator, model_validator
  4. from backend.app.schemas.not_null import IgnoresNullForRequiredColumns
  5. from backend.app.services.secret_fields import SECRET_PLACEHOLDER
  6. class SmartPlugBase(BaseModel):
  7. name: str = Field(..., min_length=1, max_length=100)
  8. plug_type: Literal["tasmota", "homeassistant", "mqtt", "rest"] = "tasmota"
  9. # Tasmota fields (required when plug_type="tasmota")
  10. ip_address: str | None = Field(default=None, pattern=r"^\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}$")
  11. username: str | None = None
  12. password: str | None = None
  13. # Home Assistant fields (required when plug_type="homeassistant")
  14. ha_entity_id: str | None = Field(default=None, pattern=r"^(switch|light|input_boolean|script)\.[a-z0-9_]+$")
  15. # Home Assistant energy sensor entities (optional, for separate energy sensors)
  16. ha_power_entity: str | None = Field(default=None, pattern=r"^sensor\.[a-z0-9_]+$")
  17. ha_energy_today_entity: str | None = Field(default=None, pattern=r"^sensor\.[a-z0-9_]+$")
  18. ha_energy_total_entity: str | None = Field(default=None, pattern=r"^sensor\.[a-z0-9_]+$")
  19. # MQTT fields (required when plug_type="mqtt")
  20. # Legacy field - kept for backward compatibility
  21. mqtt_topic: str | None = Field(default=None, max_length=200) # Deprecated, use mqtt_power_topic
  22. # Power monitoring
  23. mqtt_power_topic: str | None = Field(default=None, max_length=200) # Topic for power data
  24. mqtt_power_path: str | None = Field(default=None, max_length=100) # e.g., "power_l1" or "data.power"
  25. mqtt_power_multiplier: float = Field(default=1.0, gt=0, le=10000) # Unit conversion for power
  26. # Energy monitoring
  27. mqtt_energy_topic: str | None = Field(default=None, max_length=200) # Topic for energy data
  28. mqtt_energy_path: str | None = Field(default=None, max_length=100) # e.g., "energy_l1"
  29. mqtt_energy_multiplier: float = Field(default=1.0, gt=0, le=10000) # Unit conversion for energy
  30. # State monitoring
  31. mqtt_state_topic: str | None = Field(default=None, max_length=200) # Topic for state data
  32. mqtt_state_path: str | None = Field(default=None, max_length=100) # e.g., "state_l1" for ON/OFF
  33. mqtt_state_on_value: str | None = Field(
  34. default=None, max_length=50
  35. ) # What value means "ON" (e.g., "ON", "true", "1")
  36. # Legacy multiplier - kept for backward compatibility
  37. mqtt_multiplier: float = Field(default=1.0, gt=0, le=10000) # Deprecated, use mqtt_power_multiplier
  38. # REST/Webhook fields (required when plug_type="rest")
  39. rest_on_url: str | None = Field(default=None, max_length=500)
  40. rest_on_body: str | None = None
  41. rest_off_url: str | None = Field(default=None, max_length=500)
  42. rest_off_body: str | None = None
  43. rest_method: Literal["GET", "POST", "PUT", "PATCH"] | None = None
  44. rest_headers: str | None = None # JSON string of custom headers
  45. rest_status_url: str | None = Field(default=None, max_length=500)
  46. rest_status_path: str | None = Field(default=None, max_length=200)
  47. rest_status_on_value: str | None = Field(default=None, max_length=50)
  48. rest_power_url: str | None = Field(default=None, max_length=500)
  49. rest_power_path: str | None = Field(default=None, max_length=200)
  50. rest_power_multiplier: float = Field(default=1.0, gt=0, le=10000)
  51. rest_energy_url: str | None = Field(default=None, max_length=500)
  52. # Today's usage, resetting at midnight.
  53. rest_energy_path: str | None = Field(default=None, max_length=200)
  54. rest_energy_multiplier: float = Field(default=1.0, gt=0, le=10000)
  55. # Lifetime counter that never resets (#2539) — a Shelly's `aenergy.total`.
  56. rest_energy_total_path: str | None = Field(default=None, max_length=200)
  57. rest_energy_total_multiplier: float = Field(default=1.0, gt=0, le=10000)
  58. printer_id: int | None = None
  59. # #2629: only a plug that really feeds the printer may mark it offline when
  60. # it switches off. Accessory plugs (filter fan, lights) are linked to a
  61. # printer purely to follow the print cycle.
  62. controls_printer_power: bool = True
  63. enabled: bool = True
  64. auto_on: bool = True
  65. auto_off: bool = True
  66. auto_off_persistent: bool = False
  67. off_delay_mode: Literal["time", "temperature"] = "time"
  68. off_delay_minutes: int = Field(default=5, ge=0, le=60)
  69. off_temp_threshold: int = Field(default=70, ge=30, le=150)
  70. # #1349: auto-off after AMS drying completes. Independent of `auto_off`
  71. # (print-finish). Fires whenever any AMS on the linked printer finishes
  72. # a dry cycle.
  73. auto_off_after_drying: bool = False
  74. off_delay_after_drying_minutes: int = Field(default=10, ge=0, le=120)
  75. # Power alerts
  76. power_alert_enabled: bool = False
  77. power_alert_high: float | None = Field(default=None, ge=0, le=5000) # Alert when power > this (watts)
  78. power_alert_low: float | None = Field(default=None, ge=0, le=5000) # Alert when power < this (watts)
  79. # Schedule
  80. schedule_enabled: bool = False
  81. schedule_on_time: str | None = Field(default=None, pattern=r"^([01]\d|2[0-3]):[0-5]\d$") # HH:MM format
  82. schedule_off_time: str | None = Field(default=None, pattern=r"^([01]\d|2[0-3]):[0-5]\d$") # HH:MM format
  83. # Visibility options
  84. show_in_switchbar: bool = False
  85. show_on_printer_card: bool = True # For scripts: show on printer card
  86. @model_validator(mode="after")
  87. def validate_plug_type_fields(self) -> "SmartPlugBase":
  88. if self.plug_type == "tasmota" and not self.ip_address:
  89. raise ValueError("ip_address is required for Tasmota plugs")
  90. if self.plug_type == "homeassistant" and not self.ha_entity_id:
  91. raise ValueError("ha_entity_id is required for Home Assistant plugs")
  92. if self.plug_type == "mqtt":
  93. # Determine the effective power topic (new field takes priority, fall back to legacy)
  94. power_topic = self.mqtt_power_topic or self.mqtt_topic
  95. # Path is optional - if not set, raw MQTT payload value will be used
  96. has_power = bool(power_topic)
  97. has_energy = bool(self.mqtt_energy_topic)
  98. has_state = bool(self.mqtt_state_topic)
  99. # At least one data source must be configured (path is optional)
  100. if not has_power and not has_energy and not has_state:
  101. raise ValueError("At least one MQTT topic must be configured for power, energy, or state monitoring")
  102. if self.plug_type == "rest":
  103. if not self.rest_on_url and not self.rest_off_url:
  104. raise ValueError("At least one of ON URL or OFF URL is required for REST plugs")
  105. return self
  106. class SmartPlugCreate(SmartPlugBase):
  107. pass
  108. class SmartPlugUpdate(IgnoresNullForRequiredColumns):
  109. __orm_table__ = "smart_plugs"
  110. name: str | None = None
  111. plug_type: Literal["tasmota", "homeassistant", "mqtt", "rest"] | None = None
  112. ip_address: str | None = None
  113. ha_entity_id: str | None = None
  114. # Home Assistant energy sensor entities (optional)
  115. ha_power_entity: str | None = None
  116. ha_energy_today_entity: str | None = None
  117. ha_energy_total_entity: str | None = None
  118. # MQTT fields (legacy)
  119. mqtt_topic: str | None = None
  120. mqtt_multiplier: float | None = Field(default=None, gt=0, le=10000)
  121. # MQTT power fields
  122. mqtt_power_topic: str | None = None
  123. mqtt_power_path: str | None = None
  124. mqtt_power_multiplier: float | None = Field(default=None, gt=0, le=10000)
  125. # MQTT energy fields
  126. mqtt_energy_topic: str | None = None
  127. mqtt_energy_path: str | None = None
  128. mqtt_energy_multiplier: float | None = Field(default=None, gt=0, le=10000)
  129. # MQTT state fields
  130. mqtt_state_topic: str | None = None
  131. mqtt_state_path: str | None = None
  132. mqtt_state_on_value: str | None = None
  133. # REST fields
  134. rest_on_url: str | None = None
  135. rest_on_body: str | None = None
  136. rest_off_url: str | None = None
  137. rest_off_body: str | None = None
  138. rest_method: Literal["GET", "POST", "PUT", "PATCH"] | None = None
  139. rest_headers: str | None = None
  140. rest_status_url: str | None = None
  141. rest_status_path: str | None = None
  142. rest_status_on_value: str | None = None
  143. rest_power_url: str | None = None
  144. rest_power_path: str | None = None
  145. rest_power_multiplier: float | None = Field(default=None, gt=0, le=10000)
  146. rest_energy_url: str | None = None
  147. rest_energy_path: str | None = None
  148. rest_energy_multiplier: float | None = Field(default=None, gt=0, le=10000)
  149. rest_energy_total_path: str | None = None
  150. rest_energy_total_multiplier: float | None = Field(default=None, gt=0, le=10000)
  151. printer_id: int | None = None
  152. # #2629: see SmartPlugBase.controls_printer_power.
  153. controls_printer_power: bool | None = None
  154. enabled: bool | None = None
  155. auto_on: bool | None = None
  156. auto_off: bool | None = None
  157. auto_off_persistent: bool | None = None
  158. off_delay_mode: Literal["time", "temperature"] | None = None
  159. off_delay_minutes: int | None = Field(default=None, ge=0, le=60)
  160. off_temp_threshold: int | None = Field(default=None, ge=30, le=150)
  161. # #1349: per-plug drying auto-off.
  162. auto_off_after_drying: bool | None = None
  163. off_delay_after_drying_minutes: int | None = Field(default=None, ge=0, le=120)
  164. username: str | None = None
  165. password: str | None = None
  166. # Power alerts
  167. power_alert_enabled: bool | None = None
  168. power_alert_high: float | None = Field(default=None, ge=0, le=5000)
  169. power_alert_low: float | None = Field(default=None, ge=0, le=5000)
  170. # Schedule
  171. schedule_enabled: bool | None = None
  172. schedule_on_time: str | None = Field(default=None, pattern=r"^([01]\d|2[0-3]):[0-5]\d$")
  173. schedule_off_time: str | None = Field(default=None, pattern=r"^([01]\d|2[0-3]):[0-5]\d$")
  174. # Visibility options
  175. show_in_switchbar: bool | None = None
  176. show_on_printer_card: bool | None = None
  177. class SmartPlugResponse(SmartPlugBase):
  178. id: int
  179. last_state: str | None = None
  180. last_checked: datetime | None = None
  181. auto_off_executed: bool = False # True when auto-off was triggered after print
  182. power_alert_last_triggered: datetime | None = None
  183. created_at: datetime
  184. updated_at: datetime
  185. class Config:
  186. from_attributes = True
  187. @field_validator("password", "rest_headers", mode="after")
  188. @classmethod
  189. def _write_only(cls, value: str | None) -> str | None:
  190. """Secrets are write-only: a set one is shown as the placeholder."""
  191. return SECRET_PLACEHOLDER if value else value
  192. class SmartPlugControl(BaseModel):
  193. action: Literal["on", "off", "toggle"]
  194. class SmartPlugEnergy(BaseModel):
  195. """Energy monitoring data from a smart plug."""
  196. power: float | None = None # Current watts
  197. voltage: float | None = None # Volts
  198. current: float | None = None # Amps
  199. today: float | None = None # kWh used today
  200. yesterday: float | None = None # kWh used yesterday
  201. total: float | None = None # Total kWh
  202. factor: float | None = None # Power factor (0-1)
  203. apparent_power: float | None = None # VA
  204. reactive_power: float | None = None # VAr
  205. class SmartPlugStatus(BaseModel):
  206. state: str | None = None # "ON", "OFF", or None if unreachable
  207. reachable: bool = True
  208. device_name: str | None = None
  209. energy: SmartPlugEnergy | None = None # Energy data if available
  210. class SmartPlugTestConnection(BaseModel):
  211. ip_address: str = Field(..., pattern=r"^\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}$")
  212. username: str | None = None
  213. password: str | None = None
  214. # The saved plug being edited: its stored password fills in the placeholder.
  215. plug_id: int | None = None
  216. # Home Assistant schemas
  217. class HATestConnectionRequest(BaseModel):
  218. """Request to test Home Assistant connection."""
  219. url: str = Field(..., min_length=1)
  220. token: str = Field(..., min_length=1)
  221. class HATestConnectionResponse(BaseModel):
  222. """Response from HA connection test."""
  223. success: bool
  224. message: str | None = None
  225. error: str | None = None
  226. class HAEntity(BaseModel):
  227. """A Home Assistant entity that can be used as a smart plug."""
  228. entity_id: str
  229. friendly_name: str
  230. state: str | None = None
  231. domain: str # "switch", "light", "input_boolean", "script"
  232. class HASensorEntity(BaseModel):
  233. """A Home Assistant sensor entity for energy monitoring."""
  234. entity_id: str
  235. friendly_name: str
  236. state: str | None = None
  237. unit_of_measurement: str | None = None # "W", "kW", "kWh", "Wh"
  238. class RESTTestConnectionRequest(BaseModel):
  239. """Request to test a REST smart plug connection."""
  240. url: str = Field(..., min_length=1)
  241. method: str = Field(default="GET")
  242. headers: str | None = None # JSON string of custom headers
  243. # The saved plug being edited: its stored headers fill in the placeholder.
  244. plug_id: int | None = None
  245. class RESTTestConnectionResponse(BaseModel):
  246. """Response from REST connection test."""
  247. success: bool
  248. error: str | None = None