smart_plug.py 11 KB

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