Skip to content

Commit

Permalink
to ver 1.3.7a
Browse files Browse the repository at this point in the history
  • Loading branch information
Tanja committed Nov 17, 2017
1 parent 0264e46 commit cc33383
Show file tree
Hide file tree
Showing 3 changed files with 134 additions and 22 deletions.
5 changes: 5 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,11 @@ WARNING! Excavator supports overclocking. Use overclocking at your own risk. OVE

# Changelog

v1.3.7a
- bug fixes & improvements
- fixed high CPU loads
- support for GTX 1070 Ti and GTX 970

v1.3.6a
- cryptonight bug fixes & improvements

Expand Down
127 changes: 117 additions & 10 deletions api/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Excavator API
# Excavator API Version 0.0.2

**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!**

Expand Down Expand Up @@ -63,6 +63,7 @@ Method | Description
-------|------------
[algorithm\.add](#algorithm-add) | Adds new algorithm.
[algorithm\.remove](#algorithm-remove) | Removes algorithm.
[algorithm\.clear](#algorithm-clear) | Removes all algorithms.
[algorithm\.list](#algorithm-list) | Lists all algorithms.
[algorithm\.print\.speeds](#algorithm-print-speeds) | Prints speed of all algorithms.

Expand All @@ -71,10 +72,13 @@ Method | Description
Method | Description
-------|------------
[worker\.add](#worker-add) | Adds new worker.
[workers\.add](#workers-add) | Adds multiple workers.
[worker\.free](#worker-free) | Frees worker.
[workers\.free](#workers-free) | Frees multiple workers.
[worker\.reset](#worker-reset) | Resets worker's speed.
[worker\.print\.speed](#worker-speed)| Prints speed of a worker.


**Miscellaneous methods**

Method | Description
Expand Down Expand Up @@ -396,6 +400,7 @@ Example response:
```



# <a name="algorithm-remove"></a> algorithm.remove

Removes algorithm. This method also clears all linked workers. Call this method when connection to remote pool is not needed anymore.
Expand All @@ -419,6 +424,26 @@ Example response:
}
```

# <a name="algorithm-clear"></a> algorithm.clear

Removes all algorithms. See [algorithm\.remove](#algorithm-remove).

This method does not take in any parameter.

This method returns no response fields. If error occured, field `error` is not `null` and contains error message of type `string`.

Example usage:
```
{"id":1,"method":"algorithm.clear","params":[]}
```

Example response:
```
{
"id":1,
"error":null
}
```

# <a name="algorithm-list"></a> algorithm.list

Expand Down Expand Up @@ -573,6 +598,45 @@ Example response:
```


# <a name="workers-add"></a> workers.add

Creates multiple new workers. See [worker\.add](#worker-add).

Command parameter # | Type | Description
-------|---------|---------
1 | string | "alg-" + Algorithm ID.
2 | string | Device ID.
3+ | string | _OPTIONAL_ Additional parameters. See details of supported algorithms for [NVIDIA](https://github.com/nicehash/excavator/tree/master/nvidia) and [AMD](https://github.com/nicehash/excavator/tree/master/amd).

This method returns array of [worker\.add](#worker-add) responses.


Example usage:
```
{"id":1,"method":"workers.add","params":["alg-0","0","alg-0","1"]}
```

Example response:
```
{
"id":1,
"status":
[
{
"worker_id":0,
"error":null
}
,
{
"worker_id":1,
"error":null
}
]
}
```



# <a name="worker-free"></a> worker.free

Unlinks device from algorithm for provided worker. Worker thread with CUDA context or OpenCL thread stays alive and is ready to be
Expand All @@ -597,7 +661,34 @@ Example response:
}
```

# <a name="workers-free"></a> workers.free

Free multiple workers. See [worker\.free](#worker-free).

Command parameter # | Type | Description
-------|---------|---------
1 | String | Worker ID.
2+ | String | _OPTIONAL_ Worker ID.

This method returns array of [worker\.free](#worker-free) responses.

Example usage:
```
{"id":1,"method":"workers.free","params":["0","1","2"]}
```

Example response:
```
{
"id":1,
"status":
[
{ "error":null },
{ "error":null },
{ "error":null }
]
}
```

# <a name="worker-reset"></a> worker.reset

Expand Down Expand Up @@ -644,7 +735,6 @@ Example response:
}
```


# <a name="info"></a> info

Returns basic information about Excavator.
Expand All @@ -658,6 +748,10 @@ Response field | Type | Description
`build_time` | string | Build time.
`build_number` | int | Build number.
`uptime` | long | Uptime in milliseconds.
`cpu_load` | double | CPU load in percentage.
`cpu_usage` | double | CPU usage in percentage.
`ram_load` | double | Used memory in percentage.
`ram_usage` | double | Used memory in MB.

Example usage:
```
Expand All @@ -666,14 +760,18 @@ Example usage:

Example response:
```
{
"version":"1.2.1a",
"build_platform":"Windows",
"build_time":"2017-05-18 13:39:44",
"build_number":6,
"uptime":21594,
"id":1,
"error":null
{
"version": "1.3.7a_nvidia",
"build_platform": "Windows",
"build_time": "2017-11-17 13:26:36",
"build_number": 3456,
"uptime": 75063,
"cpu_load": 3.0168410822665095,
"cpu_usage": 0,
"ram_load": 42,
"ram_usage": 167.91796875,
"id": 1,
"error": null
}
```

Expand Down Expand Up @@ -721,3 +819,12 @@ Example response:
"error":null
}
```

# Changelog

* v0.0.2 (2017-11-07)
- Added [algorithm\.clear](#algorithm-clear), [workers\.free](#workers-free) and [workers\.add](#workers-add) methods.


* v0.0.1 (2017-11-04)
- Initial version.
24 changes: 12 additions & 12 deletions nvidia/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ Parameter # or name | Range | Explanation

If no parameters are provided, device specific defaults are used. If provided parameter is '0' then device specific default value is used.

**WARNING: Pascal is tuned for next cards: 1080 Ti, 1080, 1070, 1060 6GB, 1060 3GB, 1050 Ti, 1050, 1030, P104-100 and P106-100. You may reach higher speeds by experimenting with parameters when using a different card.**
**WARNING: Pascal is tuned for next cards: 1080 Ti, 1080, 1070 Ti, 1070, 1060 6GB, 1060 3GB, 1050 Ti, 1050, 1030, 970, P104-100 and P106-100. You may reach higher speeds by experimenting with parameters when using a different card.**

# <a name="decred"></a> decred

Expand All @@ -69,7 +69,7 @@ Parameter # or name | Range | Explanation

If no parameters are provided, device specific defaults are used. If provided parameter is '0' then device specific default value is used.

**WARNING: Decred is tuned for next cards: 1080 Ti, 1080, 1070, 1060 6GB, 1060 3GB, 1050 Ti, 1050, 1030, P104-100 and P106-100. You may reach higher speeds by experimenting with parameters when using a different card.**
**WARNING: Decred is tuned for next cards: 1080 Ti, 1080, 1070 Ti, 1070, 1060 6GB, 1060 3GB, 1050 Ti, 1050, 1030, 970, P104-100 and P106-100. You may reach higher speeds by experimenting with parameters when using a different card.**

# <a name="sia"></a> sia

Expand All @@ -81,7 +81,7 @@ Parameter # or name | Range | Explanation

If no parameters are provided, device specific defaults are used. If provided parameter is '0' then device specific default value is used.

**WARNING: Sia is tuned for next cards: 1080 Ti, 1080, 1070, 1060 6GB, 1060 3GB, 1050 Ti, 1050, 1030, P104-100 and P106-100. You may reach higher speeds by experimenting with parameters when using a different card.**
**WARNING: Sia is tuned for next cards: 1080 Ti, 1080, 1070 Ti, 1070, 1060 6GB, 1060 3GB, 1050 Ti, 1050, 1030, 970, P104-100 and P106-100. You may reach higher speeds by experimenting with parameters when using a different card.**


# <a name="lbry"></a> lbry
Expand All @@ -94,7 +94,7 @@ Parameter # or name | Range | Explanation

If no parameters are provided, device specific defaults are used. If provided parameter is '0' then device specific default value is used.

**WARNING: Lbry is tuned for next cards: 1080 Ti, 1080, 1070, 1060 6GB, 1060 3GB, 1050 Ti, 1050, 1030, P104-100 and P106-100. You may reach higher speeds by experimenting with parameters when using a different card.**
**WARNING: Lbry is tuned for next cards: 1080 Ti, 1080, 1070 Ti, 1070, 1060 6GB, 1060 3GB, 1050 Ti, 1050, 1030, 970, P104-100 and P106-100. You may reach higher speeds by experimenting with parameters when using a different card.**


# <a name="blake2s"></a> blake2s
Expand All @@ -107,7 +107,7 @@ Parameter # or name | Range | Explanation

If no parameters are provided, device specific defaults are used. If provided parameter is '0' then device specific default value is used.

**WARNING: Blake2s is tuned for next cards: 1080 Ti, 1080, 1070, 1060 6GB, 1060 3GB, 1050 Ti, 1050, 1030, P104-100 and P106-100. You may reach higher speeds by experimenting with parameters when using a different card.**
**WARNING: Blake2s is tuned for next cards: 1080 Ti, 1080, 1070 Ti, 1070, 1060 6GB, 1060 3GB, 1050 Ti, 1050, 1030, 970, P104-100 and P106-100. You may reach higher speeds by experimenting with parameters when using a different card.**

# <a name="daggerhashimoto"></a> daggerhashimoto

Expand All @@ -120,7 +120,7 @@ Parameter # or name | Range | Explanation

If no parameters are provided, device specific defaults are used. If provided parameter is '0' then device specific default value is used.

**WARNING: Daggerhashimoto is tuned for next cards: 1080 Ti, 1080, 1070, 1060 6GB, 1060 3GB, 1050 Ti, P104-100 and P106-100. You may reach higher speeds by experimenting with parameters when using a different card.**
**WARNING: Daggerhashimoto is tuned for next cards: 1080 Ti, 1080, 1070 Ti, 1070, 1060 6GB, 1060 3GB, 1050 Ti, 970, P104-100 and P106-100. You may reach higher speeds by experimenting with parameters when using a different card.**

NOTE1: If you use Windows 10 and your speed is very low, make sure you use Windows version 1607 or higher and latest NVIDIA drivers. When you use Maxwell cards for mining, also make sure you turn on `Optimize for compute performance` and set some value for `DSR-Factors` in NVIDIA control panel.

Expand All @@ -138,7 +138,7 @@ Parameter # or name | Range | Explanation

If no parameters are provided, device specific defaults are used. If provided parameter is '0' then device specific default value is used.

**WARNING: Lyra2REv2 is tuned for next cards: 1080 Ti, 1080, 1070, 1060 6GB, 1060 3GB, 1050 Ti, 1050, 1030, P104-100 and P106-100. You may reach higher speeds by experimenting with parameters when using a different card.**
**WARNING: Lyra2REv2 is tuned for next cards: 1080 Ti, 1080, 1070 Ti, 1070, 1060 6GB, 1060 3GB, 1050 Ti, 1050, 1030, 970, P104-100 and P106-100. You may reach higher speeds by experimenting with parameters when using a different card.**


# <a name="daggerhashimoto_decred"></a> daggerhashimoto_decred
Expand All @@ -155,7 +155,7 @@ Parameter # or name | Range | Explanation

If no parameters are provided, device specific defaults are used. If provided parameter is '0' then device specific default value is used.

**WARNING: Daggerhashimoto_decred is tuned for next cards: 1080 Ti, 1080, 1070, 1060 6GB, 1060 3GB, 1050 Ti, P104-100 and P106-100. You may reach higher speeds by experimenting with parameters when using a different card.**
**WARNING: Daggerhashimoto_decred is tuned for next cards: 1080 Ti, 1080, 1070 Ti, 1070, 1060 6GB, 1060 3GB, 1050 Ti, 970, P104-100 and P106-100. You may reach higher speeds by experimenting with parameters when using a different card.**

NOTE1: Parameter P is used to select the most profitable default ratio values. If P is 0 the goal is to reach highest daggerhashimoto speed while retaining decent speed on decred. When P is 1 default ratio is set to reach highest combined speeds on both algorithms.

Expand All @@ -173,7 +173,7 @@ Parameter # or name | Range | Explanation

If no parameters are provided, device specific defaults are used. If provided parameter is '0' then device specific default value is used.

**WARNING: Daggerhashimoto_sia is tuned for next cards: 1080 Ti, 1080, 1070, 1060 6GB, 1060 3GB, 1050 Ti, P104-100 and P106-100. You may reach higher speeds by experimenting with parameters when using a different card.**
**WARNING: Daggerhashimoto_sia is tuned for next cards: 1080 Ti, 1080, 1070 Ti, 1070, 1060 6GB, 1060 3GB, 1050 Ti, 970, P104-100 and P106-100. You may reach higher speeds by experimenting with parameters when using a different card.**

NOTE1: Parameter P is used to select the most profitable default ratio values. If P is 0 the goal is to reach highest daggerhashimoto speed while retaining decent speed on sia. When P is 1 default ratio is set to reach highest combined speeds on both algorithms.

Expand All @@ -191,7 +191,7 @@ Parameter # or name | Range | Explanation

If no parameters are provided, device specific defaults are used. If provided parameter is '0' then device specific default value is used.

**WARNING: Daggerhashimoto_pascal is tuned for next cards: 1080 Ti, 1080, 1070 and P104-100. You may reach higher speeds by experimenting with parameters when using a different card.**
**WARNING: Daggerhashimoto_pascal is tuned for next cards: 1080 Ti, 1080, 1070 Ti, 1070 and P104-100. You may reach higher speeds by experimenting with parameters when using a different card.**

NOTE1: Parameter P is used to select the most profitable default ratio values. If P is 0 the goal is to reach highest daggerhashimoto speed while retaining decent speed on pascal. When P is 1 default ratio is set to reach highest combined speeds on both algorithms.

Expand All @@ -204,7 +204,7 @@ Parameter # or name | Range | Explanation

If no parameters are provided or '0' is specified, the device specific default values will be used.

**WARNING: This algorithm is optimized for the following cards: 1080 Ti, 1080, 1070, and 1060 6GB.**
**WARNING: This algorithm is optimized for the following cards: 1080 Ti, 1080, 1070 Ti, 1070, 1060 6GB and 970.**

# <a name="keccak"></a> keccak

Expand All @@ -216,4 +216,4 @@ Parameter # or name | Range | Explanation

If no parameters are provided, device specific defaults are used. If provided parameter is '0' then device specific default value is used.

**WARNING: Keccak is tuned for next cards: 1080 Ti, 1080, 1070, 1060 6GB, 1060 3GB, 1050 Ti, 1050, 1030, P104-100 and P106-100. You may reach higher speeds by experimenting with parameters when using a different card.**
**WARNING: Keccak is tuned for next cards: 1080 Ti, 1080, 1070 Ti, 1070, 1060 6GB, 1060 3GB, 1050 Ti, 1050, 1030, 970, P104-100 and P106-100. You may reach higher speeds by experimenting with parameters when using a different card.**

0 comments on commit cc33383

Please sign in to comment.