docs/designs/liquid-leak-detection.md

1 # Liquid Leak Detection
19 In this document, a leak is considered to be an entity with digital (present or
28 1. Able to identify leak presence for GPIO-based detectors and generate
33      the severity level of a leak. A leak may be considered minor if it is
36 3. Capable of performing actions based on leak classification, which can be
39    [Redfish Leak Detection](https://redfish.dmtf.org/schemas/v1/LeakDetection.v1_0_1.json)
40    standards, allowing for the exposure of leak detection status to clients.
46 The DBus Interface for leak detection will consist of following -
50 | xyz.openbmc_project.State.Leak.DetectorGroup |     New      | Implements Leak Detector Group |
51 | xyz.openbmc_project.State.Leak.Detector      |     New      |    Implements Leak Detector    |
72 ### Liquid Leak Detector
81 (via D-Bus) --> B["Leak Detection Manager"]
82     B -- Creates --> C["Leak Detector Group"] & F["Leak Detectors"]
83 …reates Interface --> E["xyz.openbmc_project.State.Leak.DetectorGroup at /xyz/openbmc_project/state…
84 … Creates Interface --> G["xyz.openbmc_project.State.Leak.Detector at /xyz/openbmc_project/state/le…
93 For information on the configuration schema for leak detectors, please
98 An example of entity manager configuration for leak detector is as under -
121 targets based on the leak level if a leak is detected. It also raises or
122 resolves the appropriate leak-related alerts. This fulfills requirements# 1
128 [leak detection](https://gerrit.openbmc.org/c/openbmc/phosphor-dbus-interfaces/+/73707)
132 #### Leak Severity
134 The entity manager configuration specifies the severity level for a leak
135 detector. When the corresponding detector detects a leak, the LeakDetection
154 - A new D-Bus interface for leak detection is being proposed as part of this
160 processing leak detector GPIO events, but the impact is negligible.
180 GPIO sim tool to simulate leak detection GPIOs, which can be triggered as