Gitiles
Code Review Sign In
gerrit.openbmc.org / openbmc / phosphor-inventory-manager / e4b1b1e7835c22a46839f53e68032374731425ce
commite4b1b1e7835c22a46839f53e68032374731425ce[log] [tgz]
authorBrad Bishop <bradleyb@fuzziesquirrel.com>Mon Jan 23 10:37:39 2017 -0500
committerBrad Bishop <bradleyb@fuzziesquirrel.com>Tue Jan 24 14:39:00 2017 -0500
treec829ebe79e95c89fd6c2af763859cd117e37b89b
parenteffbd93eaf4464881c97184fbc6e0304d78873fe [diff]
docs: Update documentation

Update the README to reflect the current state of affairs.

Change-Id: I10397145684176f4529a9506f71216244bc6aaf7
Signed-off-by: Brad Bishop <bradleyb@fuzziesquirrel.com>
1 file changed
tree: c829ebe79e95c89fd6c2af763859cd117e37b89b
  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. Examples 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.
  • description - An optional description of the event.
  • type - The event type. Supported types are: match.
  • actions - The responses to the event.

Subsequent tags are defined by the event type.

match

Supported match tags are:

  • signatures - A DBus match specification.
  • filters - Filters to apply when a match occurs.

filters

Supported filter tags are:

  • name - The filter to use.
  • args - An optional list of arguments to pass to the filter.

The available filters provided by PIM are:

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

propertyChangedTo

Supported arguments for the propertyChangedTo filter are:

  • interface - The interface hosting the property to be checked.
  • property - The property to check.
  • value - The value to check.

actions

Supported action tags are:

  • name - The action to perform.
  • args - An optional list of arguments to pass to the action.

The available actions provided by PIM are:

  • noop - A non-action.
  • destroyObject - Destroy the specified DBus object.
  • setProperty - Set the specified property on the specified DBus object.

destroyObject

Supported arguments for the destroyObject action are:

  • path - The path of the object to remove from DBus.

setProperty

Supported arguments for the setProperty action are:

  • interface - The interface hosting the property to be set.
  • property - The property to set.
  • path - The object hosting the property to be set.
  • value - The value to set.

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