serialpacket

Documentation

Index

• Constants
• type Bus
  • func CreateProtocol(port io.ReadWriteCloser, key []byte) *Bus
  • func (s *Bus) CloseProtocol() error
  • func (s *Bus) GetDefaultDevice() *Device
  • func (s *Bus) GetDevice(address uint8) *Device
  • func (s *Bus) ProtocolHandler() error
  • func (s *Bus) SetUnsolicitedHandler(cb func(msgType MessageType, buf []byte))
• type Device
  • func (s *Device) Connect() ([]byte, error)
  • func (s *Device) ConnectForce(serial []byte) ([]byte, error)
  • func (s *Device) Disconnect()
  • func (s *Device) GetDeviceSerial() ([]byte, error)
  • func (s *Device) GetSystemTime() (uint64, error)
  • func (s *Device) SendCommand(cmd MessageType, payload []byte, timeout int) ([]byte, error)
  • func (s *Device) TestComm() error
• type Error
  • func (e Error) Error() string
• type MessageType

Constants

const (
	ErrorTimeout      = Error("Command Timeout")
	ErrorNack         = Error("Command rejected")
	ErrorSyncFailed   = Error("Invaild sync response")
	ErrorNotConnected = Error("Not connected")
)

const AddressDefault = 0xFF

Types

type Bus

type Bus struct {
	sync.Mutex
	// contains filtered or unexported fields
}

func CreateProtocol

func CreateProtocol(port io.ReadWriteCloser, key []byte) *Bus

func (*Bus) CloseProtocol

func (s *Bus) CloseProtocol() error

func (*Bus) GetDefaultDevice

func (s *Bus) GetDefaultDevice() *Device

func (*Bus) GetDevice

func (s *Bus) GetDevice(address uint8) *Device

func (*Bus) ProtocolHandler

func (s *Bus) ProtocolHandler() error

func (*Bus) SetUnsolicitedHandler

func (s *Bus) SetUnsolicitedHandler(cb func(msgType MessageType, buf []byte))

type Device

type Device struct {
	sync.Mutex

	Timeout int
	// contains filtered or unexported fields
}

func (*Device) Connect

func (s *Device) Connect() ([]byte, error)

func (*Device) ConnectForce

func (s *Device) ConnectForce(serial []byte) ([]byte, error)

func (*Device) Disconnect

func (s *Device) Disconnect()

func (*Device) GetDeviceSerial

func (s *Device) GetDeviceSerial() ([]byte, error)

func (*Device) GetSystemTime

func (s *Device) GetSystemTime() (uint64, error)

func (*Device) SendCommand

func (s *Device) SendCommand(cmd MessageType, payload []byte, timeout int) ([]byte, error)

func (*Device) TestComm

func (s *Device) TestComm() error

type Error

type Error string

func (Error) Error

func (e Error) Error() string

type MessageType

type MessageType byte