smart_plug.py 5.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103
  1. from datetime import datetime
  2. from sqlalchemy import Boolean, DateTime, Float, ForeignKey, Integer, String, func
  3. from sqlalchemy.orm import Mapped, mapped_column, relationship
  4. from backend.app.core.database import Base
  5. class SmartPlug(Base):
  6. """Smart plug for printer power control (Tasmota, Home Assistant, or MQTT)."""
  7. __tablename__ = "smart_plugs"
  8. id: Mapped[int] = mapped_column(primary_key=True)
  9. name: Mapped[str] = mapped_column(String(100))
  10. ip_address: Mapped[str | None] = mapped_column(String(45), nullable=True) # IPv4/IPv6 (required for Tasmota)
  11. # Plug type: "tasmota" (default), "homeassistant", or "mqtt"
  12. plug_type: Mapped[str] = mapped_column(String(20), default="tasmota")
  13. # Home Assistant entity ID (e.g., "switch.printer_plug")
  14. ha_entity_id: Mapped[str | None] = mapped_column(String(100), nullable=True)
  15. # Home Assistant energy sensor entities (optional, for separate energy sensors)
  16. ha_power_entity: Mapped[str | None] = mapped_column(String(100), nullable=True) # sensor.xxx_power
  17. ha_energy_today_entity: Mapped[str | None] = mapped_column(String(100), nullable=True) # sensor.xxx_today
  18. ha_energy_total_entity: Mapped[str | None] = mapped_column(String(100), nullable=True) # sensor.xxx_total
  19. # MQTT plug fields (required when plug_type="mqtt")
  20. # Legacy field - kept for backward compatibility, now use mqtt_power_topic
  21. mqtt_topic: Mapped[str | None] = mapped_column(
  22. String(200), nullable=True
  23. ) # e.g., "zigbee2mqtt/shelly-working-room" (deprecated, use mqtt_power_topic)
  24. # Power monitoring
  25. mqtt_power_topic: Mapped[str | None] = mapped_column(String(200), nullable=True) # Topic for power data
  26. mqtt_power_path: Mapped[str | None] = mapped_column(String(100), nullable=True) # e.g., "power_l1" or "data.power"
  27. mqtt_power_multiplier: Mapped[float] = mapped_column(Float, default=1.0) # Unit conversion for power
  28. # Energy monitoring
  29. mqtt_energy_topic: Mapped[str | None] = mapped_column(String(200), nullable=True) # Topic for energy data
  30. mqtt_energy_path: Mapped[str | None] = mapped_column(String(100), nullable=True) # e.g., "energy_l1"
  31. mqtt_energy_multiplier: Mapped[float] = mapped_column(Float, default=1.0) # Unit conversion for energy
  32. # State monitoring
  33. mqtt_state_topic: Mapped[str | None] = mapped_column(String(200), nullable=True) # Topic for state data
  34. mqtt_state_path: Mapped[str | None] = mapped_column(String(100), nullable=True) # e.g., "state_l1" for ON/OFF
  35. mqtt_state_on_value: Mapped[str | None] = mapped_column(
  36. String(50), nullable=True
  37. ) # What value means "ON" (e.g., "ON", "true", "1")
  38. # Legacy multiplier - kept for backward compatibility
  39. mqtt_multiplier: Mapped[float] = mapped_column(Float, default=1.0) # Deprecated, use mqtt_power_multiplier
  40. # Link to printer (1:1)
  41. printer_id: Mapped[int | None] = mapped_column(
  42. ForeignKey("printers.id", ondelete="SET NULL"), unique=True, nullable=True
  43. )
  44. # Automation settings
  45. enabled: Mapped[bool] = mapped_column(Boolean, default=True)
  46. auto_on: Mapped[bool] = mapped_column(Boolean, default=True) # Turn on at print start
  47. auto_off: Mapped[bool] = mapped_column(Boolean, default=True) # Turn off at print complete/fail
  48. # Turn-off delay mode: "time" or "temperature"
  49. off_delay_mode: Mapped[str] = mapped_column(String(20), default="time")
  50. off_delay_minutes: Mapped[int] = mapped_column(Integer, default=5) # For time mode
  51. off_temp_threshold: Mapped[int] = mapped_column(Integer, default=70) # For temp mode (°C)
  52. # Optional auth (some Tasmota configs require it)
  53. username: Mapped[str | None] = mapped_column(String(50), nullable=True)
  54. password: Mapped[str | None] = mapped_column(String(100), nullable=True)
  55. # Power alerts
  56. power_alert_enabled: Mapped[bool] = mapped_column(Boolean, default=False)
  57. power_alert_high: Mapped[float | None] = mapped_column(Float, nullable=True) # Alert when power > this (watts)
  58. power_alert_low: Mapped[float | None] = mapped_column(Float, nullable=True) # Alert when power < this (watts)
  59. power_alert_last_triggered: Mapped[datetime | None] = mapped_column(DateTime, nullable=True) # Cooldown tracking
  60. # Schedule (time-based on/off)
  61. schedule_enabled: Mapped[bool] = mapped_column(Boolean, default=False)
  62. schedule_on_time: Mapped[str | None] = mapped_column(String(5), nullable=True) # "HH:MM" format
  63. schedule_off_time: Mapped[str | None] = mapped_column(String(5), nullable=True) # "HH:MM" format
  64. # Switchbar visibility
  65. show_in_switchbar: Mapped[bool] = mapped_column(Boolean, default=False)
  66. # Status tracking
  67. last_state: Mapped[str | None] = mapped_column(String(10), nullable=True) # "ON"/"OFF"
  68. last_checked: Mapped[datetime | None] = mapped_column(DateTime, nullable=True)
  69. auto_off_executed: Mapped[bool] = mapped_column(Boolean, default=False) # True when auto-off was triggered
  70. auto_off_pending: Mapped[bool] = mapped_column(Boolean, default=False) # True when waiting for cooldown
  71. auto_off_pending_since: Mapped[datetime | None] = mapped_column(
  72. DateTime, nullable=True
  73. ) # When auto-off was scheduled
  74. # Timestamps
  75. created_at: Mapped[datetime] = mapped_column(DateTime, server_default=func.now())
  76. updated_at: Mapped[datetime] = mapped_column(DateTime, server_default=func.now(), onupdate=func.now())
  77. # Relationship
  78. printer: Mapped["Printer"] = relationship(back_populates="smart_plug")
  79. from backend.app.models.printer import Printer # noqa: E402