CGMiner API for Go

Installation

# install the library:
go get github.com/crypt0train/go-cgminer-api

// Use in your .go code:
import (
    cgminer "github.com/crypt0train/go-cgminer-api"
)

API Documentation

I started to completely rewrite forked code.

At this moment fully tested commands: Version(), Summary(), Stats() You can use runCommand(command string, parameter string) to run any command, that you want. Version and Summary sections have the same structure over the all devices, but Stats - it is something like hell.

Cgminer/Bmminer - is a best example of very bad JSON api and very bad code at all(it even has sprintf buffer overflow in "check" for a years). When you try get stats from cgminer via api, for a first time you can't parse the answer, because it's not valid and some portion of response of version command is mixed to the answer. Yep, fix this, but json response still invalid, float and integer values some times are presented as strings, sometimes you got "" instead of null value.

Command "stats" returned different output for each device, that i have tested S9, D3, L3+, T9+, even R1-LTC router. I wrote test for all of this, you can find textures in testdata folder.

My API method Stats() will return generic structure, that have all fields from all devices. I've created helpers to find data that depends on model, see example below.

Test coverage now: 58.4% of statements

Quickstart

package main

import (
    cgminer "github.com/crypt0train/go-cgminer-api"
    "log"
)

func main() {
    miner := cgminer.NewCGMiner("localhost", 4028, 2)
	stats, err := miner.Stats()
	if err != nil {
		log.Println(err)
	}
    fmt.Printf("%s | GHS avg: %0.2f\n", stats.Type, stats.GhsAverage)
    // When you connected to Antminer S9
    statsS9, _ := stats.S9()
	// When you connected to Antminer D3
    statsD3, _ := stats.D3()
	// When you connected to Antminer L3+
    statsL3, _ := stats.L3()
	// When you connected to Antminer T9+
    statsT9, _ := stats.T9()
	
}