serial

Documentation

Index

• type Serial
  • func NewSerial() *Serial
  • func (s *Serial) Close() error
  • func (s *Serial) Connect(params transport.TransportInterfaceParams) error
  • func (s *Serial) Connected() bool
  • func (s *Serial) Receive(timeoutSeconds int) ([]frame.Frame, error)
  • func (s *Serial) Send(data []byte) error
  • func (s *Serial) Type() transport.InterfaceType

Types

type Serial

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

Serial is a wrapper of serial port interface that features specific functions to send provisioning commands through the serial port to an arduino device.

func NewSerial

func NewSerial() *Serial

NewSerial instantiate and returns a Serial instance. The Serial Connect method should be called before using its send/receive functions.

func (*Serial) Close

func (s *Serial) Close() error

Close should be used when the Serial connection isn't used anymore. After that, Serial could Connect again to any port.

func (*Serial) Connect

func (s *Serial) Connect(params transport.TransportInterfaceParams) error

Connect tries to connect Serial to a specific serial port.

func (*Serial) Connected

func (s *Serial) Connected() bool

func (*Serial) Receive

func (s *Serial) Receive(timeoutSeconds int) ([]frame.Frame, error)

func (*Serial) Send

func (s *Serial) Send(data []byte) error

func (*Serial) Type

func (s *Serial) Type() transport.InterfaceType