network

Documentation

Index

• Constants
• type Network
  • func New(serial io.ReadWriteCloser) *Network
  • func (nw *Network) Flush()
  • func (nw *Network) Logf(format string, v ...interface{})
  • func (nw *Network) Read(p []byte) (n int, err error)
  • func (nw *Network) Write(p []byte) (int, error)

Constants

const (

	// Send an instruction to all servos
	BroadcastIdent byte = 0xFE // 254
)

Types

type Network

type Network struct {
	Serial io.ReadWriteCloser

	// The time to wait for a single read to complete before giving up.
	Timeout time.Duration

	// Optional Logger (which only implements Printf) to log network traffic. If
	// nil (the default), nothing is logged.
	Logger iface.Logger
}

func New

func New(serial io.ReadWriteCloser) *Network

func (*Network) Flush

func (nw *Network) Flush()

func (*Network) Logf

func (nw *Network) Logf(format string, v ...interface{})

Logf writes a message to the network logger, unless it's nil.

func (*Network) Read

func (nw *Network) Read(p []byte) (n int, err error)

read receives the next n bytes from the network, blocking if they're not immediately available. Returns a slice containing the bytes read. If the network timeout is reached, returns the bytes read so far (which might be none) and an error.

func (*Network) Write

func (nw *Network) Write(p []byte) (int, error)