Categorygithub.com/abehterev/go-serial
modulepackage
0.0.0-20180215100958-c2be32411658
Repository: https://github.com/abehterev/go-serial.git
Documentation: pkg.go.dev

# README

abehterev/go-serial

A cross-platform serial library for go-lang.

forked from bugst/go-serial

Documentation and examples

See the original godoc here: https://godoc.org/go.bug.st/serial.v1

License

The software is release under a BSD 3-clause license

https://github.com/abehterev/go-serial/blob/v1/LICENSE

# Packages

Package enumerator is a golang cross-platform library for USB serial port discovery.
No description provided by the author

# Functions

GetPortsList retrieve the list of available serial ports.
Open opens the serial port using the specified modes.

# Constants

ErrorEnumeratingPorts an error occurred while listing serial port.
EvenParity enable even-parity check.
FunctionNotImplemented the requested function is not implemented.
InvalidDataBits the number of data bits is not valid or not supported.
InvalidParity the selected parity is not valid or not supported.
InvalidSerialPort the requested port is not a serial port.
InvalidSpeed the requested speed is not valid or not supported.
InvalidStopBits the selected number of stop bits is not valid or not supported.
MarkParity enable mark-parity (always 1) check.
NoParity disable parity control (default).
OddParity enable odd-parity check.
OnePointFiveStopBits sets 1.5 stop bits.
OneStopBit sets 1 stop bit (default).
PermissionDenied the user doesn't have enough priviledges.
PortBusy the serial port is already in used by another process.
PortClosed the port has been closed while the operation is in progress.
PortNotFound the requested port doesn't exist.
SpaceParity enable space-parity (always 0) check.
TwoStopBits sets 2 stop bits.

# Structs

Mode describes a serial port configuration.
ModemStatusBits contains all the modem status bits for a serial port (CTS, DSR, etc...).
PortError is a platform independent error type for serial ports.

# Interfaces

Port is the interface for a serial Port.

# Type aliases

Parity describes a serial port parity setting.
PortErrorCode is a code to easily identify the type of error.
StopBits describe a serial port stop bits setting.