xref: /openbmc/phosphor-fan-presence/docs/control/fans.md (revision 27cc39f1f98c6fe0352ff01effb189ab1dead055)
1# fans.json
2
3## JSON Example
4
5```
6[
7    {
8        "name": "fan0",
9        "zone": "0",
10        "sensors": ["fan0_0"],
11        "target_interface": "xyz.openbmc_project.Control.FanSpeed",
12        "target_path": "/xyz/openbmc_project/control/fanpwm/"
13    }
14    ...
15]
16```
17
18## Attributes
19
20### name
21The D-Bus name of the fan FRU. Required.
22
23### zone
24The zone the fan is in. Required.
25
26### sensors
27The D-bus sensor names associated with that fan. Required.
28
29### target_interface
30The D-Bus interface to use for setting the fan target speed/PWM. Either
31`xyz.openbmc_project.Control.FanSpeed` for RPM controlled fans or
32`xyz.openbmc_project.Control.FanPWM` for PWM controlled fans. Required.
33
34### target_path
35The D-Bus object path used for setting the fan target speed/PWM via
36"target_interface". If not configured, it defaults to
37`/xyz/openbmc_project/sensors/fan_tach/`. Optional.