1# Sensor Monitor
2
3This application can take action based on sensor thresholds and values.
4
5## Available Monitors
6
7### ShutdownAlarmMonitor
8
9This monitor will watch all instances of the
10`xyz.openbmc_project.Sensor.Threshold.HardShutdown` and
11`xyz.openbmc_project.Sensor.Threshold.SoftShutdown` D-Bus interfaces for the
12alarm properties to trip.  When this happens, a configurable timer is started
13at the end of which a power off is executed if the alarms haven't reset by that
14time.  Event logs will also be created.
15
16The configuration options `SHUTDOWN_ALARM_HARD_SHUTDOWN_DELAY_MS` and
17`SHUTDOWN_ALARM_SOFT_SHUTDOWN_DELAY_MS` can be used to change the delays.
18
19### ThresholdAlarmLogger
20
21This monitor will watch the alarm properties on the following threshold
22D-Bus interfaces:
23
24- `xyz.openbmc_project.Sensor.Threshold.Warning`
25- `xyz.openbmc_project.Sensor.Threshold.Critical`
26- `xyz.openbmc_project.Sensor.Threshold.PerformanceLoss`
27
28When the alarm properties are asserted, event logs are created.  When they are
29deasserted, informational event logs are created.
30