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

Updated docs for USB

Browse Source
This commit is contained in:
Cristian Maglie
2017-02-04 00:53:51 +01:00
parent fbd0f9fb33
commit 11d1e54246
2 changed files with 22 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
doc.go
View File

@@ -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 the USB metadata, like VID/PID or USB Serial Number, with the
GetDetailedPortsList function in the enumerator package: GetDetailedPortsList function in the enumerator package:
import "go.bug.st/serial.v1/enumerator" import "go.bug.st/serial.v1/enumerator"
ports, err := enumerator.GetDetailedPortsList() ports, err := enumerator.GetDetailedPortsList()
if err != nil { if err != nil {

21
enumerator/doc.go Normal file
View File

@@ -0,0 +1,21 @@
//
// Copyright 2014-2017 Cristian Maglie. All rights reserved.
// Use of this source code is governed by a BSD-style
// license that can be found in the LICENSE file.
//
/*
Package enumerator is a golang cross-platform library for USB serial port discovery.
WARNING: this library is still beta-testing code! please consider the library
and the API as *unstable*. Beware that, even if at this point it's unlike to
happen, the API may be subject to change until this notice is removed from
the documentation.
This library has been tested on Linux, Windows and Mac and uses specific OS
services to enumerate USB PID/VID, in particular on MacOSX the use of cgo is
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"