mirror of
https://github.com/Fishwaldo/go-dcdc200.git
synced 2025-03-15 11:31:22 +00:00
Update readme according to godoc
This commit is contained in:
parent
93a6a2d26e
commit
1764b52423
1 changed files with 9 additions and 4 deletions
13
README.md
13
README.md
|
@ -1,14 +1,19 @@
|
|||
# Go-LogAdapter
|
||||
|
||||
[](https://codecov.io/gh/Fishwaldo/go-dcdcusb200)
|
||||
[](http://pkg.go.dev/github.com/Fishwaldo/go-dcdcusb200)
|
||||
[](https://codecov.io/gh/Fishwaldo/go-dcdc200)
|
||||
[](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))
|
||||
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
|
||||
|
||||
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
|
||||
|
||||
|
@ -19,7 +24,7 @@ Please see the GoUSB pages for hints on compiling for platforms other than linux
|
|||
```golang
|
||||
|
||||
dc := dcdcusb.DcDcUSB{}
|
||||
dc.Init()
|
||||
dc.Init(stdlogger.DefaultLogger(), false)
|
||||
if ok, err := dc.Scan(); !ok {
|
||||
log.Fatalf("Scan Failed: %v", err)
|
||||
return
|
||||
|
|
Loading…
Add table
Reference in a new issue