# README
go.bug.st/serial
A cross-platform serial library for go-lang.
Documentation and examples
See the godoc here: https://godoc.org/go.bug.st/serial
go.mod transition
This library now support go.mod with the import go.bug.st/serial.
If you came from the pre-go.mod era please update your import paths from go.bug.st/serial.v1 to go.bug.st/serial to receive new updates. Anyway, the latest v1 release should still be avaiable using the old import.
Credits
:sparkles: Thanks to all awesome contributors! :sparkles:
License
The software is release under a BSD 3-clause license
# Packages
Package enumerator is a golang cross-platform library for USB serial port discovery.
portlist is a tool to list all the available serial ports.
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
ConfigureRS485Error indicates an error configuring RS485 on the platform.
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.
InvalidTimeoutValue the timeout value is not valid or not supported.
MarkParity enable mark-parity (always 1) check.
NoParity disable parity control (default).
NoPlatformSupportForRS485 indicates no platform support for RS485.
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.
ReadFailed indicates the read failed.
SpaceParity enable space-parity (always 0) check.
TwoStopBits sets 2 stop bits.
# Variables
NoTimeout should be used as a parameter to SetReadTimeout to disable timeout.
# Structs
Mode describes a serial port configuration.
ModemOutputBits contains all the modem output bits for a serial port.
ModemStatusBits contains all the modem input status bits for a serial port (CTS, DSR, etc...).
PortError is a platform independent error type for serial ports.
RS485Config -- platform independent RS485 config.
# 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.