|
| 1 | +This is T-Rex NVIDIA GPU miner. |
| 2 | + |
| 3 | +We hope you enjoy our miner. |
| 4 | +We promise to do our best to make it as fast as possible. |
| 5 | + |
| 6 | +However, in order to maximise the hashrate our software utilises all |
| 7 | +available GPU resources, so it is important that you review your overclock |
| 8 | +settings before you start mining. Our general recommendation is to start |
| 9 | +from GPU stock settings (no overclock, default power limit), and then after |
| 10 | +making sure it is stable, slowly increase your overclock to find the |
| 11 | +"sweet spot" where the miner performs at its best and still does not crash. |
| 12 | + |
| 13 | + |
| 14 | +Usage of command line options |
| 15 | +Options: |
| 16 | + -a, --algo Specify the hash algorithm to use. |
| 17 | + balloon |
| 18 | + bcd |
| 19 | + bitcore |
| 20 | + c11 |
| 21 | + hmq1725 |
| 22 | + hsr |
| 23 | + lyra2z |
| 24 | + phi |
| 25 | + polytimos |
| 26 | + renesis |
| 27 | + sha256t |
| 28 | + skunk |
| 29 | + sonoa |
| 30 | + timetravel |
| 31 | + tribus |
| 32 | + x16r |
| 33 | + x16s |
| 34 | + x17 |
| 35 | + x22i |
| 36 | + -d, --devices Comma separated list of CUDA devices to use. |
| 37 | + Device IDs start counting from 0. |
| 38 | + -i, --intensity GPU intensity 8-25 (default: auto). |
| 39 | + -o, --url URL of mining server. |
| 40 | + -u, --user Username for mining server. |
| 41 | + -p, --pass Password for mining server. |
| 42 | + -r, --retries Number of times to retry if a network call fails. |
| 43 | + -R, --retry-pause Pause in seconds between retries. |
| 44 | + -T, --timeout Network timeout, in seconds (default: 180) |
| 45 | + --time-limit Miner shutdown interval in seconds. (default: 0 - disabled) |
| 46 | + --temperature-limit GPU shutdown temperature. (default: 0 - disabled) |
| 47 | + --temperature-start GPU temperature to enable card after disable. (default: 0 - disabled) |
| 48 | + |
| 49 | + -b, --api-bind-telnet IP:port for the miner API via telnet (default: 0.0.0.0:4068). Set to 0 to disable. |
| 50 | + --api-bind-http IP:port for the miner API via HTTP (default: 0.0.0.0:4067). Set to 0 to disable. |
| 51 | + -J --json-response Telnet API server will make json responses. |
| 52 | + |
| 53 | + -N, --hashrate-avr Sliding window length in seconds used to compute average hashrate (default: 30). |
| 54 | + --gpu-report-interval GPU stats report frequency. (default: 5. every 5th share) |
| 55 | + -q, --quiet Quiet mode. No GPU stats at all. |
| 56 | + --no-color Disable color output for console. |
| 57 | + -B, --benchmark Benchmark mode. |
| 58 | + -P, --protocol-dump User protocol logging. |
| 59 | + -c, --config Load a JSON-format configuration file. |
| 60 | + -l, --log-path Full path of the log file. |
| 61 | + --cpu-priority Set process priority (default: 2) 0 idle, 2 normal to 5 highest. |
| 62 | + |
| 63 | + --back-to-main-pool-sec Forces miner to switch back to main pool in case working with failover pool. |
| 64 | + Parameter is set in seconds. (default: 600) |
| 65 | + --exit-on-cuda-error Forces miner to immediately exit on CUDA error. |
| 66 | + --exit-on-connection-lost Forces miner to immediately exit on connection lost. |
| 67 | + --reconnect-on-fail-shares Forces miner to immediately reconnect to pool on N successively failed shares (default: 10). |
| 68 | + |
| 69 | + --version Display version information and exit. |
| 70 | + -h, --help Display this help text and exit. |
| 71 | + |
| 72 | +=========================================== JSON CONFIG USAGE ========================================== |
| 73 | + |
| 74 | +To start T-Rex with config file "config.txt" type in console: t-rex -c config.txt |
| 75 | + |
| 76 | +Use "config_example" file as a starting point to create your own config. |
| 77 | + |
| 78 | +============================================ HTTP API USAGE ============================================ |
| 79 | + |
| 80 | +For HTTP API there are a few handlers available. |
| 81 | + |
| 82 | +By default HTTP API server binds to 0.0.0.0:4067. It means that you can access your miner via both external and internal network interfaces. |
| 83 | +Common example of request structure: http://your_ip:your_port/handler_name |
| 84 | + |
| 85 | +==[ TREX ]== |
| 86 | + |
| 87 | +Handler "trex" is intended to show miner control monitoring page in your web browser. You can see miner stats realtime and also change miner parameters and config on the fly. Also here you will see updates in case it appears. |
| 88 | +To activate the handler navigate to http://127.0.0.1:4067/trex using a web browser. |
| 89 | + |
| 90 | +==[ CONFIG ]== |
| 91 | + |
| 92 | +Handler "config" is intended to change your config on HDD and also change some miner parameters on the fly. |
| 93 | +You can change multiple parameters with one request. GET and POST requests supported. |
| 94 | +If you use config (started miner like this: t-rex.exe -c config_file) then any action with handler "config" will be saved into selected config_file. |
| 95 | +You can use this handler for automatization purposes like changing config at runtime, shutting down the miner via API and then restarting it with new parameters applied. |
| 96 | + |
| 97 | +GET usage examples: |
| 98 | +1) http://127.0.0.1:4067/config?protocol-dump=true |
| 99 | +Will enable protocol dump on the fly and write it into config_file. |
| 100 | + |
| 101 | +2) http://127.0.0.1:4067/config?algo=x16r&devices=0,1&intensity=20,21 |
| 102 | +If you use config it will write the following config settings into it: |
| 103 | +algo=x16r |
| 104 | +devices=0,1 |
| 105 | +intensity=20,21 |
| 106 | + |
| 107 | +3) http://127.0.0.1:4067/config?algo=x16r&devices=0,1&intensity=20,21&config=test.conf |
| 108 | +Will save settings into the file "test.conf" which will be created in the folder where the miner resides. |
| 109 | +algo=x16r |
| 110 | +devices=0,1 |
| 111 | +intensity=20,21 |
| 112 | + |
| 113 | +4) http://127.0.0.1:4067/config?config=test.conf |
| 114 | +Will save your current miner settings into "test.conf" file. |
| 115 | + |
| 116 | +5) http://127.0.0.1:4067/config |
| 117 | +Will show you the current config state |
| 118 | + |
| 119 | +6) http://127.0.0.1:4067/config?hashrate_avr=10&temperature-limit=70&temperature-start=40 |
| 120 | +Will set following parameters on the fly: |
| 121 | +hashrate_avr=10 |
| 122 | +temperature-limit=70 |
| 123 | +temperature-start=40 |
| 124 | + |
| 125 | +POST usage examples: |
| 126 | +For POST requests you must use correct json object with parameters you want to change. |
| 127 | +http://127.0.0.1:4067/config |
| 128 | +POST payload: |
| 129 | +{ |
| 130 | +"hashrate_avr": 10, |
| 131 | +"temperature-limit": 70, |
| 132 | +"temperature-start": 40 |
| 133 | +} |
| 134 | +Parameters names and types in json are identical to config json you use. |
| 135 | + |
| 136 | + |
| 137 | +==[ SUMMARY ]== |
| 138 | + |
| 139 | +Handler "summary" is intended to show you all information about current mining process. |
| 140 | +To activate the handler navigate to http://127.0.0.1:4067/summary using a web browser. |
| 141 | + |
| 142 | +Response example with comments: |
| 143 | + |
| 144 | +{ |
| 145 | + "accepted_count": 6, ----- Number of accepted shares count. |
| 146 | + |
| 147 | + "active_pool": { ----- Information about the pool your miner is currently connected to. |
| 148 | + "difficulty": 5, ----- Current pool difficulty. |
| 149 | + "ping": 97, ----- Pool latency. |
| 150 | + "retries": 0, ----- Number of connection attempts in case of connection loss. |
| 151 | + "url": "stratum+tcp://...", ----- Pool connection string. |
| 152 | + "user": "..." ----- Usually your wallet address. |
| 153 | + }, |
| 154 | + |
| 155 | + "algorithm": "x16r", ----- Algorithm which was set in config. |
| 156 | + "api": "1.2", ----- HTTP API protocol version. |
| 157 | + "cuda": "9.10", ----- CUDA library version used. |
| 158 | + "description": "T-Rex NVIDIA GPU miner", |
| 159 | + "difficulty": 31968.245093004043, ----- Current network difficulty. |
| 160 | + "gpu_total": 1, ----- Total number of GPUs installed in your system. |
| 161 | + |
| 162 | + "gpus": [{ ----- List of all currently working GPUs in your system with its stats. |
| 163 | + "device_id": 0, ----- Internal device id, useful for devs. |
| 164 | + "fan_speed": 66, ----- Fan blades rotation speed in % of the max speed. |
| 165 | + "gpu_id": 0, ----- User defined device id in config. |
| 166 | + "hashrate": 4529054, ----- Average hashrate per N sec defined in config. |
| 167 | + "hashrate_day": 5023728, ----- Average hashrate per day. |
| 168 | + "hashrate_hour": 0, ----- Average hashrate per hour. |
| 169 | + "hashrate_minute": 4671930, ----- Average hashrate per minute. |
| 170 | + "intensity": 21.5, ----- User defined intensity. |
| 171 | + "name": "GeForce GTX 1050", ----- Current device name. |
| 172 | + "temperature": 80, ----- Current device temperature. |
| 173 | + "vendor": "Gigabyte" ----- Current device vendor. |
| 174 | + "disabled":true, ----- Device state. Might appear if device reached heat limit. (set by --temperature-limit) |
| 175 | + "disabled_at_temperature": 77 ----- Device temperature at disable. Might appear if device reached heat limit. |
| 176 | + }], |
| 177 | + |
| 178 | + "hashrate": 4529054, ----- Total average sum of hashrates for all active devices per N sec defined in config. |
| 179 | + "hashrate_day": 5023728, ----- Total average sum of hashrates for a day. |
| 180 | + "hashrate_hour": 0, ----- Total average sum of hashrates for an hour. |
| 181 | + "hashrate_minute": 4671930, ----- Total average sum of hashrates for a minute. |
| 182 | + "name": "t-rex", |
| 183 | + "os": "linux", |
| 184 | + "rejected_count": 0, ----- This is number of rejected shares count. |
| 185 | + "solved_count": 0, ----- This is number of found blocks. |
| 186 | + "ts": 1537095257, ----- Current time in sec from the beginning of the epoch. (ref: https://www.epochconverter.com) |
| 187 | + "uptime": 108, ----- Uptime in sec. This shows how long the miner has been running for. |
| 188 | + "version": "0.6.5" ----- Miner version. |
| 189 | +} |
| 190 | + |
| 191 | +==[ CONTROL ]== |
| 192 | + |
| 193 | +Handler "control" is needed for real time configuration of T-Rex miner. |
| 194 | +As of API 1.3 version there are following commands supported. |
| 195 | + |
| 196 | +--- shutdown --- |
| 197 | + |
| 198 | +To shutdown your miner with GET request type in the following into your browser address bar and hit Enter: |
| 199 | +http://127.0.0.1:4067/control?command=shutdown |
| 200 | + |
| 201 | +If you prefer POST set the request body to {"command": "shutdown"}. |
| 202 | + |
| 203 | + |
| 204 | +--- hashrate-avr --- |
| 205 | + |
| 206 | +To change sliding window size in real time with GET request type in the following into your browser address bar and hit Enter: |
| 207 | +http://127.0.0.1:4067/control?hashrate-avr=1 |
| 208 | +It will set sliding window of size 1 sec. |
| 209 | + |
| 210 | +If you prefer POST set the request body to {"hashrate-avr": 1}. |
| 211 | + |
| 212 | + |
| 213 | +--- gpu-report-interval --- |
| 214 | + |
| 215 | +To change frequency of GPUs reports appearance in log with GET request type in the following into your browser address bar and hit Enter: |
| 216 | +http://127.0.0.1:4067/control?gpu-report-interval=10 |
| 217 | +Now you will see GPUs stats every 10th share. |
| 218 | + |
| 219 | +If you prefer POST set the request body to {"gpu-report-interval": 10}. |
| 220 | + |
| 221 | +Btw, you can disable stats (enter quiet mode) by setting gpu-report-interval to 0. |
| 222 | + |
| 223 | + |
| 224 | +--- no-color --- |
| 225 | + |
| 226 | +To disable color output to console with GET request type in the following into your browser address bar and hit Enter: |
| 227 | +http://127.0.0.1:4067/control?no-color=true |
| 228 | +To enable: |
| 229 | +http://127.0.0.1:4067/control?no-color=false |
| 230 | + |
| 231 | +If you prefer POST set the request body to {"no-color": true}. |
| 232 | + |
| 233 | + |
| 234 | +--- protocol-dump --- |
| 235 | + |
| 236 | +To enable user protocol dump into console/log with GET request type in the following into your browser address bar and hit Enter: |
| 237 | +http://127.0.0.1:4067/control?protocol-dump=true |
| 238 | +To disable: |
| 239 | +http://127.0.0.1:4067/control?protocol-dump=false |
| 240 | + |
| 241 | +If you prefer POST set the request body to {"protocol-dump": true}. |
| 242 | + |
| 243 | + |
| 244 | +--- time-limit --- |
| 245 | + |
| 246 | +To set time limit in seconds for miner (it will shutdown after timeout) with GET request type in the following into your browser address bar and hit Enter: |
| 247 | +http://127.0.0.1:4067/control?time-limit=120 |
| 248 | +It will shutdown your miner 120 seconds after this request. |
| 249 | +To disable: |
| 250 | +http://127.0.0.1:4067/control?time-limit=0 |
| 251 | + |
| 252 | +If you prefer POST set the request body to {"time-limit": 120}. |
| 253 | + |
| 254 | +==[ FILE ]== |
| 255 | + |
| 256 | +You can create a file in directory with the miner. This may be useful for external monitoring utilities or scripts which can take commands from this file and do some sort of useful stuff like overclock or system reconfiguration. |
| 257 | + |
| 258 | +http://127.0.0.1:4067/file?name=test.txt&data=some sort of text data |
| 259 | + |
| 260 | +If you prefer POST set the request body to |
| 261 | +{ |
| 262 | +"name": "test.txt", |
| 263 | +"data": "some sort of text data" |
| 264 | +} |
0 commit comments