openbmc/phosphor-led-manager/README.md

1 # phosphor-led-manager
3 This project manages LED groups on dbus. Sometimes many LEDs must be driven
13 ### Configuration: LED Priority
15 Each LED can have "Priority" as "Blink", "Off" or "On". If this property is
16 defined, it should be defined on each instance of the LED in the config.
18 When multiple LED groups are asserted and contain the same LED, "Priority"
19 determines the state of the LED.
21 For example, Group 1 says LED1 should be "Blink", and Group 2 says it should be
24 ## Configuration: LED Group Priority
26 Using LED Priority is fine for simple configurations, but when group state needs
30 The Group `Priority` is optional and a higher priority means that when 2 groups
49       "Priority": 2,
90 This is our configuration file. It describes 2 LEDs for the
122 ~# ./phosphor-led-manager --config example.json
127 When starting the program, our LED group shows up on dbus. Usually there will be
131 $ busctl tree xyz.openbmc_project.LED.GroupManager
132 `- /xyz
133   `- /xyz/openbmc_project
134     `- /xyz/openbmc_project/led
135       `- /xyz/openbmc_project/led/groups
136         `- /xyz/openbmc_project/led/groups/enclosure_identify
139 $ busctl introspect xyz.openbmc_project.LED.GroupManager /xyz/openbmc_project/led/groups/enclosure_…
142 xyz.openbmc_project.Led.Group       interface -         -            -
143 .Asserted                           property  b         false        emits-change writable
152 $ busctl set-property \
153 xyz.openbmc_project.LED.GroupManager \
154 /xyz/openbmc_project/led/groups/enclosure_identify \
155 xyz.openbmc_project.Led.Group Asserted b true
158 The program can then use the _xyz.openbmc_project.Led.Physical_ dbus interface
159 exposed by _phosphor-led-sysfs_ to set each LED state.