From 58cfe7fb2d16f054951db52259abd13d2c276e26 Mon Sep 17 00:00:00 2001 From: Dimitri Sokolyuk Date: Wed, 17 Jul 2019 22:54:16 +0200 Subject: drop vendor --- vendor/github.com/tarm/serial/README.md | 82 --------------------------------- 1 file changed, 82 deletions(-) delete mode 100644 vendor/github.com/tarm/serial/README.md (limited to 'vendor/github.com/tarm/serial/README.md') diff --git a/vendor/github.com/tarm/serial/README.md b/vendor/github.com/tarm/serial/README.md deleted file mode 100644 index d2fa899..0000000 --- a/vendor/github.com/tarm/serial/README.md +++ /dev/null @@ -1,82 +0,0 @@ -[![GoDoc](https://godoc.org/github.com/tarm/serial?status.svg)](http://godoc.org/github.com/tarm/serial) -[![Build Status](https://travis-ci.org/tarm/serial.svg?branch=master)](https://travis-ci.org/tarm/serial) - -Serial -======== -A Go package to allow you to read and write from the -serial port as a stream of bytes. - -Details -------- -It aims to have the same API on all platforms, including windows. As -an added bonus, the windows package does not use cgo, so you can cross -compile for windows from another platform. - -You can cross compile with - GOOS=windows GOARCH=386 go install github.com/tarm/serial - -Currently there is very little in the way of configurability. You can -set the baud rate. Then you can Read(), Write(), or Close() the -connection. By default Read() will block until at least one byte is -returned. Write is the same. - -Currently all ports are opened with 8 data bits, 1 stop bit, no -parity, no hardware flow control, and no software flow control. This -works fine for many real devices and many faux serial devices -including usb-to-serial converters and bluetooth serial ports. - -You may Read() and Write() simulantiously on the same connection (from -different goroutines). - -Usage ------ -```go -package main - -import ( - "log" - - "github.com/tarm/serial" -) - -func main() { - c := &serial.Config{Name: "COM45", Baud: 115200} - s, err := serial.OpenPort(c) - if err != nil { - log.Fatal(err) - } - - n, err := s.Write([]byte("test")) - if err != nil { - log.Fatal(err) - } - - buf := make([]byte, 128) - n, err = s.Read(buf) - if err != nil { - log.Fatal(err) - } - log.Printf("%q", buf[:n]) -} -``` - -NonBlocking Mode ----------------- -By default the returned Port reads in blocking mode. Which means -`Read()` will block until at least one byte is returned. If that's not -what you want, specify a positive ReadTimeout and the Read() will -timeout returning 0 bytes if no bytes are read. Please note that this -is the total timeout the read operation will wait and not the interval -timeout between two bytes. - -```go - c := &serial.Config{Name: "COM45", Baud: 115200, ReadTimeout: time.Second * 5} - - // In this mode, you will want to suppress error for read - // as 0 bytes return EOF error on Linux / POSIX - n, _ = s.Read(buf) -``` - -Possible Future Work --------------------- -- better tests (loopback etc) -- cgit v1.2.3