Gitiles
Code Review Sign In
gerrit.openbmc.org / openbmc / phosphor-inventory-manager / c038e016eac8a4bac9b4a06546fe975eb63ce9ff
commitc038e016eac8a4bac9b4a06546fe975eb63ce9ff[log] [tgz]
authorBrad Bishop <bradleyb@fuzziesquirrel.com>Wed Oct 19 13:02:24 2016 -0400
committerBrad Bishop <bradleyb@fuzziesquirrel.com>Tue Nov 08 14:51:16 2016 -0500
treeba4df554c300ff72877742b7037128fad4d2968f
parent3d57f507b41860d11059904e87da61b4f25cfd82 [diff]
Add actions

Provide tooling to enable specification of pre-implemented actions
to perform after a signal match.

Add a default 'noop' action to be used when an action isn't specified.

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

  • name - The action name.
  • 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.

match Supported match tags are:

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

filter Supported filter tags are:

  • name - The name of the filter.
  • 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.

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