Gitiles
Code Review Sign In
gerrit.openbmc.org / openbmc / phosphor-inventory-manager / 64d994a61cbb8a2693f9d5d9413f7e09d851c53b
commit64d994a61cbb8a2693f9d5d9413f7e09d851c53b[log] [tgz]
authorBrad Bishop <bradleyb@fuzziesquirrel.com>Mon Oct 31 10:24:27 2016 -0500
committerBrad Bishop <bradleyb@fuzziesquirrel.com>Tue Nov 08 15:15:36 2016 -0500
treeaa50ea6fcb687cb6ba7b8287331d451ade521bff
parentd202bfdb3afb2b22a829307b81fc144731874c91 [diff]
Optionally include generated example bindings

Add an autoconf opttion that includes the example
bindings, for use in standalone/testing environments.

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