openbmc_project/Led/README.md

1 # Managing LED groups and physical LEDs through BMC
9 ## Understanding LED groups
11 While it is entirely possible to act directly on a physical LED, it makes hard
12 when more than one LED is to be acted on for a particular usecase.
15 LED upon reaching some state. However, some other systems may have a requirement
26 requirement of blinking system Enclosure LED indicating an internal problem:
29 that system before acting on it. In one case, the LED group may consist of DIMM
30 LED + Enclosure Fault LED. However, if the DIMM is attached to a Raiser card,
31 then the LED group may consist of DIMM LED + Raise card LED + Enclosure Fault
32 LED. Defining this path will make it easier to locate the box and the exact part
35 Definition of LED groups could be static or generated from MRW and must be in
63 ## Dbus interfaces for LED groups
68 …https://github.com/openbmc/phosphor-dbus-interfaces/blob/master/yaml/xyz/openbmc_project/Led/Group…
81 **Path: `/xyz/openbmc_project/led/groups/<name>`** **Interface:
82 `xyz.openbmc_Project.Led.Group`**
85 boolean `true` on `/xyz/openbmc_project/led/groups/enclosure_identify` and that
107 It is always **recommended** that external users use **only** the LED groups.
108 Describing the Physical LED here just for documenting it and strictly NOT to be
116 …https://github.com/openbmc/phosphor-dbus-interfaces/blob/master/yaml/xyz/openbmc_project/Led/Physi…
120 **Path: `/xyz/openbmc_project/led/physical/<name>`** **Interface:
121 `xyz.openbmc_Project.Led.Physical`**
123 Using **/xyz/openbmc_project/led/groups/enclosure_identify** as example; setting
128    `/xyz/openbmc/project/led/physical/id_front` and
129    `/xyz/openbmc/project/led/physical/id_rear`
131 2. Property `State` is set to `xyz.openbmc_project.Led.Physical.Action.On` in
132    `/xyz/openbmc/project/led/physical/id_front` and
133    `/xyz/openbmc/project/led/physical/id_rear`
136 in acting on physical LED, those are the properties to be read from physical