serial

package
v0.0.2 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Aug 4, 2024 License: GPL-3.0 Imports: 7 Imported by: 0

Documentation

Index

Constants

View Source
const BaudRateMin = 100

Variables

View Source
var ErrBaudRateMin = errors.New("baudRate too small")
View Source
var ErrListSerialUnsupportedPlatform = errors.New("unsupported platform")
View Source
var ParamLoadSerialMap = map[string]ParamLoadSerialObj{
	"linux": {
		CMD:  "sh",
		Args: []string{"-c", "ls /dev/tty* | grep -E 'ttyUSB.*|ttyACM.*'"},
	},
	"windows": {
		CMD:  "powershell",
		Args: []string{"Get-ItemProperty HKLM:\\HARDWARE\\DEVICEMAP\\SERIALCOMM | Select-Object -Property * -ExcludeProperty PSPath, PSParentPath, PSChildName, PSDrive, PSProvider | ForEach-Object { $_.PSObject.Properties.Value }"},
	},
	"darwin": {
		CMD:  "sh",
		Args: []string{"-c", "ls /dev/tty.*"},
	},
}

Functions

func Check

func Check(portName string) bool

func ListSerial

func ListSerial() ([]string, error)

Types

type BaudRateObj

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

func (*BaudRateObj) Get

func (obj *BaudRateObj) Get() int

func (*BaudRateObj) Set

func (obj *BaudRateObj) Set(newBaudRate int) error

type ParamLoadSerialObj

type ParamLoadSerialObj struct {
	CMD  string
	Args []string
}

type ReadTimeoutObj

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

func (*ReadTimeoutObj) Get

func (obj *ReadTimeoutObj) Get() time.Duration

func (*ReadTimeoutObj) Set

func (obj *ReadTimeoutObj) Set(duration time.Duration) error

type SerialObj

type SerialObj struct {
	Timeout  ReadTimeoutObj
	BaudRate BaudRateObj
	// contains filtered or unexported fields
}

func New

func New(port string, baudRate int, dataBits int, stopBits serial.StopBits, parity serial.Parity) (*SerialObj, error)

func NewEsp

func NewEsp(portName string, baudRate int) (*SerialObj, error)

func (*SerialObj) Close

func (ss *SerialObj) Close() error

func (*SerialObj) Flush

func (ss *SerialObj) Flush() error

func (*SerialObj) Read

func (ss *SerialObj) Read(b []byte) (int, error)

func (*SerialObj) Reset

func (ss *SerialObj) Reset() error

func (*SerialObj) Write

func (ss *SerialObj) Write(b []byte) (int, error)

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL