blob: 2efecfbaf463a00eaa68061a0f22384988c578d1 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
|
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
```
|
