coptonixrs232i2c

README

coptonix-rs232-i2c

Documentation

Index

• Constants
• Variables
• func DefaultMode() serial.Mode
• func OpenSerialPort(portName string, mode *serial.Mode, readTimeout time.Duration) (serial.Port, error)
• type Dev
  • func New(port serial.Port, delay time.Duration) *Dev
  • func (dev *Dev) CheckSlaveAddress(addr uint8) (bool, error)
  • func (dev *Dev) Close() error
  • func (dev *Dev) GetSCLFrequency() (uint32, error)
  • func (dev *Dev) ReadI2C(addr uint8, bytesToRead uint8) ([]uint8, bool, error)
  • func (dev *Dev) ScanI2C() ([]uint8, error)
  • func (dev *Dev) SetSCLFrequency(freq uint32) (uint32, error)
  • func (dev *Dev) WriteI2C(addr uint8, data []uint8) (bool, error)

Constants

const (
	DefaultReadTimeout = 5 * time.Second
	DefaultDelay       = 10 * time.Millisecond
)

Variables

var (
	ErrInvalidChecksum  = fmt.Errorf("invalid checksum")
	ErrChecksumMismatch = fmt.Errorf("checksum mismatch")
)

var (
	ErrInvalidResponse   = fmt.Errorf("invalid response")
	ErrInterruptDetected = fmt.Errorf("interrupt detected")
	ErrChecksumError     = fmt.Errorf("checksum error")
	ErrUnknownCommand    = fmt.Errorf("unknown command")
	ErrCommandMismatch   = fmt.Errorf("command mismatch")
)

Functions

func DefaultMode

func DefaultMode() serial.Mode

func OpenSerialPort

func OpenSerialPort(portName string, mode *serial.Mode, readTimeout time.Duration) (serial.Port, error)

Types

type Dev

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

func New

func New(port serial.Port, delay time.Duration) *Dev

func (*Dev) CheckSlaveAddress

func (dev *Dev) CheckSlaveAddress(addr uint8) (bool, error)

func (*Dev) Close

func (dev *Dev) Close() error

func (*Dev) GetSCLFrequency

func (dev *Dev) GetSCLFrequency() (uint32, error)

func (*Dev) ReadI2C

func (dev *Dev) ReadI2C(addr uint8, bytesToRead uint8) ([]uint8, bool, error)

func (*Dev) ScanI2C

func (dev *Dev) ScanI2C() ([]uint8, error)

func (*Dev) SetSCLFrequency

func (dev *Dev) SetSCLFrequency(freq uint32) (uint32, error)

func (*Dev) WriteI2C

func (dev *Dev) WriteI2C(addr uint8, data []uint8) (bool, error)