transport

Documentation

Overview

Package whatsminer provides a low-level API interface for Whatsminer ASICs. This package handles the core communication protocol, encryption, and token management.

Index

• func PKCS5UnPadding(src []byte) []byte
• type WhatsminerAPI
  • func (w *WhatsminerAPI) ExecCommand(accessToken *WhatsminerAccessToken, cmd string, ...) (map[string]any, error)
  • func (w *WhatsminerAPI) GetReadOnlyInfo(accessToken *WhatsminerAccessToken, cmd string, ...) (map[string]any, error)
• type WhatsminerAccessToken
  • func NewWhatsminerAccessToken(ipAddress string, port int, adminPassword string) (*WhatsminerAccessToken, error)
  • func (t *WhatsminerAccessToken) Close()
  • func (t *WhatsminerAccessToken) EnableWriteAccess(adminPassword string) error
  • func (t *WhatsminerAccessToken) HasWriteAccess() error

Functions

func PKCS5UnPadding

func PKCS5UnPadding(src []byte) []byte

PKCS5UnPadding removes PKCS5 padding from a byte slice.

Types

type WhatsminerAPI

type WhatsminerAPI struct{}

WhatsminerAPI represents a stateless class with only class methods for read/write API calls.

func (*WhatsminerAPI) ExecCommand

func (w *WhatsminerAPI) ExecCommand(accessToken *WhatsminerAccessToken, cmd string, additionalParams map[string]any) (map[string]any, error)

ExecCommand sends a WRITEABLE API command.

func (*WhatsminerAPI) GetReadOnlyInfo

func (w *WhatsminerAPI) GetReadOnlyInfo(accessToken *WhatsminerAccessToken, cmd string, additionalParams map[string]any) (map[string]any, error)

GetReadOnlyInfo sends a READ-ONLY API command.

type WhatsminerAccessToken

type WhatsminerAccessToken struct {
	Created        time.Time
	IPAddress      string
	Port           int
	AdminPassword  string
	Cipher         cipher.Block
	Sign           string
	OnRefreshError func(err error)
	// contains filtered or unexported fields
}

WhatsminerAccessToken represents a reusable token to access and/or control a single Whatsminer ASIC.

func NewWhatsminerAccessToken

func NewWhatsminerAccessToken(ipAddress string, port int, adminPassword string) (*WhatsminerAccessToken, error)

NewWhatsminerAccessToken creates a new instance of WhatsminerAccessToken.

func (*WhatsminerAccessToken) Close

func (t *WhatsminerAccessToken) Close()

Close stops the background token refresh goroutine.

func (*WhatsminerAccessToken) EnableWriteAccess

func (t *WhatsminerAccessToken) EnableWriteAccess(adminPassword string) error

EnableWriteAccess enables write access for the token and starts the background refresh.

func (*WhatsminerAccessToken) HasWriteAccess

func (t *WhatsminerAccessToken) HasWriteAccess() error

HasWriteAccess checks write access and refreshes the token if necessary.