Skip to content
This repository has been archived by the owner on May 27, 2020. It is now read-only.

Commit

Permalink
Update API docs
Browse files Browse the repository at this point in the history
  • Loading branch information
ckolivas committed Jun 12, 2015
1 parent 2df0923 commit 81be63d
Showing 1 changed file with 5 additions and 11 deletions.
16 changes: 5 additions & 11 deletions API-README
Original file line number Diff line number Diff line change
Expand Up @@ -157,10 +157,6 @@ The list of requests - a (*) means it requires privileged access - and replies:
Device Code=ICA , <- spaced list of compiled
device drivers
OS=Linux/Apple/..., <- operating System
Failover-Only=true/false, <- failover-only setting
ScanTime=N, <- --scan-time setting
Queue=N, <- --queue setting
Expiry=N| <- --expiry setting

summary SUMMARY The status summary of the miner
e.g. Elapsed=NNN,Found Blocks=N,Getworks=N,...|
Expand Down Expand Up @@ -316,10 +312,6 @@ The list of requests - a (*) means it requires privileged access - and replies:
check|cmd CHECK Exists=Y/N, <- 'cmd' exists in this version
Access=Y/N| <- you have access to use 'cmd'

failover-only|true/false (*)
none There is no reply section just the STATUS section
stating what failover-only was set to

coin COIN Coin mining information:
Hash Method=sha256/scrypt,
Current Block Time=N.N, <- 0 means none
Expand Down Expand Up @@ -348,9 +340,8 @@ The list of requests - a (*) means it requires privileged access - and replies:
setconfig|name,N (*)
none There is no reply section just the STATUS section
stating the results of setting 'name' to N
The valid values for name are currently:
queue, scantime, expiry
N is an integer in the range 0 to 9999
No values are supported any more and only a
deprecated message will be returned.

usbstats USBSTATS Stats of all LIBUSB mining devices except ztex
e.g. Name=MMQ,ID=0,Stat=SendWork,Count=99,...|
Expand Down Expand Up @@ -526,6 +517,9 @@ API V3.6 (cgminer v4.9.2)

Modified API commands:
'pools' - add 'Bad Work'
'setconfig' - expire, scantime and queue have all been deprecated and will
only return a deprecated message.
'failover-only' - deprecated, a deprecated message will be returned.

---------
API V3.5 (cgminer v4.7.0)
Expand Down

0 comments on commit 81be63d

Please sign in to comment.