GitHub-Mirror/go-dcdc200
2
0
Fork 0
mirror of https://github.com/Fishwaldo/go-dcdc200.git synced 2025-03-15 19:41:23 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Update readme according to godoc

Browse source
This commit is contained in:
Justin Hammond 2021-10-01 17:02:15 +00:00
parent 93a6a2d26e
commit 1764b52423
1 changed files with 9 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

13
README.md
View file

@ -1,14 +1,19 @@
# Go-LogAdapter # Go-LogAdapter
[![codecov](https://codecov.io/gh/Fishwaldo/go-dcdcusb200/branch/master/graph/badge.svg)](https://codecov.io/gh/Fishwaldo/go-dcdcusb200) [![codecov](https://codecov.io/gh/Fishwaldo/go-dcdc200/branch/master/graph/badge.svg)](https://codecov.io/gh/Fishwaldo/go-dcdc200)
[![GoDoc](https://img.shields.io/badge/pkg.go.dev-doc-blue)](http://pkg.go.dev/github.com/Fishwaldo/go-dcdcusb200) [![GoDoc](https://img.shields.io/badge/pkg.go.dev-doc-blue)](http://pkg.go.dev/github.com/Fishwaldo/go-dcdc200)
Package go-dcdcusb interfaces with the DCDCUSB power supply from mini-box ([https://www.mini-box.com/DCDC-USB](https://www.mini-box.com/DCDC-USB)) Package go-dcdcusb interfaces with the DCDCUSB power supply from mini-box ([https://www.mini-box.com/DCDC-USB](https://www.mini-box.com/DCDC-USB))
via USB port and allows you to retrive the status of the power supply via USB port and allows you to retrive the status of the power supply
it depends upon GoUSB which in turn depends upon the libusb C library, thus CGO is required for this module it depends upon GoUSB which in turn depends upon the libusb C library, thus CGO is required for this module
Please see the GoUSB pages for hints on compiling for platforms other than linux ## Please see the GoUSB pages for hints on compiling for platforms other than linux
Building
Compile with the tag nogousb to disable compiling with USB Support. Then the only option available
is a Simulator Mode that replays a previously captured session.
## Sub Packages ## Sub Packages
@ -19,7 +24,7 @@ Please see the GoUSB pages for hints on compiling for platforms other than linux
```golang ```golang
dc := dcdcusb.DcDcUSB{} dc := dcdcusb.DcDcUSB{}
dc.Init() dc.Init(stdlogger.DefaultLogger(), false)
if ok, err := dc.Scan(); !ok { if ok, err := dc.Scan(); !ok {
log.Fatalf("Scan Failed: %v", err) log.Fatalf("Scan Failed: %v", err)
return return