orangeqs.juice.dashboard.schemas#
Schemas for the dashboard module.
Module Contents#
Classes#
Settings for the Control PC Overview Table. |
|
Usage percentages at which a resource stops counting as normal. |
|
Settings for the health summary on the System Overview page. |
|
Settings for the Fridge Monitor Dashboard. |
Data#
Resources that the System Overview page reports a health status for. |
API#
- orangeqs.juice.dashboard.schemas.DEFAULT_FRIDGE_SERVICE#
‘fridge’
- class orangeqs.juice.dashboard.schemas.ControlPCOverviewTableSettings(/, **data: Any)#
Bases:
orangeqs.juice.settings.ConfigurableSettings for the Control PC Overview Table.
- orangeqs.juice.dashboard.schemas.MonitoredResource#
None
Resources that the System Overview page reports a health status for.
- class orangeqs.juice.dashboard.schemas.UsageThresholds(/, **data: Any)#
Bases:
orangeqs.juice.settings.BaseConfigurableUsage percentages at which a resource stops counting as normal.
- class orangeqs.juice.dashboard.schemas.ControlPCHealthSettings(/, **data: Any)#
Bases:
orangeqs.juice.settings.ConfigurableSettings for the health summary on the System Overview page.
- thresholds: dict[orangeqs.juice.dashboard.schemas.MonitoredResource, orangeqs.juice.dashboard.schemas.UsageThresholds]#
None
Usage percentage at which each resource is reported as
AttentionorCritical.
- class orangeqs.juice.dashboard.schemas.FridgeMonitorDashboardSettings(/, **data: Any)#
Bases:
orangeqs.juice.settings.ConfigurableSettings for the Fridge Monitor Dashboard.
Configuration options for the Fridge Monitor Dashboard. This configuration allows you to specify which components of your fridge monitoring system to display on the dashboard, as well as their display names.
Component IDs in this configurable must match the component IDs used in your fridge monitoring service.
- mode: Literal[read_only, power_user]#
‘power_user’
Dashboard mode, ether ‘read_only’ or ‘power_user`. In read only mode, controls are disabled and users can only monitor the system.
- service_name: str#
None
Name of the fridge service to monitor and control. Defaults to
"fridge".A
system-monitor-dashboard.tomlthat doesn’t set this explicitly falls back to"system-monitor"instead, so it keeps addressing a not-yet-renamed service - see Background: what still works automatically.
- thermometry_component_id: str#
‘thermometry_unit_1’
Component ID of the thermometry unit to monitor.
- thermometers: dict[str, str]#
None
Mapping of thermometer sensor IDs to their levels.
Level names are fully custom; there is no fixed vocabulary. Levels are displayed in the order they first appear in this mapping. Multiple sensor IDs may share the same level, in which case they are plotted together as separate lines on that level’s graph.
- compressors: dict[str, str]#
None
List of component IDs to display names to monitor for compressor units.