Gitiles
Code Review Sign In
gerrit.openbmc.org / openbmc / phosphor-inventory-manager / c029f6aaa2e414567056836ea63409c8418cace8
commitc029f6aaa2e414567056836ea63409c8418cace8[log] [tgz]
authorBrad Bishop <bradleyb@fuzziesquirrel.com>Wed Jan 18 19:43:26 2017 -0500
committerBrad Bishop <bradleyb@fuzziesquirrel.com>Tue Jan 24 14:38:59 2017 -0500
treecb720d15d3d2aa861aad88e51b11840ddd916d1d
parente07a164897f5ce584cbdb93bd8f50055bd56ac6a [diff]
pimgen: Display possible commands with help

Change-Id: Ibdc6671289487224dae639643c36f1ac05a3eb6f
Signed-off-by: Brad Bishop <bradleyb@fuzziesquirrel.com>
1 file changed
tree: cb720d15d3d2aa861aad88e51b11840ddd916d1d
  1. example/
  2. test/
  3. xyz/
  4. .gitignore
  5. actions.hpp
  6. app.cpp
  7. bootstrap.sh
  8. configure.ac
  9. events.hpp
  10. generated.mako.cpp
  11. LICENSE
  12. Makefile.am
  13. manager.cpp
  14. manager.hpp
  15. pimgen.py
  16. README.md
  17. utils.hpp
  18. xyz.openbmc_project.Inventory.Manager.cpp
README.md

Phosphor Inventory Manager (PIM) is an implementation of the xyz.openbmc_project.Inventory.Manager DBus interface, and supporting tools. PIM uses a combination of build-time YAML files and run-time calls to the Notify method of the Manager interface to provide a generalized inventory state management solution.

YAML

PIM includes a YAML parser (pimgen.py). For PIM to do anything useful, a set of YAML files must be provided externally that tell it what to do. An example can be found in the examples directory.

The following top level YAML tags are supported:

  • description - An optional description of the file.
  • events - One or more events that PIM should monitor.

events

Supported event tags are:

  • name - A globally unique event name.
  • type - The event type. Supported types are: match.
  • action - The response to the event.

Subsequent tags are defined by the event type.

action

Supported action tags are:

  • type - The action to perform.
  • args - An optional list of arguments to pass to the action.
    • value - The argument value.
    • type - The argument type (defaults to string if unspecified).

The available actions provided by PIM are:

  • noop - A non-action.
  • destroyObject - Destroy the specified DBus object.

match

Supported match tags are:

  • signature - A DBus match specification.
  • filter - A filter to apply when a match occurs.

filter

Supported filter tags are:

  • type - The filter to use.
  • args - An optional list of arguments to pass to the filter.
    • value - The argument value.
    • type - The argument type (defaults to string if unspecified).

The available filters provided by PIM are:

  • none - A non-filter.
  • propertyChangedTo - Only match events when the specified property has the specified value.

Building

After running pimgen.py, build PIM using the following steps:

    ./bootstrap.sh
    ./configure ${CONFIGURE_FLAGS}
    make

To clean the repository run:

 ./bootstrap.sh clean