presence: Example JSON configuration & README updates
Converted YAML example to JSON.
Added details on how to enable the use of JSON at configure time to the
README.
Change-Id: I63ecb0552dfdcb622d640635dd8fd1b1353eb243
Signed-off-by: Matthew Barth <msbarth@us.ibm.com>
diff --git a/README.md b/README.md
index 9170196..eeebcf0 100755
--- a/README.md
+++ b/README.md
@@ -2,12 +2,26 @@
Phosphor fan provides a set of fan monitoring and control applications.
## To Build
-```
-To build this package, do the following steps:
+By default, YAML configuration file(s) are used at build time for each fan
+application. The location of the YAML configuration file(s) are provided at
+configure time to each application.
+To build this package using YAML, do the following steps:
+```
1. ./bootstrap.sh
2. ./configure ${CONFIGURE_FLAGS}
3. make
+```
+
+To enable the use of JSON configuration file(s) at runtime, provide the
+`--enable-json` flag at configure time.
+```
+ 1. ./bootstrap.sh
+ 2. ./configure ${CONFIGURE_FLAGS} --enable-json
+ 3. make
+```
+*Note: The following fan applications support the use of a JSON configuration
+file.*
+* Fan presence detection(presence)
To clean the repository run `./bootstrap.sh clean`.
-```
diff --git a/presence/example/example.json b/presence/example/example.json
new file mode 100644
index 0000000..6d77c81
--- /dev/null
+++ b/presence/example/example.json
@@ -0,0 +1,72 @@
+[
+ {
+ "name": "Example Fan0",
+ "description": "'Example fan with tach feedback detection method. Fans without any special presence detection hardware can use one or more tach speed sensor feedbacks as an indicator of presence. Listed sensors are expected to be found in the /xyz/openbmc_project/sensors/fan_tach namespace as required by the OpenBMC DBus API. Supported policy types are fallback or anyof.'",
+ "path": "/system/chassis/motherboard/fan0",
+ "methods": [
+ {
+ "type": "tach",
+ "sensors": [
+ "fan0"
+ ]
+ }
+ ]
+ },
+ {
+ "name": "Example Fan1",
+ "description": "'Example fan with gpio detection method. Fans with dedicated gpios can use the gpio detection method. The gpio detection uses Linux gpio-keys: the event number must be provided via the key property.'",
+ "path": "/system/chassis/motherboard/fan1",
+ "methods": [
+ {
+ "type": "gpio",
+ "key": 123,
+ "physpath": "/sys/devices/foo/bar",
+ "devpath": "/dev/input/by-path/platform-gpio-keys-event"
+ }
+ ]
+ },
+ {
+ "name": "Example Fan2",
+ "description": "'Example fan with fallback redundancy policy. Multiple detection methods for a single fan are allowed. When multiple detection methods are provided a redundancy algorithm must be specified with the rpolicy attribute. Note that the redundancy policy algorithm may or may not factor the order the detection methods are listed into its logic. The fallback algorithm falls back to subsequently listed detection methods when the first method does not detect a fan and the second method does.'",
+ "path": "/system/chassis/motherboard/fan2",
+ "methods": [
+ {
+ "type": "gpio",
+ "key": 124,
+ "physpath": "/sys/devices/foo/bar",
+ "devpath": "/dev/input/by-path/platform-gpio-keys-polled-event"
+ },
+ {
+ "type": "tach",
+ "sensors": [
+ "fan2"
+ ]
+ }
+ ],
+ "rpolicy": {
+ "type": "fallback"
+ }
+ },
+ {
+ "name": "Example Fan3",
+ "description": "'Example fan with anyof redundancy policy. The anyof algorithm reports true if any redundancy set component sensors report true.'",
+ "path": "/system/chassis/motherboard/fan3",
+ "methods": [
+ {
+ "type": "gpio",
+ "key": 125,
+ "physpath": "/sys/devices/foo/bar",
+ "devpath": "/dev/input/by-path/platform-gpio-keys-polled-event"
+ },
+ {
+ "type": "tach",
+ "sensors": [
+ "fan3"
+ ]
+ }
+ ],
+ "rpolicy": {
+ "type": "anyof"
+ }
+ }
+]