monitor

Documentation

Index

• func EnumerateMonitorPortSettings(ctx context.Context, req *rpc.EnumerateMonitorPortSettingsRequest) (*rpc.EnumerateMonitorPortSettingsResponse, error)
• type PortProxy
  • func Monitor(ctx context.Context, req *rpc.MonitorRequest) (*PortProxy, *pluggableMonitor.PortDescriptor, error)
  • func (p *PortProxy) Close() error
  • func (p *PortProxy) Config(setting, value string) error
  • func (p *PortProxy) Read(buff []byte) (int, error)
  • func (p *PortProxy) Write(buff []byte) (int, error)

Functions

func EnumerateMonitorPortSettings

func EnumerateMonitorPortSettings(ctx context.Context, req *rpc.EnumerateMonitorPortSettingsRequest) (*rpc.EnumerateMonitorPortSettingsResponse, error)

EnumerateMonitorPortSettings returns a description of the configuration settings of a monitor port

Types

type PortProxy

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

PortProxy is an io.ReadWriteCloser that maps into the monitor port of the board

func Monitor

func Monitor(ctx context.Context, req *rpc.MonitorRequest) (*PortProxy, *pluggableMonitor.PortDescriptor, error)

Monitor opens a communication port. It returns a PortProxy to communicate with the port and a PortDescriptor that describes the available configuration settings.

func (*PortProxy) Close

func (p *PortProxy) Close() error

Close the port

func (*PortProxy) Config

func (p *PortProxy) Config(setting, value string) error

Config sets the port configuration setting to the specified value

func (*PortProxy) Read

func (p *PortProxy) Read(buff []byte) (int, error)

func (*PortProxy) Write

func (p *PortProxy) Write(buff []byte) (int, error)