| commit | bdbfcde10520fc841b44d1e777c353a698b774ff | [log] [tgz] |
|---|---|---|
| author | Alexander Hansen <alexander.hansen@9elements.com> | Wed Jun 26 12:06:58 2024 +0200 |
| committer | Alexander Hansen <alexander.hansen@9elements.com> | Wed Jun 26 12:08:49 2024 +0200 |
| tree | ee86d66e17a01486059fadaa7b21cc558acf1bda | |
| parent | 94e894cb0286404821a34db04b711d7dfc4b9fd6 [diff] |
Add README.md Explaining the high level workings of this project. Change-Id: I066820dc2f7b09081385d3111d3e1beee46b7d8f Signed-off-by: Alexander Hansen <alexander.hansen@9elements.com>
This project manages LED groups on dbus. Sometimes many LEDs must be driven together to indicate some system state.
For example, there can be multiple identify LEDs. When the user wants to identify the system, they should all light up together.
The configuration can happen via json or yaml.
This is our configuration file. It describes 2 LEDs for the 'enclosure_identify' group, with their respective states and duty cycles.
$ cat example.json
{
"leds": [
{
"group": "enclosure_identify",
"members": [
{
"Name": "pca955x_front_sys_id0",
"Action": "On",
"DutyOn": 50,
"Period": 0,
"Priority": "Blink"
},
{
"Name": "led_rear_enc_id0",
"Action": "On",
"DutyOn": 50,
"Period": 0,
"Priority": "Blink"
}
]
}
]
}
Then start the program with
$ ./phosphor-led-manager --config example.json
When starting the program, our LED group shows up on dbus. Usually there will be many more groups.
$ busctl tree xyz.openbmc_project.LED.GroupManager
`- /xyz
`- /xyz/openbmc_project
`- /xyz/openbmc_project/led
`- /xyz/openbmc_project/led/groups
`- /xyz/openbmc_project/led/groups/enclosure_identify
$ busctl introspect xyz.openbmc_project.LED.GroupManager /xyz/openbmc_project/led/groups/enclosure_identify
NAME TYPE SIGNATURE RESULT/VALUE FLAGS
...
xyz.openbmc_project.Led.Group interface - - -
.Asserted property b false emits-change writable
In the above output, the usual org.freedesktop.* interfaces have been removed to keep it readable.
We can now drive the entire group by setting it's 'Asserted' property on dbus.
$ busctl set-property \ xyz.openbmc_project.LED.GroupManager \ /xyz/openbmc_project/led/groups/enclosure_identify \ xyz.openbmc_project.Led.Group Asserted b true
The program can then use the xyz.openbmc_project.Led.Physical dbus interface exposed by phosphor-led-sysfs to set each LED state.
meson setup build cd build ninja