Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/geschke/golrackpi
Go Library Rest Api Client (for) Kostal Plenticore Inverters (with CLI)
https://github.com/geschke/golrackpi
api cli go golang golang-library kostal kostal-plenticore library plenticore solar-energy
Last synced: about 1 month ago
JSON representation
Go Library Rest Api Client (for) Kostal Plenticore Inverters (with CLI)
- Host: GitHub
- URL: https://github.com/geschke/golrackpi
- Owner: geschke
- License: mit
- Created: 2022-02-22T14:17:02.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2024-01-28T21:22:07.000Z (12 months ago)
- Last Synced: 2024-12-20T00:14:44.673Z (about 1 month ago)
- Topics: api, cli, go, golang, golang-library, kostal, kostal-plenticore, library, plenticore, solar-energy
- Language: Go
- Homepage:
- Size: 99.6 KB
- Stars: 1
- Watchers: 2
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# golrackpi is a Go (Golang) Library Rest Api Client (for) Kostal Plenticore Inverters (with CLI)
[](https://pkg.go.dev/github.com/geschke/golrackpi)
This repository provides a Go (Golang) library for the undocumented REST-API of Kostal Plenticore Inverters. It uses the PIKO IQ / PLENTICORE plus API with its swagger documentation found at "inverter ip address"/api/v1/.
This library is not affiliated with Kostal and is no offical product of KOSTAL Solar Electric GmbH or any subsidiary company of Kostal Gruppe.
## Features
* Authenticate (Login, Logout, Check authentication)
* Read settings
* Read processdata
* Read events
Additional:
* Commandline interface (CLI) to get any kind of returned inverter data
## Getting Started
Please be patient. The library is in development and currently in the last stage before a release will be published. So I'm cleaning up a bit and try to add some senseful comments and documentation in the next step.
...todo...
### Installing the library
...todo...
### Using the command line interface
```shell
golrackpi is a small CLI application to read values from Kostal Plenticore Inverters.
Usage:
golrackpi [command]
Available Commands:
completion Generate the autocompletion script for the specified shell
events Get the latest events
help Help about any command
info Returns miscellaneous information
modules List modules content
processdata List processdata values
settings List settings content
Flags:
-h, --help help for golrackpi
-p, --password string Password (required)
-m, --scheme string Scheme (http or https, default http)
-s, --server string Server (e.g. inverter IP address) (required)
Use "golrackpi [command] --help" for more information about a command.
```
### Using the library from Go
...todo...
## Documentation
...todo...
## License
MIT
## Thanks to
* [kilianknoll](https://github.com/kilianknoll) for the kostal-RESTAPI project
* [stegm](https://github.com/stegm) for the pykoplenti Python REST client API project
* Marco Tröster ([Bonifatius94](https://github.com/Bonifatius94)) in the issue of openhab-addons for some Java code provided in https://github.com/openhab/openhab-addons/issues/7492