lechu/go-serial
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Introducing go.mod for dep management

Browse Source
This commit is contained in:
Cristian Maglie
2019-12-02 19:51:36 +01:00
parent 24a6610f05
commit df95023074
39 changed files with 71 additions and 50 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
.travis.yml
View File

@@ -11,7 +11,7 @@ go:
- 1.10.x
- 1.11.x
go_import_path: go.bug.st/serial.v1
go_import_path: go.bug.st/serial
env:
- TEST_OS=linux TEST_ARCH=386
@@ -58,8 +58,8 @@ before_install:
script:
- GOARM=5 GO386=387 GOOS=$TEST_OS GOARCH=$TEST_ARCH go get github.com/stretchr/testify/require
- GOARM=5 GO386=387 GOOS=$TEST_OS GOARCH=$TEST_ARCH go get golang.org/x/sys/windows
- GOARM=5 GO386=387 GOOS=$TEST_OS GOARCH=$TEST_ARCH go build -v go.bug.st/serial.v1
- GOARM=5 GO386=387 GOOS=$TEST_OS GOARCH=$TEST_ARCH go test -c -v go.bug.st/serial.v1
- GOARM=5 GO386=387 GOOS=$TEST_OS GOARCH=$TEST_ARCH go build -v go.bug.st/serial
- GOARM=5 GO386=387 GOOS=$TEST_OS GOARCH=$TEST_ARCH go test -c -v go.bug.st/serial
notifications:
email:

11
README.md
View File

@@ -1,22 +1,22 @@
[![Build Status](https://travis-ci.org/bugst/go-serial.svg?branch=v1)](https://travis-ci.org/bugst/go-serial)
# go.bug.st/serial.v1
# 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.v1
See the godoc here: https://godoc.org/go.bug.st/serial
## Development
If you want to contribute to the development of this library, you must clone this git repository directly into your `src` folder under `src/go.bug.st/serial.v1` and checkout the branch `v1`.
If you want to contribute to the development of this library, you must clone this git repository directly into your `src` folder under `src/go.bug.st/serial` and checkout the branch `v1`.
```
cd $GOPATH
mkdir -p src/go.bug.st/
git clone https://github.com/bugst/go-serial.git -b v1 src/go.bug.st/serial.v1
go test go.bug.st/serial.v1
git clone https://github.com/bugst/go-serial.git -b v1 src/go.bug.st/serial
go test go.bug.st/serial
```
## What's new in v1
@@ -32,4 +32,3 @@ https://github.com/bugst/go-serial/pull/5/files
The software is release under a BSD 3-clause license
https://github.com/bugst/go-serial/blob/v1/LICENSE

8
doc.go
View File

@@ -7,10 +7,10 @@
/*
Package serial is a cross-platform serial library for the go language.
The canonical import for this library is go.bug.st/serial.v1 so the import line
The canonical import for this library is go.bug.st/serial so the import line
is the following:
import "go.bug.st/serial.v1"
import "go.bug.st/serial"
It is possible to get the list of available serial ports with the
GetPortsList function:
@@ -84,7 +84,7 @@ cable or a microcontroller development board) is possible to retrieve
the USB metadata, like VID/PID or USB Serial Number, with the
GetDetailedPortsList function in the enumerator package:
import "go.bug.st/serial.v1/enumerator"
import "go.bug.st/serial/enumerator"
ports, err := enumerator.GetDetailedPortsList()
if err != nil {
@@ -110,4 +110,4 @@ Unfortunately the USB enumeration package for darwin (MacOSX) requires cgo
to access the IOKit framework. This means that if you need USB enumeration
on darwin you're forced to use cgo.
*/
package serial // import "go.bug.st/serial.v1"
package serial

2
enumerator/doc.go
View File

@@ -18,4 +18,4 @@ required in order to access the IOKit Framework. This means that the library
cannot be easily cross compiled for GOOS=darwing targets.
*/
package enumerator // import "go.bug.st/serial.v1/enumerator"
package enumerator

2
enumerator/enumerator.go
View File

@@ -4,7 +4,7 @@
// license that can be found in the LICENSE file.
//
package enumerator // import "go.bug.st/serial.v1/enumerator"
package enumerator
//go:generate go run $GOROOT/src/syscall/mksyscall_windows.go -output syscall_windows.go usb_windows.go

2
enumerator/example_getdetailedportlist_test.go
View File

@@ -8,7 +8,7 @@ package enumerator_test
import "fmt"
import "log"
import "go.bug.st/serial.v1/enumerator"
import "go.bug.st/serial/enumerator"
func ExampleGetDetailedPortsList() {
ports, err := enumerator.GetDetailedPortsList()

2
enumerator/usb_darwin.go
View File

@@ -6,7 +6,7 @@
// +build go1.10,darwin
package enumerator // import "go.bug.st/serial.v1/enumerator"
package enumerator
// #cgo LDFLAGS: -framework CoreFoundation -framework IOKit
// #include <IOKit/IOKitLib.h>

2
enumerator/usb_darwin_go1.9.go
View File

@@ -10,7 +10,7 @@
// and is no more maintained or bugfixed, please update your go version
// to at least 1.10 to get the latest updates.
package enumerator // import "go.bug.st/serial.v1/enumerator"
package enumerator
// #cgo LDFLAGS: -framework CoreFoundation -framework IOKit
// #include <IOKit/IOKitLib.h>

2
enumerator/usb_freebsd.go
View File

@@ -4,7 +4,7 @@
// license that can be found in the LICENSE file.
//
package enumerator // import "go.bug.st/serial.v1/enumerator"
package enumerator
func nativeGetDetailedPortsList() ([]*PortDetails, error) {
// TODO

4
enumerator/usb_linux.go
View File

@@ -4,7 +4,7 @@
// license that can be found in the LICENSE file.
//
package enumerator // import "go.bug.st/serial.v1/enumerator"
package enumerator
import (
"bufio"
@@ -12,7 +12,7 @@ import (
"os"
"path/filepath"
"go.bug.st/serial.v1"
"go.bug.st/serial"
)
func nativeGetDetailedPortsList() ([]*PortDetails, error) {

2
enumerator/usb_windows.go
View File

@@ -4,7 +4,7 @@
// license that can be found in the LICENSE file.
//
package enumerator // import "go.bug.st/serial.v1/enumerator"
package enumerator
import (
"fmt"

2
enumerator/usb_windows_test.go
View File

@@ -4,7 +4,7 @@
// license that can be found in the LICENSE file.
//
package enumerator // import "go.bug.st/serial.v1/enumerator"
package enumerator
import (
"testing"

2
example_getportlist_test.go
View File

@@ -8,7 +8,7 @@ package serial_test
import "fmt"
import "log"
import "go.bug.st/serial.v1"
import "go.bug.st/serial"
func ExampleGetPortsList() {
ports, err := serial.GetPortsList()

2
example_modem_bits_test.go
View File

@@ -7,7 +7,7 @@
package serial_test
import "log"
import "go.bug.st/serial.v1"
import "go.bug.st/serial"
import "fmt"
import "time"

2
example_serialport_test.go
View File

@@ -8,7 +8,7 @@ package serial_test
import "fmt"
import "log"
import "go.bug.st/serial.v1"
import "go.bug.st/serial"
func ExampleSerialPort_SetMode() {
port, err := serial.Open("/dev/ttyACM0", &serial.Mode{})

2
example_test.go
View File

@@ -8,7 +8,7 @@ package serial_test
import "fmt"
import "log"
import "go.bug.st/serial.v1"
import "go.bug.st/serial"
// This example prints the list of serial ports and use the first one
// to send a string "10,20,30" and prints the response on the screen.

9
go.mod Normal file
View File

@@ -0,0 +1,9 @@
module go.bug.st/serial
go 1.13
require (
github.com/creack/goselect v0.1.1
github.com/stretchr/testify v1.4.0
golang.org/x/sys v0.0.0-20191128015809-6d18c012aee9
)

14
go.sum Normal file
View File

@@ -0,0 +1,14 @@
github.com/creack/goselect v0.1.1 h1:tiSSgKE1eJtxs1h/VgGQWuXUP0YS4CDIFMp6vaI1ls0=
github.com/creack/goselect v0.1.1/go.mod h1:a/NhLweNvqIYMuxcMOuWY516Cimucms3DglDzQP3hKY=
github.com/davecgh/go-spew v1.1.0 h1:ZDRjVQ15GmhC3fiQ8ni8+OwkZQO4DARzQgrnXU1Liz8=
github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
github.com/stretchr/testify v1.4.0 h1:2E4SXV/wtOkTonXsotYi4li6zVWxYlZuYNCXe9XRJyk=
github.com/stretchr/testify v1.4.0/go.mod h1:j7eGeouHqKxXV5pUuKE4zz7dFj8WfuZ+81PSLYec5m4=
golang.org/x/sys v0.0.0-20191128015809-6d18c012aee9 h1:ZBzSG/7F4eNKz2L3GE9o300RX0Az1Bw5HF7PDraD+qU=
golang.org/x/sys v0.0.0-20191128015809-6d18c012aee9/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
gopkg.in/yaml.v2 v2.2.2 h1:ZCJp+EgiOT7lHqUV2J862kp8Qj64Jo6az82+3Td9dZw=
gopkg.in/yaml.v2 v2.2.2/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI=

2
portlist/portlist.go
View File

@@ -17,7 +17,7 @@ package main
import "fmt"
import "log"
import "go.bug.st/serial.v1/enumerator"
import "go.bug.st/serial/enumerator"
func main() {
ports, err := enumerator.GetDetailedPortsList()

2
serial.go
View File

@@ -4,7 +4,7 @@
// license that can be found in the LICENSE file.
//
package serial // import "go.bug.st/serial.v1"
package serial
//go:generate go run $GOROOT/src/syscall/mksyscall_windows.go -output zsyscall_windows.go syscall_windows.go

2
serial_darwin.go
View File

@@ -4,7 +4,7 @@
// license that can be found in the LICENSE file.
//
package serial // import "go.bug.st/serial.v1"
package serial
import "golang.org/x/sys/unix"

2
serial_darwin_386.go
View File

@@ -4,7 +4,7 @@
// license that can be found in the LICENSE file.
//
package serial // import "go.bug.st/serial.v1"
package serial
import "golang.org/x/sys/unix"

2
serial_darwin_amd64.go
View File

@@ -4,7 +4,7 @@
// license that can be found in the LICENSE file.
//
package serial // import "go.bug.st/serial.v1"
package serial
import "golang.org/x/sys/unix"

2
serial_freebsd.go
View File

@@ -4,7 +4,7 @@
// license that can be found in the LICENSE file.
//
package serial // import "go.bug.st/serial.v1"
package serial
import "golang.org/x/sys/unix"

2
serial_linux.go
View File

@@ -4,7 +4,7 @@
// license that can be found in the LICENSE file.
//
package serial // import "go.bug.st/serial.v1"
package serial
import "golang.org/x/sys/unix"

2
serial_openbsd.go
View File

@@ -4,7 +4,7 @@
// license that can be found in the LICENSE file.
//
package serial // import "go.bug.st/serial.v1"
package serial
import "golang.org/x/sys/unix"

5
serial_unix.go
View File

@@ -6,7 +6,7 @@
// +build linux darwin freebsd openbsd
package serial // import "go.bug.st/serial.v1"
package serial
import (
"io/ioutil"
@@ -16,8 +16,7 @@ import (
"unsafe"
"golang.org/x/sys/unix"
"go.bug.st/serial.v1/unixutils"
"go.bug.st/serial/unixutils"
)
type unixPort struct {

2
serial_windows.go
View File

@@ -4,7 +4,7 @@
// license that can be found in the LICENSE file.
//
package serial // import "go.bug.st/serial.v1"
package serial
/*

2
syscall_darwin.go
View File

@@ -4,6 +4,6 @@
// license that can be found in the LICENSE file.
//
package serial // import "go.bug.st/serial.v1"
package serial
//sys ioctl(fd int, req uint64, data uintptr) (err error)

2
syscall_freebsd.go
View File

@@ -4,6 +4,6 @@
// license that can be found in the LICENSE file.
//
package serial // import "go.bug.st/serial.v1"
package serial
//sys ioctl(fd int, req uint64, data uintptr) (err error)

2
syscall_linux.go
View File

@@ -4,6 +4,6 @@
// license that can be found in the LICENSE file.
//
package serial // import "go.bug.st/serial.v1"
package serial
//sys ioctl(fd int, req uint64, data uintptr) (err error)

2
syscall_openbsd.go
View File

@@ -4,6 +4,6 @@
// license that can be found in the LICENSE file.
//
package serial // import "go.bug.st/serial.v1"
package serial
//sys ioctl(fd int, req uint64, data uintptr) (err error)

2
syscall_windows.go
View File

@@ -4,7 +4,7 @@
// license that can be found in the LICENSE file.
//
package serial // import "go.bug.st/serial.v1"
package serial
//sys regEnumValue(key syscall.Handle, index uint32, name *uint16, nameLen *uint32, reserved *uint32, class *uint16, value *uint16, valueLen *uint32) (regerrno error) = advapi32.RegEnumValueW

2
unixutils/pipe.go
View File

@@ -6,7 +6,7 @@
// +build linux darwin freebsd openbsd
package unixutils // import "go.bug.st/serial.v1/unixutils"
package unixutils
import "syscall"
import "fmt"

2
unixutils/select.go
View File

@@ -6,7 +6,7 @@
// +build linux darwin freebsd openbsd
package unixutils // "go.bug.st/serial.v1/unixutils"
package unixutils
import (
"time"

2
zsyscall_darwin.go
View File

@@ -8,7 +8,7 @@
// mksyscall.pl serial_darwin.go
// The generated stub is modified to make it compile under the "serial" package
package serial // import "go.bug.st/serial.v1"
package serial
import "golang.org/x/sys/unix"

2
zsyscall_freebsd.go
View File

@@ -8,7 +8,7 @@
// mksyscall.pl serial_freebsd.go
// The generated stub is modified to make it compile under the "serial" package
package serial // import "go.bug.st/serial.v1"
package serial
import "golang.org/x/sys/unix"

2
zsyscall_linux.go
View File

@@ -8,7 +8,7 @@
// mksyscall.pl serial_linux.go
// The generated stub is modified to make it compile under the "serial" package
package serial // import "go.bug.st/serial.v1"
package serial
import "golang.org/x/sys/unix"

2
zsyscall_openbsd.go
View File

@@ -8,7 +8,7 @@
// mksyscall.pl serial_openbsd.go
// The generated stub is modified to make it compile under the "serial" package
package serial // import "go.bug.st/serial.v1"
package serial
import "syscall"