Update README
This commit is contained in:
parent
93e9f6a7ba
commit
59f6fb1443
1 changed files with 17 additions and 0 deletions
17
README.md
17
README.md
|
@ -1,5 +1,22 @@
|
||||||
# sungrow
|
# sungrow
|
||||||
|
|
||||||
|
[![Go Reference](https://pkg.go.dev/badge/gitea.drjosh.dev/josh/sungrow.svg)](https://pkg.go.dev/gitea.drjosh.dev/josh/sungrow)
|
||||||
|
|
||||||
|
A Prometheus exporter that scrapes a Sungrow inverter for information about
|
||||||
|
solar generation, usage, and other fun data. It includes a (minor) fork of
|
||||||
|
github.com/goburrow/modbus (to enable working with Sungrow's "encryption").
|
||||||
|
|
||||||
|
This is part of my own custom solar monitoring setup, so has a few quirks suited
|
||||||
|
to me. In particular, it exports the necessary tariff values to compute
|
||||||
|
import cost and export value - if you are using Aurorar Tariff 93 in Tasmania.
|
||||||
|
|
||||||
|
> :warning: There is ABSOLUTELY NO WARRANTY provided with this code. If for
|
||||||
|
> whatever reason it blows up your inverter, THAT'S ON YOU.
|
||||||
|
|
||||||
|
## Building
|
||||||
|
|
||||||
|
Docker is recommended:
|
||||||
|
|
||||||
```
|
```
|
||||||
$ docker build -t sungrow .
|
$ docker build -t sungrow .
|
||||||
```
|
```
|
Loading…
Reference in a new issue