README
¶
go-victron
A go implementation of Victron Energy's VE.Direct and BLE protocols.
Usage
See https://pkg.go.dev/github.com/koestler/go-victron for documentation.
To install the cli run:
go install github.com/koestler/go-victron/vecli@latest
Development
Install local dependencies / build tools:
go install github.com/swaggo/swag/cmd/swag@latest
go install go.uber.org/mock/mockgen@latest
go install honnef.co/go/tools/cmd/staticcheck@latest
Build test and audit the code:
go generate ./...
go build ./...
go vet ./...
go test ./...
staticcheck ./...
Directories
¶
| Path | Synopsis |
|---|---|
|
internal
|
|
|
Package main contains a simple CLI for the go-victron library.
|
Package main contains a simple CLI for the go-victron library. |
|
Package veconst contains various enum values used by the VE.Direct, the VE.Bus and the BLE protocols.
|
Package veconst contains various enum values used by the VE.Direct, the VE.Bus and the BLE protocols. |
|
Package vedirect implements the VE.Direct serial protocol.
|
Package vedirect implements the VE.Direct serial protocol. |
|
Package vedirectapi implements an easy to use api to connect to VE.Direct devices and read their values.
|
Package vedirectapi implements an easy to use api to connect to VE.Direct devices and read their values. |
|
Package veproduct provides a list of Victron Energy products, their device id, and their names as string.
|
Package veproduct provides a list of Victron Energy products, their device id, and their names as string. |
|
Package veregister contains the register definitions for the VE.Direct protocol.
|
Package veregister contains the register definitions for the VE.Direct protocol. |
Click to show internal directories.
Click to hide internal directories.