docs/designs/liquid-leak-detection.md

19 In this document, a leak is considered to be an entity with digital (present or
20 not-present) value. Currently, openBMC has a framework for sensors, but it is
23 [phosphor-gpio-monitor](https://github.com/openbmc/phosphor-gpio-monitor) is too
28 1. Able to identify leak presence for GPIO-based detectors and generate
32    - For example, the physical location of detectors can be used to determine
38 4. Capable of generating a D-Bus interface that adheres to
46 The DBus Interface for leak detection will consist of following -
49 | :------------------------------------------- | :----------: | :----------------------------: |
54 [patch](https://gerrit.openbmc.org/c/openbmc/phosphor-dbus-interfaces/+/73151)
55 for related D-Bus changes.
63 | :--------------: | :---------------------------------------------------------------------: |
75 ---
78 ---
80     A["EntityManager"] -- Detector Configuration
81 (via D-Bus) --> B["Leak Detection Manager"]
82     B -- Creates --> C["Leak Detector Group"] & F["Leak Detectors"]
83 …C -- Creates Interface --> E["xyz.openbmc_project.State.Leak.DetectorGroup at /xyz/openbmc_project…
84 …F -- Creates Interface --> G["xyz.openbmc_project.State.Leak.Detector at /xyz/openbmc_project/stat…
85     C -. contains .- F
89 #### Entity Manager Configuration
94 [refer](https://gerrit.openbmc.org/c/openbmc/entity-manager/+/75734).
98 An example of entity manager configuration for leak detector is as under -
115 #### LeakDetection Manager
117 The LeakDetection Manager is responsible for processing input configuration
118 objects from the Entity Manager via DBus. Based on related interface signals, it
119 creates or deletes the corresponding detector and detector group D-Bus
122 resolves the appropriate leak-related alerts. This fulfills requirements# 1
128 [leak detection](https://gerrit.openbmc.org/c/openbmc/phosphor-dbus-interfaces/+/73707)
130 [event logging design](https://github.com/openbmc/docs/blob/master/designs/event-logging.md).
134 The entity manager configuration specifies the severity level for a leak
136 Manager generates an event message with the appropriate severity level as
141 ### phosphor-gpio-monitor
143 The current design of the phosphor-gpio-monitor is too generic and does not meet
145 phosphor-gpio-monitor to add these requirements would result in a monolithic
147 the phosphor-gpio-monitor performs generic tasks in a simple manner and does so
154 - A new D-Bus interface for leak detection is being proposed as part of this
164 - Does this repository require a new repository? No.
165 - Who will be the initial maintainer(s) of this repository? NA
166 - Which repositories are expected to be modified to execute this design? BMCWeb,
167   dbus-sensors, phosphor-dbus-interfaces
168 - Make a list, and add listed repository maintainers to the gerrit review.