modbustools

Documentation

Index

• func Check(e error)
• func ConvertParity(parity int) string
• func SetupHandler(config SerialConfig) *modbus.RTUClientHandler
• type Client
• type SerialConfig
  • func SetupConfig(address string, baudRate int, dataBits int, stopBits int, parity string, ...) SerialConfig
  • func TypicalConfig() SerialConfig

Functions

func Check

func Check(e error)

Check : checks if the input error has a value to "panic" or ignores it if it's nil

func ConvertParity

func ConvertParity(parity int) string

ConvertParity : converts parity from a custom numeric id to the string ids used by relying module

func SetupHandler

func SetupHandler(config SerialConfig) *modbus.RTUClientHandler

SetupHandler : creates and returns a handler to use to read device information

Types

type Client

type Client modbus.Client

Client from modbus

type SerialConfig

type SerialConfig struct {
	// Serial port configuration.
	serial.Config
	IdleTimeout time.Duration
}

SerialConfig : struct object to store serial configuration

func SetupConfig

func SetupConfig(address string, baudRate int, dataBits int, stopBits int, parity string, timeout int64) SerialConfig

SetupConfig : creates and returns an object with the given configuration

func TypicalConfig

func TypicalConfig() SerialConfig

TypicalConfig : creates and returns a typical configuration object