serial

package

v3.6.7+incompatible Latest Latest Go to latest Published: Dec 29, 2020 License: Apache-2.0 Imports: 13 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Rendered for

Package serial implements cross platform UART support exposed by the operating system.

On POSIX, it is via devfs. On Windows, it is via Windows specific APIs.

This section is empty.

This section is empty.

func Enumerate() ([]int, error)

Enumerate returns the available serial buses as exposed by the OS.

TODO(maruel): Port number are likely not useful, we need port names.

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

Port is an open serial port.

func (p *Port) CTS() gpio.PinIn

CTS implements uart.Pins.

func (p *Port) Close() error

Close implements uart.PortCloser.

func (p *Port) Connect(f physic.Frequency, stopBit uart.Stop, parity uart.Parity, flow uart.Flow, bits int) (conn.Conn, error)

Connect implements uart.Port.

func (p *Port) LimitSpeed(f physic.Frequency) error

LimitSpeed implements uart.PortCloser.

func (p *Port) RTS() gpio.PinOut

RTS implements uart.Pins.

func (p *Port) RX() gpio.PinIn

RX implements uart.Pins.

func (p *Port) String() string

String implements uart.Port.

func (p *Port) TX() gpio.PinOut

TX implements uart.Pins.