Gitiles
Code Review Sign In
gerrit.openbmc.org / openbmc / phosphor-inventory-manager / cab2bddb2ab02d17526371531ee57fdfd6bfa14f
commitcab2bddb2ab02d17526371531ee57fdfd6bfa14f[log] [tgz]
authorBrad Bishop <bradleyb@fuzziesquirrel.com>Sat Jan 21 15:00:54 2017 -0500
committerBrad Bishop <bradleyb@fuzziesquirrel.com>Tue Jan 24 14:39:00 2017 -0500
tree80de3727409671c3552e654d8f2d895c3c811859
parente4b1b1e7835c22a46839f53e68032374731425ce [diff]
pimgen: Add new Mako templates

Add three new templates in preparation for another round of refactoring.

argument - For rendering array arguments.
method - For rendering method calls.
signature - For rendering dbus signature arguments.

Change-Id: I9f9806bcb5c1e048aa283e76f9c6f0f8a7bb53ac
Signed-off-by: Brad Bishop <bradleyb@fuzziesquirrel.com>
4 files changed
tree: 80de3727409671c3552e654d8f2d895c3c811859
  1. example/
  2. test/
  3. xyz/
  4. .gitignore
  5. actions.hpp
  6. app.cpp
  7. argument.mako.cpp
  8. bootstrap.sh
  9. configure.ac
  10. events.hpp
  11. generated.mako.cpp
  12. LICENSE
  13. Makefile.am
  14. manager.cpp
  15. manager.hpp
  16. method.mako.cpp
  17. pimgen.py
  18. README.md
  19. signature.mako.cpp
  20. utils.hpp
  21. 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