serial

Documentation

Overview

Package serial provides a serial port, which provides the io.ReadWriter interface, that provides the connection between the at or gsm packages and the physical modem.

Index

• func New(options ...Option) (*serial.Port, error)
• type Baud
  • func WithBaud(b int) Baud
• type Config
• type Option
• type Port
  • func WithPort(p string) Port

Functions

func New

func New(options ...Option) (*serial.Port, error)

New creates a serial port.

This is currently a simple wrapper around tarm serial.

Types

type Baud

type Baud int

Baud is the bit rate for the serial line.

func WithBaud

func WithBaud(b int) Baud

WithBaud sets the baud rate for the serial port.

type Config

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

Config contains the configuration parameters of the serial port.

type Option

type Option interface {
	// contains filtered or unexported methods
}

Option is a construction option that modifies the behaviour of the serial port.

type Port

type Port string

Port identifies the serial port on the plaform.

func WithPort

func WithPort(p string) Port

WithPort specifies the port for the serial port.