Skip to content

Commit c027682

Browse files
authored
Merge pull request #8 from cgomesu/doc
Update documentation per #7
2 parents f193513 + 85acbda commit c027682

File tree

1 file changed

+11
-4
lines changed

1 file changed

+11
-4
lines changed

README.md

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -25,8 +25,8 @@ The controller was developed with **Armbian OS** but you should be able to run i
2525
- 12V (.08A-.2A) generic fan (**do not** try to use more than **200mA**)
2626

2727
And software:
28-
- Kernel: Linux 4.4.231-rk3399
29-
- OS: Armbian Buster (20.08.9) stable
28+
- Kernel: Linux 4.4.213-rk3399
29+
- OS: Armbian Buster (21.08.8) stable
3030
- GNU bash v5.0.3
3131
- bc v1.07.1
3232

@@ -80,15 +80,17 @@ Usage:
8080
-s int The MAX SIZE of the TEMPERATURE ARRAY. Interval between data points is set by -l. Default (store last 1min data): 6.
8181
-t int Lowest TEMPERATURE threshold (in Celsius). Lower temps set the fan speed to min. Default: 25
8282
-T int Highest TEMPERATURE threshold (in Celsius). Higher temps set the fan speed to max. Default: 75
83+
-u int Fan-off TEMPERATURE threshold (in Celsius). Shuts off fan under the specified temperature. Default: 0
84+
-U int Fan-on TEMPERATURE threshold (in Celsius). Turn on fan control above the specified temperature. Default: 1
8385
8486
If no options are provided, the script will run with default values.
8587
Defaults have been tested and optimized for the following hardware:
8688
- NanoPi-M4 v2
8789
- M4 SATA hat
8890
- Fan 12V (.08A and .2A)
8991
And software:
90-
- Kernel: Linux 4.4.231-rk3399
91-
- OS: Armbian Buster (20.08.9) stable
92+
- Kernel: Linux 4.4.213-rk3399
93+
- OS: Armbian Buster (21.08.8) stable
9294
- GNU bash v5.0.3
9395
- bc v1.07.1
9496
@@ -121,6 +123,11 @@ This is free. There is NO WARRANTY. Use at your own risk.
121123
./pwm-fan.sh -F 10
122124
```
123125

126+
- When using args `-u` and `-U` (introduced by [@araynard](https://github.com/araynard) via [#7](https://github.com/cgomesu/nanopim4-satahat-fan/pull/7)), it is recommended to leave a difference of at least 5°C between them. In most cases, `-u` can be set to a value slightly higher than the idle temperature *with* the fan, whereas `-U` can be set to a value slightly higher than the idle temperature *without* the fan.
127+
```
128+
./pwm-fan.sh -u 45 -U 55
129+
```
130+
124131

125132
# Run in the background
126133
If you're running options different than the default values, first edit the `pwm-fan.service` file to include those options into the `ExecStart=` command execution.

0 commit comments

Comments
 (0)