Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/graugans/go-ovp8xx
A GO package and cli to access the ifm ovp8xx series of devices
https://github.com/graugans/go-ovp8xx
api cli go hacktoberfest json ovp8xx rpc
Last synced: about 1 month ago
JSON representation
A GO package and cli to access the ifm ovp8xx series of devices
- Host: GitHub
- URL: https://github.com/graugans/go-ovp8xx
- Owner: graugans
- License: apache-2.0
- Created: 2023-08-03T14:52:41.000Z (over 1 year ago)
- Default Branch: v2
- Last Pushed: 2024-04-14T09:30:09.000Z (8 months ago)
- Last Synced: 2024-04-14T09:37:55.466Z (8 months ago)
- Topics: api, cli, go, hacktoberfest, json, ovp8xx, rpc
- Language: Go
- Homepage:
- Size: 129 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Go client for the ifm OVP8xx series of devices
⚠️ This is my personal project it is not an official ifm product. Please use the official [ifm3d](https://github.com/ifm/ifm3d) project if you need an officially supported version ⚠️
## Introduction
A GO module and cli to access the ifm OVP8xx series of devices.
[](https://github.com/graugans/go-ovp8xx)
[](https://pkg.go.dev/github.com/graugans/go-ovp8xx/v2)
[](https://opensource.org/licenses/Apache-2.0)
[](https://codecov.io/gh/graugans/go-ovp8xx)
## Project status
This project is still a work in progress and will suffer from breaking API changes. Please be warned. In case you have any suggestions or want to contribute please feel free to open an issue or pull request.
## CLI
One of the benefits of the Go language is the easy way of producing statically linked binaries to be used on all major platforms. One of the `ovp8xx` core features is the CLI interface. The design tries to stay as close as possible to the XML-RPC API.
With the CLI you can get the configuration from the device and [filter](doc/filter.md) it as you need. After transforming the config it can be written back to the device.
### CLI Installation
#### Pre Build Binaries
The recommended and easiest way is to download the pre-build binary from the [GitHub Release page](https://github.com/graugans/go-ovp8xx/releases).
⚠️ The Windows binary maybe flagged by a Virus Scanner, please also read the note from the [Go Team](https://go.dev/doc/faq#virus) ⚠️
#### Go get
If you have a decent Go version installed
```sh
go install github.com/graugans/go-ovp8xx/v2/cmd/ovp8xx@latest
```
### API usage
Within in your Go project get the ovp8xx package first
```
go get github.com/graugans/go-ovp8xx/v2
```
The following example will query the software Version of your OVP8xx. This assumes that either the OVP8xx is using the default IP address of `192.168.0.69` or the environment variable `OVP8XX_IP` is set. In case you want to set the IP in code please use `ovp8xx.NewClient(ovp8xx.WithHost("192.168.0.69"))` to construct the client.
```go
package main
import (
"fmt"
"github.com/graugans/go-ovp8xx/v2/pkg/ovp8xx"
)
func main() {
o3r := ovp8xx.NewClient()
config, err := o3r.Get([]string{"/device/swVersion"})
if err != nil {
fmt.Println(err)
}
fmt.Println(config)
}
```
The result depends on your specific device:
```json
{
"device": {
"swVersion": {
"euphrates": "1.32.1+8.e72bf7bb5",
"firmware": "1.1.2-1335",
"kernel": "4.9.140-l4t-r32.4+g8c7b68130d9a",
"l4t": "r32.4.3",
"schema": "v1.5.3",
"tcu": "1.1.0"
}
}
}
```
## Testing
Please ensure you have the Git Large File Storage extension installed. Some of the tests require blobs which are handled as Large File Storage files. In case the files are not populated as expected this may help:
```sh
git lfs fetch --all
git lfs pull
```