docs: Update documentation
Update the README to reflect the current state of affairs.
Change-Id: I10397145684176f4529a9506f71216244bc6aaf7
Signed-off-by: Brad Bishop <bradleyb@fuzziesquirrel.com>
diff --git a/README.md b/README.md
index 2efecfb..e8e4b6e 100644
--- a/README.md
+++ b/README.md
@@ -7,7 +7,7 @@
## 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.
+Examples can be found in the examples directory.
The following top level YAML tags are supported:
@@ -20,43 +20,27 @@
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*.
-* action - The response to the event.
+* actions - The responses 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.
+* signatures - A DBus match specification.
+* filters - Filters to apply when a match occurs.
----
-**filter**
+**filters**
Supported filter tags are:
-* type - The filter to use.
+* name - 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:
@@ -65,6 +49,44 @@
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: