command

Documentation

Overview

Package command provides communication patterns for Goodwe inverters using the Modbus protocol.

Index

• func Send(cmd Command, conn Conn) ([]byte, error)
• type AA55Command
  • func NewAA55(payload, responseType string) (*AA55Command, error)
  • func (cmd AA55Command) String() string
  • func (cmd AA55Command) ValidateResponse(p []byte) ([]byte, error)
• type Command
• type Conn
• type FailureCode
  • func (i FailureCode) String() string
• type ModbusCommand
  • func NewModbus(commandType ModbusCommandType, offset uint16, value uint16) *ModbusCommand
  • func (cmd ModbusCommand) String() string
  • func (cmd ModbusCommand) ValidateResponse(p []byte) ([]byte, error)
• type ModbusCommandType

Functions

func Send

func Send(cmd Command, conn Conn) ([]byte, error)

Send writes the command to the provided Writer, and reads and validates the response.

Types

type AA55Command

type AA55Command struct {
	// contains filtered or unexported fields
}

func NewAA55

func NewAA55(payload, responseType string) (*AA55Command, error)

func (AA55Command) String

func (cmd AA55Command) String() string

func (AA55Command) ValidateResponse

func (cmd AA55Command) ValidateResponse(p []byte) ([]byte, error)

type Command

type Command interface {
	String() string
	ValidateResponse([]byte) ([]byte, error)
}

type Conn

type Conn interface {
	io.ReadWriter
	SetDeadline(time.Time) error
}

type FailureCode

type FailureCode byte

const (
	FailureCodeIllegalFunction FailureCode = iota + 1
	FailureCodeIllegalDataAddress
	FailureCodeIllegalDataValue
	FailureCodeSlaveDeviceFailure
	FailureCodeAcknowledge
	FailureCodeSlaveDeviceBusy
	FailureCodeNegativeAcknowledgement
	FailureCodeMemoryParityError
	FailureCodeGatewayPathUnavailable
	FailureCodeGatewayTargetDeviceFailedToRespond
)

func (FailureCode) String

func (i FailureCode) String() string

type ModbusCommand

type ModbusCommand struct {
	// contains filtered or unexported fields
}

func NewModbus

func NewModbus(commandType ModbusCommandType, offset uint16, value uint16) *ModbusCommand

func (ModbusCommand) String

func (cmd ModbusCommand) String() string

func (ModbusCommand) ValidateResponse

func (cmd ModbusCommand) ValidateResponse(p []byte) ([]byte, error)

ValidateResponse validates the entire response and if valid returns the response body.

type ModbusCommandType

type ModbusCommandType byte

const (
	ModbusCommandTypeRead ModbusCommandType = 0x03
	// TODO: implement write commands.
	ModbusCommandTypeWrite      ModbusCommandType = 0x06
	ModbusCommandTypeWriteMulti ModbusCommandType = 0x10
)