Commit db6750934e887fea2bdc240e46b6845149fb4f39
2012-05-31T03:35:40
Merge pull request #206 from kanoi/api-readme API-README (removed from README)
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740
diff --git a/API-README b/API-README
new file mode 100644
index 0000000..706ffb0
--- /dev/null
+++ b/API-README
@@ -0,0 +1,447 @@
+
+This README contains details about the cgminer RPC API
+
+
+If you start cgminer with the "--api-listen" option, it will listen on a
+simple TCP/IP socket for single string API requests from the same machine
+running cgminer and reply with a string and then close the socket each time
+If you add the "--api-network" option, it will accept API requests from any
+network attached computer.
+
+You can only access the comands that reply with data in this mode.
+By default, you cannot access any privileged command that affects the miner -
+you will receive an access denied status message see --api-allow below.
+
+You can specify IP addresses/prefixes that are only allowed to access the API
+with the "--api-allow" option e.g. --api-allow W:192.168.0.1,10.0.0/24
+will allow 192.168.0.1 or any address matching 10.0.0.*, but nothing else
+IP addresses are automatically padded with extra '.0's as needed
+Without a /prefix is the same as specifying /32
+0/0 means all IP addresses.
+The 'W:' on the front gives that address/subnet privileged access to commands
+that modify cgminer.
+Without it those commands return an access denied status.
+Privileged access is checked in the order the IP addresses were supplied to
+"--api-allow"
+The first match determines the privilege level.
+Using the "--api-allow" option overides the "--api-network" option if they
+are both specified
+With "--api-allow", 127.0.0.1 is not by default given access unless specified
+
+The RPC API request can be either simple text or JSON.
+
+If the request is JSON (starts with '{'), it will reply with a JSON formatted
+response, otherwise it replies with text formatted as described further below.
+
+The JSON request format required is '{"command":"CMD","parameter":"PARAM"}'
+(though of course parameter is not required for all requests)
+where "CMD" is from the "Request" column below and "PARAM" would be e.g.
+the CPU/GPU number if required.
+
+An example request in both formats to set GPU 0 fan to 80%:
+ gpufan|0,80
+ {"command":"gpufan","parameter":"0,80"}
+
+The format of each reply (unless stated otherwise) is a STATUS section
+followed by an optional detail section
+
+From API version 1.7 onwards, reply strings in JSON and Text have the
+necessary escaping as required to avoid ambiguity - they didn't before 1.7
+For JSON the 2 characters '"' and '\' are escaped with a '\' before them
+For Text the 4 characters '|' ',' '=' and '\' are escaped the same way
+
+Only user entered information will contain characters that require being
+escaped, such as Pool URL, User and Password or the Config save filename,
+when they are returned in messages or as their values by the API
+
+For API version 1.4 and later:
+
+The STATUS section is:
+
+ STATUS=X,When=NNN,Code=N,Msg=string,Description=string|
+
+ STATUS=X Where X is one of:
+ W - Warning
+ I - Informational
+ S - Success
+ E - Error
+ F - Fatal (code bug)
+
+ When=NNN
+ Standard long time of request in seconds
+
+ Code=N
+ Each unique reply has a unigue Code (See api.c - #define MSG_NNNNNN)
+
+ Msg=string
+ Message matching the Code value N
+
+ Description=string
+ This defaults to the cgminer version but is the value of --api-description
+ if it was specified at runtime.
+
+For API version 1.9:
+
+The list of requests - a (*) means it requires privileged access - and replies are:
+
+ Request Reply Section Details
+ ------- ------------- -------
+ version VERSION CGMiner=cgminer version
+ API=API version
+
+ config CONFIG Some miner configuration information:
+ GPU Count=N, <- the number of GPUs
+ PGA Count=N, <- the number of PGAs
+ CPU Count=N, <- the number of CPUs
+ Pool Count=N, <- the number of Pools
+ ADL=X, <- Y or N if ADL is compiled in the code
+ ADL in use=X, <- Y or N if any GPU has ADL
+ Strategy=Name, <- the current pool strategy
+ Log Interval=N, <- log interval (--log N)
+ Device Code=GPU ICA | <- spaced list of compiled devices
+
+ summary SUMMARY The status summary of the miner
+ e.g. Elapsed=NNN,Found Blocks=N,Getworks=N,...|
+
+ pools POOLS The status of each pool
+ e.g. Pool=0,URL=http://pool.com:6311,Status=Alive,...|
+
+ devs DEVS Each available GPU, PGA and CPU with their details
+ e.g. GPU=0,Accepted=NN,MHS av=NNN,...,Intensity=D|
+ Last Share Time=NNN, <- standand long time in seconds
+ (or 0 if none) of last accepted share
+ Last Share Pool=N, <- pool number (or -1 if none)
+ Will not report PGAs if PGA mining is disabled
+ Will not report CPUs if CPU mining is disabled
+
+ gpu|N GPU The details of a single GPU number N in the same
+ format and details as for DEVS
+
+ pga|N PGA The details of a single PGA number N in the same
+ format and details as for DEVS
+ This is only available if PGA mining is enabled
+ Use 'pgacount' or 'config' first to see if there are any
+
+ cpu|N CPU The details of a single CPU number N in the same
+ format and details as for DEVS
+ This is only available if CPU mining is enabled
+ Use 'cpucount' or 'config' first to see if there are any
+
+ gpucount GPUS Count=N| <- the number of GPUs
+
+ pgacount PGAS Count=N| <- the number of PGAs
+ Always returns 0 if PGA mining is disabled
+
+ cpucount CPUS Count=N| <- the number of CPUs
+ Always returns 0 if CPU mining is disabled
+
+ switchpool|N (*)
+ none There is no reply section just the STATUS section
+ stating the results of switching pool N to the
+ highest priority (the pool is also enabled)
+ The Msg includes the pool URL
+
+ enablepool|N (*)
+ none There is no reply section just the STATUS section
+ stating the results of enabling pool N
+ The Msg includes the pool URL
+
+ addpool|URL,USR,PASS (*)
+ none There is no reply section just the STATUS section
+ stating the results of attempting to add pool N
+ The Msg includes the pool URL
+ Use '\\' to get a '\' and '\,' to include a comma
+ inside URL, USR or PASS
+
+ disablepool|N (*)
+ none There is no reply section just the STATUS section
+ stating the results of disabling pool N
+ The Msg includes the pool URL
+
+ removepool|N (*)
+ none There is no reply section just the STATUS section
+ stating the results of removing pool N
+ The Msg includes the pool URL
+ N.B. all details for the pool will be lost
+
+ gpuenable|N (*)
+ none There is no reply section just the STATUS section
+ stating the results of the enable request
+
+ gpudisable|N (*)
+ none There is no reply section just the STATUS section
+ stating the results of the disable request
+
+ gpurestart|N (*)
+ none There is no reply section just the STATUS section
+ stating the results of the restart request
+
+ gpuintensity|N,I (*)
+ none There is no reply section just the STATUS section
+ stating the results of setting GPU N intensity to I
+
+ gpumem|N,V (*)
+ none There is no reply section just the STATUS section
+ stating the results of setting GPU N memoryclock to V MHz
+
+ gpuengine|N,V (*)
+ none There is no reply section just the STATUS section
+ stating the results of setting GPU N clock to V MHz
+
+ gpufan|N,V (*)
+ none There is no reply section just the STATUS section
+ stating the results of setting GPU N fan speed to V%
+
+ gpuvddc|N,V (*)
+ none There is no reply section just the STATUS section
+ stating the results of setting GPU N vddc to V
+
+ save|filename (*)
+ none There is no reply section just the STATUS section
+ stating success or failure saving the cgminer config
+ to filename
+
+ quit (*) none There is no status section but just a single "BYE"
+ reply before cgminer quits
+
+ notify NOTIFY The last status and history count of each devices problem
+ This lists all devices including those not supported
+ by the 'devs' command
+ e.g. NOTIFY=0,Name=GPU,ID=0,Last Well=1332432290,...|
+
+ privileged (*)
+ none There is no reply section just the STATUS section
+ stating an error if you do not have privileged access
+ to the API and success if you do have privilege
+ The command doesn't change anything in cgminer
+
+ pgaenable|N (*)
+ none There is no reply section just the STATUS section
+ stating the results of the enable request
+ You cannot enable a PGA if it's status is not WELL
+ This is only available if PGA mining is enabled
+
+ pgadisable|N (*)
+ none There is no reply section just the STATUS section
+ stating the results of the disable request
+ This is only available if PGA mining is enabled
+
+ devdetails DEVDETAILS Each device with a list of their static details
+ This lists all devices including those not supported
+ by the 'devs' command
+ e.g. DEVDETAILS=0,Name=GPU,ID=0,Driver=opencl,...|
+
+ restart (*) none There is no status section but just a single "RESTART"
+ reply before cgminer restarts
+
+ stats STATS Each device or pool that has 1 or more getworks
+ with a list of stats regarding getwork times
+ The values returned by stats may change in future
+ versions thus would not normally be displayed
+ Device drivers are also able to add stats to the
+ end of the details returned
+
+When you enable, disable or restart a GPU or PGA, you will also get Thread messages
+in the cgminer status window
+
+When you switch to a different pool to the current one, you will get a
+'Switching to URL' message in the cgminer status windows
+
+Obviously, the JSON format is simply just the names as given before the '='
+with the values after the '='
+
+If you enable cgminer debug (-D or --debug) you will also get messages showing
+details of the requests received and the replies
+
+There are included 4 program examples for accessing the API:
+
+api-example.php - a php script to access the API
+ usAge: php api-example.php command
+ by default it sends a 'summary' request to the miner at 127.0.0.1:4028
+ If you specify a command it will send that request instead
+ You must modify the line "$socket = getsock('127.0.0.1', 4028);" at the
+ beginning of "function request($cmd)" to change where it looks for cgminer
+
+API.java/API.class
+ a java program to access the API (with source code)
+ usAge is: java API command address port
+ Any missing or blank parameters are replaced as if you entered:
+ java API summary 127.0.0.1 4028
+
+api-example.c - a 'C' program to access the API (with source code)
+ usAge: api-example [command [ip/host [port]]]
+ again, as above, missing or blank parameters are replaced as if you entered:
+ api-example summary 127.0.0.1 4028
+
+miner.php - an example web page to access the API
+ This includes buttons and inputs to attempt access to the privileged commands
+ Read the top of the file (miner.php) for details of how to tune the display
+ and also to use the option to display a multi-rig summary
+
+----------
+
+Feature Changelog for external applications using the API:
+
+
+API V1.10
+
+Added API commands:
+ 'stats'
+
+N.B. the 'stats' command can change at any time so any specific content
+present should not be relied upon.
+The data content is mainly used for debugging purposes or hidden options
+in cgminer and can change as development work requires
+
+Modified API commands:
+ 'pools' added "Last Share Time"
+
+----------
+
+API V1.9 (cgminer v2.4.0)
+
+Added API commands:
+ 'restart'
+
+Modified API commands:
+ 'notify' corrected invalid JSON
+
+----------
+
+API V1.8 (cgminer v2.3.5)
+
+Added API commands:
+ 'devdetails'
+
+Support for the ZTex FPGA was added
+
+----------
+
+API V1.7 (cgminer v2.3.4)
+
+Added API commands:
+ 'removepool'
+
+Modified API commands:
+ 'pools' added "User"
+
+From API version 1.7 onwards, reply strings in JSON and Text have the
+necessary escaping as required to avoid ambiguity
+For JSON the 2 characters '"' and '\' are escaped with a '\' before them
+For Text the 4 characters '|' ',' '=' and '\' are escaped the same way
+
+----------
+
+API V1.6 (cgminer v2.3.2)
+
+Added API commands:
+ 'pga'
+ 'pgaenable'
+ 'pgadisable'
+ 'pgacount'
+
+Modified API commands:
+ 'devs' now includes Icarus and Bitforce FPGA devices
+ 'notify' added "*" to the front of the name of all numeric error fields
+ 'config' correct "Log Interval" to use numeric (not text) type for JSON
+
+Support for Icarus and Bitforce FPGAs was added
+
+----------
+
+API V1.5 was not released
+
+----------
+
+API V1.4 (Kano's interim release of cgminer v2.3.1)
+
+Added API commands:
+ 'notify'
+
+Modified API commands:
+ 'config' added "Device Code" and "OS"
+
+Added "When" to the STATUS reply section of all commands
+
+----------
+
+API V1.3 (cgminer v2.3.1-2)
+
+Added API commands:
+ 'addpool'
+
+Modified API commands:
+ 'devs'/'gpu' added "Total MH" for each device
+ 'summary' added "Total MH"
+
+----------
+
+API V1.2 (cgminer v2.3.0)
+
+Added API commands:
+ 'enablepool'
+ 'disablepool'
+ 'privileged'
+
+Modified API commands:
+ 'config' added "Log Interval"
+
+Starting with API V1.2, any attempt to access a command that requires
+privileged security, from an IP address that does not have privileged
+security, will return an "Access denied" Error Status
+
+----------
+
+API V1.1 (cgminer v2.2.4)
+
+There were no changes to the API commands in cgminer v2.2.4,
+however support was added to cgminer for IP address restrictions
+with the --api-allow option
+
+----------
+
+API V1.1 (cgminer v2.2.2)
+
+Prior to V1.1, devs/gpu incorrectly reported GPU0 Intensity for all GPUs
+
+Modified API commands:
+ 'devs'/'gpu' added "Last Share Pool" and "Last Share Time" for each device
+
+----------
+
+API V1.0 (cgminer v2.2.0)
+
+Remove default CPU support
+
+Added API commands:
+ 'config'
+ 'gpucount'
+ 'cpucount'
+ 'switchpool'
+ 'gpuintensity'
+ 'gpumem'
+ 'gpuengine'
+ 'gpufan'
+ 'gpuvddc'
+ 'save'
+
+----------
+
+API V0.7 (cgminer v2.1.0)
+
+Initial release of the API in the main cgminer git
+
+Commands:
+ 'version'
+ 'devs'
+ 'pools'
+ 'summary'
+ 'gpuenable'
+ 'gpudisable'
+ 'gpurestart'
+ 'gpu'
+ 'cpu'
+ 'gpucount'
+ 'cpucount'
+ 'quit'
+
diff --git a/README b/README
index 9c445e8..af78af1 100644
--- a/README
+++ b/README
@@ -571,281 +571,7 @@ cgminer shuts down because of this.
RPC API
-If you start cgminer with the "--api-listen" option, it will listen on a
-simple TCP/IP socket for single string API requests from the same machine
-running cgminer and reply with a string and then close the socket each time
-If you add the "--api-network" option, it will accept API requests from any
-network attached computer.
-
-You can only access the comands that reply with data in this mode.
-By default, you cannot access any privileged command that affects the miner -
-you will receive an access denied status message see --api-allow below.
-
-You can specify IP addresses/prefixes that are only allowed to access the API
-with the "--api-allow" option e.g. --api-allow W:192.168.0.1,10.0.0/24
-will allow 192.168.0.1 or any address matching 10.0.0.*, but nothing else
-IP addresses are automatically padded with extra '.0's as needed
-Without a /prefix is the same as specifying /32
-0/0 means all IP addresses.
-The 'W:' on the front gives that address/subnet privileged access to commands
-that modify cgminer.
-Without it those commands return an access denied status.
-Privileged access is checked in the order the IP addresses were supplied to
-"--api-allow"
-The first match determines the privilege level.
-Using the "--api-allow" option overides the "--api-network" option if they
-are both specified
-With "--api-allow", 127.0.0.1 is not by default given access unless specified
-
-The RPC API request can be either simple text or JSON.
-
-If the request is JSON (starts with '{'), it will reply with a JSON formatted
-response, otherwise it replies with text formatted as described further below.
-
-The JSON request format required is '{"command":"CMD","parameter":"PARAM"}'
-(though of course parameter is not required for all requests)
-where "CMD" is from the "Request" column below and "PARAM" would be e.g.
-the CPU/GPU number if required.
-
-An example request in both formats to set GPU 0 fan to 80%:
- gpufan|0,80
- {"command":"gpufan","parameter":"0,80"}
-
-The format of each reply (unless stated otherwise) is a STATUS section
-followed by an optional detail section
-
-From API version 1.7 onwards, reply strings in JSON and Text have the
-necessary escaping as required to avoid ambiguity - they didn't before 1.7
-For JSON the 2 characters '"' and '\' are escaped with a '\' before them
-For Text the 4 characters '|' ',' '=' and '\' are escaped the same way
-
-Only user entered information will contain characters that require being
-escaped, such as Pool URL, User and Password or the Config save filename,
-when they are returned in messages or as their values by the API
-
-For API version 1.4 and later:
-
-The STATUS section is:
-
- STATUS=X,When=NNN,Code=N,Msg=string,Description=string|
-
- STATUS=X Where X is one of:
- W - Warning
- I - Informational
- S - Success
- E - Error
- F - Fatal (code bug)
-
- When=NNN
- Standard long time of request in seconds
-
- Code=N
- Each unique reply has a unigue Code (See api.c - #define MSG_NNNNNN)
-
- Msg=string
- Message matching the Code value N
-
- Description=string
- This defaults to the cgminer version but is the value of --api-description
- if it was specified at runtime.
-
-For API version 1.9:
-
-The list of requests - a (*) means it requires privileged access - and replies are:
-
- Request Reply Section Details
- ------- ------------- -------
- version VERSION CGMiner=cgminer version
- API=API version
-
- config CONFIG Some miner configuration information:
- GPU Count=N, <- the number of GPUs
- PGA Count=N, <- the number of PGAs
- CPU Count=N, <- the number of CPUs
- Pool Count=N, <- the number of Pools
- ADL=X, <- Y or N if ADL is compiled in the code
- ADL in use=X, <- Y or N if any GPU has ADL
- Strategy=Name, <- the current pool strategy
- Log Interval=N, <- log interval (--log N)
- Device Code=GPU ICA | <- spaced list of compiled devices
-
- summary SUMMARY The status summary of the miner
- e.g. Elapsed=NNN,Found Blocks=N,Getworks=N,...|
-
- pools POOLS The status of each pool
- e.g. Pool=0,URL=http://pool.com:6311,Status=Alive,...|
-
- devs DEVS Each available GPU, PGA and CPU with their details
- e.g. GPU=0,Accepted=NN,MHS av=NNN,...,Intensity=D|
- Last Share Time=NNN, <- standand long time in seconds
- (or 0 if none) of last accepted share
- Last Share Pool=N, <- pool number (or -1 if none)
- Will not report PGAs if PGA mining is disabled
- Will not report CPUs if CPU mining is disabled
-
- gpu|N GPU The details of a single GPU number N in the same
- format and details as for DEVS
-
- pga|N PGA The details of a single PGA number N in the same
- format and details as for DEVS
- This is only available if PGA mining is enabled
- Use 'pgacount' or 'config' first to see if there are any
-
- cpu|N CPU The details of a single CPU number N in the same
- format and details as for DEVS
- This is only available if CPU mining is enabled
- Use 'cpucount' or 'config' first to see if there are any
-
- gpucount GPUS Count=N| <- the number of GPUs
-
- pgacount PGAS Count=N| <- the number of PGAs
- Always returns 0 if PGA mining is disabled
-
- cpucount CPUS Count=N| <- the number of CPUs
- Always returns 0 if CPU mining is disabled
-
- switchpool|N (*)
- none There is no reply section just the STATUS section
- stating the results of switching pool N to the
- highest priority (the pool is also enabled)
- The Msg includes the pool URL
-
- enablepool|N (*)
- none There is no reply section just the STATUS section
- stating the results of enabling pool N
- The Msg includes the pool URL
-
- addpool|URL,USR,PASS (*)
- none There is no reply section just the STATUS section
- stating the results of attempting to add pool N
- The Msg includes the pool URL
- Use '\\' to get a '\' and '\,' to include a comma
- inside URL, USR or PASS
-
- disablepool|N (*)
- none There is no reply section just the STATUS section
- stating the results of disabling pool N
- The Msg includes the pool URL
-
- removepool|N (*)
- none There is no reply section just the STATUS section
- stating the results of removing pool N
- The Msg includes the pool URL
- N.B. all details for the pool will be lost
-
- gpuenable|N (*)
- none There is no reply section just the STATUS section
- stating the results of the enable request
-
- gpudisable|N (*)
- none There is no reply section just the STATUS section
- stating the results of the disable request
-
- gpurestart|N (*)
- none There is no reply section just the STATUS section
- stating the results of the restart request
-
- gpuintensity|N,I (*)
- none There is no reply section just the STATUS section
- stating the results of setting GPU N intensity to I
-
- gpumem|N,V (*)
- none There is no reply section just the STATUS section
- stating the results of setting GPU N memoryclock to V MHz
-
- gpuengine|N,V (*)
- none There is no reply section just the STATUS section
- stating the results of setting GPU N clock to V MHz
-
- gpufan|N,V (*)
- none There is no reply section just the STATUS section
- stating the results of setting GPU N fan speed to V%
-
- gpuvddc|N,V (*)
- none There is no reply section just the STATUS section
- stating the results of setting GPU N vddc to V
-
- save|filename (*)
- none There is no reply section just the STATUS section
- stating success or failure saving the cgminer config
- to filename
-
- quit (*) none There is no status section but just a single "BYE"
- reply before cgminer quits
-
- notify NOTIFY The last status and history count of each devices problem
- This lists all devices including those not supported
- by the 'devs' command
- e.g. NOTIFY=0,Name=GPU,ID=0,Last Well=1332432290,...|
-
- privileged (*)
- none There is no reply section just the STATUS section
- stating an error if you do not have privileged access
- to the API and success if you do have privilege
- The command doesn't change anything in cgminer
-
- pgaenable|N (*)
- none There is no reply section just the STATUS section
- stating the results of the enable request
- You cannot enable a PGA if it's status is not WELL
- This is only available if PGA mining is enabled
-
- pgadisable|N (*)
- none There is no reply section just the STATUS section
- stating the results of the disable request
- This is only available if PGA mining is enabled
-
- devdetails DEVDETAILS Each device with a list of their static details
- This lists all devices including those not supported
- by the 'devs' command
- e.g. DEVDETAILS=0,Name=GPU,ID=0,Driver=opencl,...|
-
- restart (*) none There is no status section but just a single "RESTART"
- reply before cgminer restarts
-
- stats STATS Each device or pool that has 1 or more getworks
- with a list of stats regarding getwork times
- The values returned by stats may change in future
- versions thus would not normally be displayed
- Device drivers are also able to add stats to the
- end of the details returned
-
-When you enable, disable or restart a GPU or PGA, you will also get Thread messages
-in the cgminer status window
-
-When you switch to a different pool to the current one, you will get a
-'Switching to URL' message in the cgminer status windows
-
-Obviously, the JSON format is simply just the names as given before the '='
-with the values after the '='
-
-If you enable cgminer debug (-D or --debug) you will also get messages showing
-details of the requests received and the replies
-
-There are included 4 program examples for accessing the API:
-
-api-example.php - a php script to access the API
- usAge: php api-example.php command
- by default it sends a 'summary' request to the miner at 127.0.0.1:4028
- If you specify a command it will send that request instead
- You must modify the line "$socket = getsock('127.0.0.1', 4028);" at the
- beginning of "function request($cmd)" to change where it looks for cgminer
-
-API.java/API.class
- a java program to access the API (with source code)
- usAge is: java API command address port
- Any missing or blank parameters are replaced as if you entered:
- java API summary 127.0.0.1 4028
-
-api-example.c - a 'C' program to access the API (with source code)
- usAge: api-example [command [ip/host [port]]]
- again, as above, missing or blank parameters are replaced as if you entered:
- api-example summary 127.0.0.1 4028
-
-miner.php - an example web page to access the API
- This includes buttons and inputs to attempt access to the privileged commands
- Read the top of the file (miner.php) for details of how to tune the display
- and also to use the option to display a multi-rig summary
+For RPC API details see the API-README file
---