smart_plug.py 12 KB

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