settings.py 10 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212
  1. from pydantic import BaseModel, Field
  2. class AppSettings(BaseModel):
  3. """Application settings schema."""
  4. auto_archive: bool = Field(default=True, description="Automatically archive prints when completed")
  5. save_thumbnails: bool = Field(default=True, description="Extract and save preview images from 3MF files")
  6. capture_finish_photo: bool = Field(
  7. default=True, description="Capture photo from printer camera when print completes"
  8. )
  9. default_filament_cost: float = Field(default=25.0, description="Default filament cost per kg")
  10. currency: str = Field(default="USD", description="Currency for cost tracking")
  11. energy_cost_per_kwh: float = Field(default=0.15, description="Electricity cost per kWh for energy tracking")
  12. energy_tracking_mode: str = Field(
  13. default="total",
  14. description="Energy display mode on stats: 'print' shows sum of per-print energy, 'total' shows lifetime plug consumption",
  15. )
  16. # Spoolman integration
  17. spoolman_enabled: bool = Field(default=False, description="Enable Spoolman integration for filament tracking")
  18. spoolman_url: str = Field(default="", description="Spoolman server URL (e.g., http://localhost:7912)")
  19. spoolman_sync_mode: str = Field(
  20. default="auto", description="Sync mode: 'auto' syncs immediately, 'manual' requires button press"
  21. )
  22. spoolman_disable_weight_sync: bool = Field(
  23. default=False,
  24. description="Disable remaining_weight sync. When enabled, only location is updated for existing spools.",
  25. )
  26. spoolman_report_partial_usage: bool = Field(
  27. default=True,
  28. description="Report Partial Usage for Failed Prints. When a print fails or is cancelled, report the estimated filament used up to that point based on layer progress.",
  29. )
  30. # Updates
  31. check_updates: bool = Field(default=True, description="Automatically check for updates on startup")
  32. check_printer_firmware: bool = Field(default=True, description="Check for printer firmware updates from Bambu Lab")
  33. include_beta_updates: bool = Field(default=False, description="Include beta/prerelease versions in update checks")
  34. # Language
  35. language: str = Field(default="en", description="UI language (en, de, fr, ja, it, pt-BR)")
  36. notification_language: str = Field(default="en", description="Language for push notifications (en, de)")
  37. # Bed cooled notification threshold
  38. bed_cooled_threshold: float = Field(
  39. default=35.0, description="Bed temperature threshold for cooled notification (°C)"
  40. )
  41. # AMS threshold settings for humidity and temperature coloring
  42. ams_humidity_good: int = Field(default=40, description="Humidity threshold for good (green): <= this value")
  43. ams_humidity_fair: int = Field(
  44. default=60, description="Humidity threshold for fair (orange): <= this value, > is red"
  45. )
  46. ams_temp_good: float = Field(default=28.0, description="Temperature threshold for good (blue): <= this value")
  47. ams_temp_fair: float = Field(
  48. default=35.0, description="Temperature threshold for fair (orange): <= this value, > is red"
  49. )
  50. ams_history_retention_days: int = Field(default=30, description="Number of days to keep AMS sensor history data")
  51. # Print modal settings
  52. per_printer_mapping_expanded: bool = Field(
  53. default=False, description="Expand custom filament mapping by default in print modal"
  54. )
  55. # Date/time display format
  56. date_format: str = Field(default="system", description="Date format: system, us, eu, iso")
  57. time_format: str = Field(default="system", description="Time format: system, 12h, 24h")
  58. # Default printer for operations
  59. default_printer_id: int | None = Field(default=None, description="Default printer ID for uploads, reprints, etc.")
  60. # Virtual Printer
  61. virtual_printer_enabled: bool = Field(default=False, description="Enable virtual printer for slicer uploads")
  62. virtual_printer_access_code: str = Field(default="", description="Access code for virtual printer authentication")
  63. virtual_printer_mode: str = Field(
  64. default="immediate",
  65. description="Mode: 'immediate' (archive now), 'review' (pending review), or 'print_queue' (add to print queue)",
  66. )
  67. # Dark mode theme settings
  68. dark_style: str = Field(default="classic", description="Dark mode style: classic, glow, vibrant")
  69. dark_background: str = Field(
  70. default="neutral", description="Dark mode background: neutral, warm, cool, oled, slate, forest"
  71. )
  72. dark_accent: str = Field(default="green", description="Dark mode accent: green, teal, blue, orange, purple, red")
  73. # Light mode theme settings
  74. light_style: str = Field(default="classic", description="Light mode style: classic, glow, vibrant")
  75. light_background: str = Field(default="neutral", description="Light mode background: neutral, warm, cool")
  76. light_accent: str = Field(default="green", description="Light mode accent: green, teal, blue, orange, purple, red")
  77. # FTP retry settings for unreliable WiFi connections
  78. ftp_retry_enabled: bool = Field(default=True, description="Enable automatic retry for FTP operations")
  79. ftp_retry_count: int = Field(default=3, description="Number of retry attempts for FTP operations (1-10)")
  80. ftp_retry_delay: int = Field(default=2, description="Seconds to wait between FTP retry attempts (1-30)")
  81. ftp_timeout: int = Field(default=30, description="FTP connection timeout in seconds (10-120)")
  82. # MQTT Relay settings for publishing events to external broker
  83. mqtt_enabled: bool = Field(default=False, description="Enable MQTT event publishing to external broker")
  84. mqtt_broker: str = Field(default="", description="MQTT broker hostname or IP address")
  85. mqtt_port: int = Field(default=1883, description="MQTT broker port (default 1883, TLS typically 8883)")
  86. mqtt_username: str = Field(default="", description="MQTT username for authentication (optional)")
  87. mqtt_password: str = Field(default="", description="MQTT password for authentication (optional)")
  88. mqtt_topic_prefix: str = Field(default="bambuddy", description="Topic prefix for all published messages")
  89. mqtt_use_tls: bool = Field(default=False, description="Use TLS/SSL encryption for MQTT connection")
  90. # External URL for notifications
  91. external_url: str = Field(
  92. default="", description="External URL where Bambuddy is accessible (for notification images)"
  93. )
  94. # Home Assistant integration for smart plug control
  95. ha_enabled: bool = Field(default=False, description="Enable Home Assistant integration for smart plug control")
  96. ha_url: str = Field(default="", description="Home Assistant URL (e.g., http://192.168.1.100:8123)")
  97. ha_token: str = Field(default="", description="Home Assistant Long-Lived Access Token")
  98. ha_url_from_env: bool = Field(default=False, description="Whether HA URL is set via HA_URL environment variable")
  99. ha_token_from_env: bool = Field(
  100. default=False, description="Whether HA token is set via HA_TOKEN environment variable"
  101. )
  102. ha_env_managed: bool = Field(
  103. default=False, description="Whether HA integration is fully managed by environment variables"
  104. )
  105. # File Manager / Library settings
  106. library_archive_mode: str = Field(
  107. default="ask",
  108. description="When printing from File Manager, create archive entry: 'always', 'never', or 'ask'",
  109. )
  110. library_disk_warning_gb: float = Field(
  111. default=5.0,
  112. description="Show warning when free disk space falls below this threshold (GB)",
  113. )
  114. # Camera view settings
  115. camera_view_mode: str = Field(
  116. default="window",
  117. description="Camera view mode: 'window' opens in new browser window, 'embedded' shows overlay on main screen",
  118. )
  119. # Preferred slicer application
  120. preferred_slicer: str = Field(
  121. default="bambu_studio",
  122. description="Preferred slicer: 'bambu_studio' or 'orcaslicer'",
  123. )
  124. # Prometheus metrics endpoint
  125. prometheus_enabled: bool = Field(default=False, description="Enable Prometheus metrics endpoint at /metrics")
  126. prometheus_token: str = Field(
  127. default="", description="Bearer token for Prometheus metrics authentication (optional)"
  128. )
  129. class AppSettingsUpdate(BaseModel):
  130. """Schema for updating settings (all fields optional)."""
  131. auto_archive: bool | None = None
  132. save_thumbnails: bool | None = None
  133. capture_finish_photo: bool | None = None
  134. default_filament_cost: float | None = None
  135. currency: str | None = None
  136. energy_cost_per_kwh: float | None = None
  137. energy_tracking_mode: str | None = None
  138. spoolman_enabled: bool | None = None
  139. spoolman_url: str | None = None
  140. spoolman_sync_mode: str | None = None
  141. spoolman_disable_weight_sync: bool | None = None
  142. spoolman_report_partial_usage: bool | None = None
  143. check_updates: bool | None = None
  144. check_printer_firmware: bool | None = None
  145. include_beta_updates: bool | None = None
  146. language: str | None = None
  147. notification_language: str | None = None
  148. bed_cooled_threshold: float | None = None
  149. ams_humidity_good: int | None = None
  150. ams_humidity_fair: int | None = None
  151. ams_temp_good: float | None = None
  152. ams_temp_fair: float | None = None
  153. ams_history_retention_days: int | None = None
  154. per_printer_mapping_expanded: bool | None = None
  155. date_format: str | None = None
  156. time_format: str | None = None
  157. default_printer_id: int | None = None
  158. virtual_printer_enabled: bool | None = None
  159. virtual_printer_access_code: str | None = None
  160. virtual_printer_mode: str | None = None
  161. dark_style: str | None = None
  162. dark_background: str | None = None
  163. dark_accent: str | None = None
  164. light_style: str | None = None
  165. light_background: str | None = None
  166. light_accent: str | None = None
  167. ftp_retry_enabled: bool | None = None
  168. ftp_retry_count: int | None = None
  169. ftp_retry_delay: int | None = None
  170. ftp_timeout: int | None = None
  171. mqtt_enabled: bool | None = None
  172. mqtt_broker: str | None = None
  173. mqtt_port: int | None = None
  174. mqtt_username: str | None = None
  175. mqtt_password: str | None = None
  176. mqtt_topic_prefix: str | None = None
  177. mqtt_use_tls: bool | None = None
  178. external_url: str | None = None
  179. ha_enabled: bool | None = None
  180. ha_url: str | None = None
  181. ha_token: str | None = None
  182. library_archive_mode: str | None = None
  183. library_disk_warning_gb: float | None = None
  184. camera_view_mode: str | None = None
  185. preferred_slicer: str | None = None
  186. prometheus_enabled: bool | None = None
  187. prometheus_token: str | None = None