This commit is contained in:
27
README.md
27
README.md
@@ -1,22 +1,25 @@
|
||||
# Inverter GUI
|
||||
|
||||
[![release][release-badge]][release-link]
|
||||
[![publish-docker-image][publish-docker-badge]][publish-docker-link]
|
||||
![license][license-link]
|
||||
[![codecov][codecov-badge]][codecov-link]
|
||||
[Repository](https://git.coadcorp.com/nathan/invertergui) | [Container Image](https://registry.coadcorp.com/nathan/invertergui)
|
||||
|
||||
The invertergui allows the monitoring of a [Victron Multiplus](https://www.victronenergy.com/inverters-chargers/multiplus-12v-24v-48v-800va-3kva) via the [MK3/MK2 USB](https://www.victronenergy.com/accessories/interface-mk3-usb) or the MK2 RS232.
|
||||
|
||||
The [`ghcr.io/diebietse/invertergui`](https://github.com/orgs/diebietse/packages/container/package/invertergui) docker image is a build of this repository.
|
||||
The [`registry.coadcorp.com/nathan/invertergui`](https://registry.coadcorp.com/nathan/invertergui) container image is a build of this repository.
|
||||
|
||||
## Acknowledgements
|
||||
|
||||
This project is based on the original open source `invertergui` project by Hendrik van Wyk and contributors:
|
||||
|
||||
- Original repository: https://github.com/diebietse/invertergui
|
||||
|
||||
## Demo
|
||||
|
||||

|
||||

|
||||
|
||||
## Quick Start
|
||||
|
||||
```console
|
||||
docker run --name invertergui --device /dev/ttyUSB0:/dev/ttyUSB0 -p 8080:8080 ghcr.io/diebietse/invertergui
|
||||
docker run --name invertergui --device /dev/ttyUSB0:/dev/ttyUSB0 -p 8080:8080 registry.coadcorp.com/nathan/invertergui:latest
|
||||
```
|
||||
|
||||
## Requirements
|
||||
@@ -481,12 +484,4 @@ The last four lines are optional, but is useful when debugging and logging conne
|
||||
|
||||
This repos includes a [Grafana](https://grafana.com/) dashboard in the [grafana folder](./grafana/prometheus-dashboard.json) that you can import. This is useful if you are using prometheus to log your data and want to display it in a nice way.
|
||||
|
||||

|
||||
|
||||
[publish-docker-badge]: https://github.com/diebietse/invertergui/actions/workflows/docker-build.yml/badge.svg
|
||||
[publish-docker-link]: https://github.com/diebietse/invertergui/actions/workflows/docker-build.yml
|
||||
[license-link]: https://img.shields.io/github/license/diebietse/invertergui.svg
|
||||
[release-badge]: https://img.shields.io/github/v/release/diebietse/invertergui
|
||||
[release-link]: https://github.com/diebietse/invertergui/releases
|
||||
[codecov-badge]: https://codecov.io/gh/diebietse/invertergui/branch/master/graph/badge.svg?token=xTLfEzoqYF
|
||||
[codecov-link]: https://codecov.io/gh/diebietse/invertergui
|
||||

|
||||
|
||||
Reference in New Issue
Block a user