Gitiles
Code Review Sign In
gerrit.openbmc.org / openbmc / phosphor-inventory-manager / 09fc256bdd02dd3c8aeb158573bccfec21387ecc
commit09fc256bdd02dd3c8aeb158573bccfec21387ecc[log] [tgz]
authorBrad Bishop <bradleyb@fuzziesquirrel.com>Fri Oct 21 22:58:08 2016 -0400
committerBrad Bishop <bradleyb@fuzziesquirrel.com>Tue Nov 08 15:01:04 2016 -0500
tree45c46916e97890fafcc736690a66ed5310194aa0
parentadc4566c0cf67413ed4987309f4194c8636633dd [diff]
Move examples->example/events

Change-Id: I072cd37217f982fa45d6fae7f1ebebdabe1a7800
Signed-off-by: Brad Bishop <bradleyb@fuzziesquirrel.com>
3 files changed
tree: 45c46916e97890fafcc736690a66ed5310194aa0
  1. example/
  2. test/
  3. xyz/
  4. actions.hpp
  5. app.cpp
  6. bootstrap.sh
  7. configure.ac
  8. filters.hpp
  9. LICENSE
  10. Makefile.am
  11. manager.cpp
  12. manager.hpp
  13. pimgen.py
  14. README.md
  15. 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