serial

README

serial

Example

package main

import (
	"log"

	"github.com/goburrow/serial"
)

func main() {
	port, err := serial.Open(&serial.Config{Address: "/dev/ttyUSB0"})
	if err != nil {
		log.Fatal(err)
	}
	defer port.Close()

	_, err = port.Write([]byte("serial"))
	if err != nil {
		log.Fatal(err)
	}
}

Testing

Linux and Mac OS

• socat -d -d pty,raw,echo=0 pty,raw,echo=0
• on Mac OS, the socat command can be installed using homebrew: brew install socat

Windows

• Null-modem emulator
• Terminal

Documentation

Overview

Package serial provides a cross-platform serial reader and writer.

Index

• Variables
• type Config
• type Port
  • func New() Port
  • func Open(c *Config) (p Port, err error)
• type RS485Config

Variables

var (
	// ErrTimeout is occurred when timing out.
	ErrTimeout = errors.New("serial: timeout")
)

Types

type Config

type Config struct {
	// Device path (/dev/ttyS0)
	Address string
	// Baud rate (default 19200)
	BaudRate int
	// Data bits: 5, 6, 7 or 8 (default 8)
	DataBits int
	// Stop bits: 1 or 2 (default 1)
	StopBits int
	// Parity: N - None, E - Even, O - Odd (default E)
	// (The use of no parity requires 2 stop bits.)
	Parity string
	// Read (Write) timeout.
	Timeout time.Duration
	// Configuration related to RS485
	RS485 RS485Config
}

Config is common configuration for serial port.

type Port

type Port interface {
	io.ReadWriteCloser
	// Connect connects to the serial port.
	Open(*Config) error
}

Port is the interface for controlling serial port.

func New

func New() Port

New allocates and returns a new serial port controller.

func Open

func Open(c *Config) (p Port, err error)

Open opens a serial port.

type RS485Config

type RS485Config struct {
	// Enable RS485 support
	Enabled bool
	// Delay RTS prior to send
	DelayRtsBeforeSend time.Duration
	// Delay RTS after send
	DelayRtsAfterSend time.Duration
	// Set RTS high during send
	RtsHighDuringSend bool
	// Set RTS high after send
	RtsHighAfterSend bool
	// Rx during Tx
	RxDuringTx bool
}

platform independent RS485 config. Thie structure is ignored unless Enable is true.