Skip to content

Commit 101cebe

Browse files
authored
Update README.md
1 parent ee1cdf3 commit 101cebe

File tree

1 file changed

+25
-1
lines changed

1 file changed

+25
-1
lines changed

api/README.md

+25-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Excavator API Version 0.2.1
1+
# Excavator API Version 0.2.2
22

33
**WARNING! This document is not complete yet and is still being worked on. Also, during Excavator alpha versions, API may change so make sure you check this page always before updating to next alpha version!**
44

@@ -70,6 +70,7 @@ Method | Description
7070
[device\.set\.oc_reset](#device-set-oc-reset) | Resets overclocking profile.
7171
[device\.hwerr\.get](#device-hwerr-get) | Gets hardware error count.
7272
[device\.hwerr\.reset](#device-hwerr-reset) | Resets hardware error count.
73+
[device\.smartfan\.set\.advanced](#device-smartfan-set-advanced) | Set advanced properties for SmartFan algorithm.
7374

7475
**Algorithm managing methods**
7576

@@ -645,6 +646,25 @@ Example response:
645646
```
646647

647648

649+
# <a name="device-smartfan-set-advanced"></a> device.smartfan.set.advanced
650+
651+
Sets various constants/properties of SmartFan algorithm as explained below. Fan level is always from 0 to 100 (including). Call [devices\.get](#devices-get) or [device\.get](#device-get) to get current values (defaults).
652+
653+
Command parameter # | Type | Description
654+
-------|---------|---------
655+
1 | string | Device ID or Device UUID.
656+
2 | string | Starting fan level when mode 2 or 3 is used.
657+
3 | string | Override default min level.
658+
4 | string | Override default max level.
659+
5 | string | Decrease multi K constant.
660+
6 | string | Increase multi K constant.
661+
7 | string | Increase add n constant (when GPU target is used).
662+
8 | string | Increase add n constant (when VRAM target is used).
663+
664+
You have to provide **ALL** parameters or the method would not execute.
665+
666+
667+
648668
# <a name="algorithm-add"></a> algorithm.add
649669

650670
Adds new algorithm instance to the miner. Requests the remote pool to start sending work for the algorithm at hand.
@@ -1354,6 +1374,10 @@ Example response:
13541374

13551375
# Changelog
13561376

1377+
* v0.2.2 (excavator v1.6.3g)
1378+
- Added `device.smartfan.set.advanced`
1379+
- Many others... (docs not complete yet)
1380+
13571381
* v0.2.1 (excavator v1.6.1d)
13581382
- Added `cmdfile.commit`
13591383
- Added `restart`

0 commit comments

Comments
 (0)