1*9d01e5eaSJagpal Singh Gilldescription: >
2*9d01e5eaSJagpal Singh Gill    Implement to provide attributes for leak detector.
3*9d01e5eaSJagpal Singh Gill
4*9d01e5eaSJagpal Singh Gillproperties:
5*9d01e5eaSJagpal Singh Gill    - name: PrettyName
6*9d01e5eaSJagpal Singh Gill      type: string
7*9d01e5eaSJagpal Singh Gill      description: >
8*9d01e5eaSJagpal Singh Gill          The human readable name of the leak detector.
9*9d01e5eaSJagpal Singh Gill      flags:
10*9d01e5eaSJagpal Singh Gill          - readonly
11*9d01e5eaSJagpal Singh Gill    - name: State
12*9d01e5eaSJagpal Singh Gill      type: enum[self.DetectorState]
13*9d01e5eaSJagpal Singh Gill      description: >
14*9d01e5eaSJagpal Singh Gill          The state of the leak detector.
15*9d01e5eaSJagpal Singh Gill      flags:
16*9d01e5eaSJagpal Singh Gill          - readonly
17*9d01e5eaSJagpal Singh Gill    - name: Type
18*9d01e5eaSJagpal Singh Gill      type: enum[self.DetectorType]
19*9d01e5eaSJagpal Singh Gill      description: >
20*9d01e5eaSJagpal Singh Gill          The type of the leak detector.
21*9d01e5eaSJagpal Singh Gill
22*9d01e5eaSJagpal Singh Gillenumerations:
23*9d01e5eaSJagpal Singh Gill    - name: DetectorType
24*9d01e5eaSJagpal Singh Gill      description: >
25*9d01e5eaSJagpal Singh Gill          This indicates the type of leak detector as in Redfish LeakDetector
26*9d01e5eaSJagpal Singh Gill          schema https://redfish.dmtf.org/schemas/v1/LeakDetector.v1_2_0.json.
27*9d01e5eaSJagpal Singh Gill      values:
28*9d01e5eaSJagpal Singh Gill          - name: LeakSensingCable
29*9d01e5eaSJagpal Singh Gill            description: >
30*9d01e5eaSJagpal Singh Gill                A leak sensing cable.
31*9d01e5eaSJagpal Singh Gill          - name: Unknown
32*9d01e5eaSJagpal Singh Gill            description: >
33*9d01e5eaSJagpal Singh Gill                An unknown detector type
34*9d01e5eaSJagpal Singh Gill    - name: DetectorState
35*9d01e5eaSJagpal Singh Gill      description: >
36*9d01e5eaSJagpal Singh Gill          This indicates the state of the leak detector
37*9d01e5eaSJagpal Singh Gill      values:
38*9d01e5eaSJagpal Singh Gill          - name: Normal
39*9d01e5eaSJagpal Singh Gill            description: >
40*9d01e5eaSJagpal Singh Gill                The state is normal as no leaks have been detected by the leak
41*9d01e5eaSJagpal Singh Gill                detector.
42*9d01e5eaSJagpal Singh Gill          - name: Abnormal
43*9d01e5eaSJagpal Singh Gill            description: >
44*9d01e5eaSJagpal Singh Gill                A leak has been detected by the leak detector, indicating an
45*9d01e5eaSJagpal Singh Gill                abnormal leak state.
46*9d01e5eaSJagpal Singh Gill          - name: Unknown
47*9d01e5eaSJagpal Singh Gill            description: >
48*9d01e5eaSJagpal Singh Gill                The state cannot be determined as the detector may be faulty.
49*9d01e5eaSJagpal Singh Gill
50*9d01e5eaSJagpal Singh Gillassociations:
51*9d01e5eaSJagpal Singh Gill    - name: monitoring
52*9d01e5eaSJagpal Singh Gill      description: >
53*9d01e5eaSJagpal Singh Gill          Leak detectors can optionally implement the 'monitoring' association
54*9d01e5eaSJagpal Singh Gill          with the inventory item related to it.
55*9d01e5eaSJagpal Singh Gill      reverse_name: monitored_by
56*9d01e5eaSJagpal Singh Gill      required_endpoint_interfaces:
57*9d01e5eaSJagpal Singh Gill          - xyz.openbmc_project.Inventory.Item
58*9d01e5eaSJagpal Singh Gill
59*9d01e5eaSJagpal Singh Gillpaths:
60*9d01e5eaSJagpal Singh Gill    - namespace: /xyz/openbmc_project/state/leak
61*9d01e5eaSJagpal Singh Gill      description: >
62*9d01e5eaSJagpal Singh Gill          The root path for state of all leak objects.
63*9d01e5eaSJagpal Singh Gill      segments:
64*9d01e5eaSJagpal Singh Gill          - name: Detector
65*9d01e5eaSJagpal Singh Gill            description: >
66*9d01e5eaSJagpal Singh Gill                The leak detector.
67*9d01e5eaSJagpal Singh Gill            value: detector
68