Skip to content

Commit

Permalink
update readme: add remaining config options
Browse files Browse the repository at this point in the history
  • Loading branch information
@EvanMulawski
EvanMulawski committed May 23, 2024
1 parent 38030b8 commit f5452bf
Showing 1 changed file with 14 additions and 11 deletions.
25 changes: 14 additions & 11 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -102,14 +102,14 @@ This project is under active development, with frequent Beta releases that addre

8. Requires driver installation and Windows 10/11 64-bit OS. See [instructions](#siusbxpress-driver) (also included in download).

9. The default safety profile stored on the device may be overridden by setting the `FANCONTROL_CORSAIRLINK_HYDRO_ASETEK_PRO_SAFETY_PROFILE_OVERRIDE_ENABLED` environment variable to `1` and restarting Fan Control. This will write a new safety profile to the device:
9. The default safety profile stored on the device may be overridden by setting the `FANCONTROL_CORSAIRLINK_HYDRO_ASETEK_PRO_SAFETY_PROFILE_OVERRIDE_ENABLED` [environment variable](#configuration) to `1` and restarting Fan Control. This will write a new safety profile to the device:

| | Temp | Fan Duty |
| ---------- | ---- | -------- |
| Activate | 58°C | 100% |
| Deactivate | 57°C | - |

10. As of v1.4.3, the minimum pump power is 50% (regardless of the requested power in Fan Control) to prevent a "pump failure" state and noise/resonance that may occur due to low pump RPM. Additionally, the default pump power is 100%. As of v1.6.0, the default minimum pump power is 50% but users may override this by setting the `FANCONTROL_CORSAIRLINK_MIN_PUMP_DUTY` environment variable to the desired minimum pump power (a value between `0` and `100`).
10. As of v1.4.3, the minimum pump power is 50% (regardless of the requested power in Fan Control) to prevent a "pump failure" state and noise/resonance that may occur due to low pump RPM. Additionally, the default pump power is 100%. As of v1.6.0, the default minimum pump power is 50% but users may override this by setting the `FANCONTROL_CORSAIRLINK_MIN_PUMP_DUTY` [environment variable](#configuration) to the desired minimum pump power.

11. Corsair One computers using the Hydro Platinum controller are supported. For liquid-cooled GPU models, GPU pump RPM and liquid temperature sensors are available, but GPU pump speed control is not yet supported. All supported models support CPU pump speed control.

Expand All @@ -133,7 +133,7 @@ Support for the iCUE LINK Hub was added in v1.5.0. The following LINK devices ar

Don't see your device listed? Open an [issue](https://github.com/EvanMulawski/FanControl.CorsairLink/issues) and provide a USB packet capture.

1. The minimum pump power is 50% (regardless of the requested power in Fan Control). As a result, Fan Control's automatic control-sensor pairing may fail for these devices and the sensor must be paired manually. As of v1.6.0, the default minimum pump power is 50% but users may override this by setting the `FANCONTROL_CORSAIRLINK_MIN_PUMP_DUTY` environment variable to the desired minimum pump power (a value between `0` and `100`).
1. The minimum pump power is 50% (regardless of the requested power in Fan Control). As a result, Fan Control's automatic control-sensor pairing may fail for these devices and the sensor must be paired manually. As of v1.6.0, the default minimum pump power is 50% but users may override this by setting the `FANCONTROL_CORSAIRLINK_MIN_PUMP_DUTY` [environment variable](#configuration) to the desired minimum pump power.

## Installation

Expand Down Expand Up @@ -171,14 +171,17 @@ To install the driver:

This plugin reads the following Windows environment variables:

| Name | Description | Values |
| ------------------------------------------------------------------------ | ---------------------------------------------------- | ------------------------------------------- |
| `FANCONTROL_CORSAIRLINK_DEBUG_LOGGING_ENABLED` | Enables debug logging to the `CorsairLink.log` file. | `1` = enabled, `0` = disabled |
| `FANCONTROL_CORSAIRLINK_DIRECT_LIGHTING_DEFAULT_BRIGHTNESS` <sup>1</sup> | Sets the LED brightness on supported models. | percent, e.g. `50` |
| `FANCONTROL_CORSAIRLINK_DIRECT_LIGHTING_DEFAULT_RGB` <sup>1</sup> | Sets the LED color on supported models. | RGB color in `R,G,B` format, e.g. `0,255,0` |
| `FANCONTROL_CORSAIRLINK_ERROR_NOTIFICATIONS_DISABLED` | Disables critical error notifications. | `1` = disabled, `0` = enabled |

1. Supported models: Hydro Platinum (v1.6.0-beta.8+)
| Name | Description | Values |
| ------------------------------------------------------------------------- | -------------------------------------------------------------- | ------------------------------------------- |
| `FANCONTROL_CORSAIRLINK_DEBUG_LOGGING_ENABLED` | Enables debug logging to the `CorsairLink.log` file. | `1` = enabled, `0` = disabled |
| `FANCONTROL_CORSAIRLINK_DIRECT_LIGHTING_DEFAULT_BRIGHTNESS` <sup>1</sup> | Sets the LED brightness on supported models. | percent, e.g. `50` |
| `FANCONTROL_CORSAIRLINK_DIRECT_LIGHTING_DEFAULT_RGB` <sup>1</sup> | Sets the LED color on supported models. | RGB color in `R,G,B` format, e.g. `0,255,0` |
| `FANCONTROL_CORSAIRLINK_ERROR_NOTIFICATIONS_DISABLED` | Disables critical error notifications. | `1` = disabled, `0` = enabled |
| `FANCONTROL_CORSAIRLINK_HYDRO_ASETEK_PRO_SAFETY_PROFILE_OVERRIDE_ENABLED` | Overrides the pump safety profile on Hydro Asetek Pro devices. | `1` = override, `0` = do not override |
| `FANCONTROL_CORSAIRLINK_MIN_PUMP_DUTY` <sup>2</sup> | Sets the minimum pump power on supported models. | percent, e.g. `50` |

1. Supported models: Hydro Platinum (v1.6.0+)
2. Supported models: iCUE LINK, Commander CORE (v1.6.0+)

## Interoperability

Expand Down

0 comments on commit f5452bf

Please sign in to comment.