control/fanctl/README.md

1 # Fan Control tool
3 A tool that enables a user to view the status of a system in regard to fan
4 control including the ability to manually set the fans to a desired RPM (or PWM
5 if supported by the system). This tool has been tested against systems utilizing
6 the phosphor-fan-presence repository set of fan applications (i.e. romulus,
12 The intention of this tool is to temporarily stop the automatic fan control
13 algorithm and allow the user to manually set the fans within the system chassis
14 to a given target. Once a user no longer has a need to manually control the
15 fans, the resume operation re-enables and restarts the phosphor-fan-control
17 along with the the main system states and fan control systemd service, while the
19 (YAML-based configurations are not reloadable).
21 Note: In the case where a system does not have an active fan control algorithm
28   fanctl - Manually control, get fan tachs, view status, reload config,
29   and resume automatic control of all fans within a chassis.
37         - RPM/PWM target to set the fans
39         - space-delimited list of target sensors to set
41     - Get the current fan target and feedback speeds for all rotors
43     - Get the full system status in regard to fans
45     - Reload phosphor-fan configuration JSON files (YAML configuration not
48     - Resume automatic fan control
49     * Note: In the case where a system does not have an active fan control
53     - Tell fan control to dump its caches and flight recorder.
55     - Provides arguments to search the dump file.
57     - Display this help and exit
62 - Set all fans to a target value (The tool determines whether the machine is
67 - Set only fan_0, fan1_0, fan2_0 to target 8500:
71 - Resume automatic fan control:
75 - Get the current fan target and feedback speeds for all rotors:
97 - Get the full system status in regard to fans:
102   Fan Control Service State   : loaded, inactive(dead)
119 - Reload all json config files in the order each is found: override location,
124 - Tell the fan control daemon to dump debug data to /tmp/fan_control_dump.json
128 - Print all temperatures in the fan control cache after running 'fanctl dump':
130   > fanctl query_dump -s objects -n sensors/temperature -p Value
132 - Print every interface and property in the Ambient temp sensor's cache entry:
134   > fanctl query_dump -s objects -n Ambient
136 - Print the flight recorder after running 'fanctl dump':
137   > fanctl query_dump -s flight_recorder