xref: /openbmc/phosphor-fan-presence/presence/example/config.json (revision 8bd63087)

[
  {
    "comments": [
      "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. The fan_missing_error_time value is the amount",
      "of time in seconds that a fan must be missing before an event log is",
      "created."
    ],
    "name": "Example Fan0",
    "path": "/system/chassis/motherboard/fan0",
    "fan_missing_error_time": 10,
    "methods": [
      {
        "type": "tach",
        "sensors": [
          "fan0"
        ]
      }
    ]
  },
  {
    "comments": [
      "Example fan with gpio detection method. Fans with dedicated gpios can",
      "use the gpio detection method. The gpio detection uses Linux gpio-keys,",
      "where the event number is provided via the `key` property."
    ],
    "name": "Example Fan1",
    "path": "/system/chassis/motherboard/fan1",
    "fan_missing_error_time": 10,
    "methods": [
      {
        "type": "gpio",
        "key": 123,
        "physpath": "/sys/devices/foo/bar",
        "devpath": "/dev/input/by-path/platform-gpio-keys-event"
      }
    ]
  },
  {
    "comments": [
      "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."
    ],
    "name": "Example Fan2",
    "path": "/system/chassis/motherboard/fan2",
    "fan_missing_error_time": 10,
    "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"
    }
  },
  {
    "comments": [
      "Example fan with anyof redundancy policy. The anyof algorithm reports",
      "true if any redundancy set component sensors report true."
    ],
    "name": "Example Fan3",
    "path": "/system/chassis/motherboard/fan3",
    "fan_missing_error_time": 10,
    "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"
    }
  }
]