https://github.com/jke94/goodwe-connector
A python library to connect with Goodwe API Rest and get production data about solar panels.
https://github.com/jke94/goodwe-connector
python3 requests rest rest-api webapi
Last synced: over 1 year ago
JSON representation
A python library to connect with Goodwe API Rest and get production data about solar panels.
- Host: GitHub
- URL: https://github.com/jke94/goodwe-connector
- Owner: jke94
- License: gpl-3.0
- Created: 2023-02-17T15:53:54.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2025-02-22T18:03:17.000Z (over 1 year ago)
- Last Synced: 2025-02-22T18:38:17.233Z (over 1 year ago)
- Topics: python3, requests, rest, rest-api, webapi
- Language: Python
- Homepage: https://jke94.github.io/goodwe-connector/
- Size: 628 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# goodwe-connector
A python library to connect with Goodwe API Rest and get production data of solar panels.
## A. How to use...
### A.1. Developer environment: Create virtual environment and install requirements.txt
1. Create virtual envinroment:
```
python -m venv .\venv
```
2. Install requirements.txt.
```
pip install -r requirements.txt
```
### A.2. Create JSON file 'goodwe_config.json' like this (base repository path), with the following fields:
- System Id
- Account
- Password
Example of goodwe_config.json
```
{
"goodwe_api_connection":{
"system_id":"",
"account":"",
"password":""
}
}
```
### A.3. Open sample.py and edit to call the goodew_connector package functions:
Run the sample.py with python:
Define the extrategy that you want launch and running python script file:
```
python3 sample.py
```
Similar ouput like this:
```
{
"2023-08-02": 10.7
}
Generated 36.70 kWh (avg. 12.23 kWh per day) in 3 days.
{
"2023-08-01": 14.5,
"2023-08-02": 10.7,
"2023-08-03": 11.5
}
```
## B. Generate documentation.
- Build documentation:
```
mkdocs build
```
- Serve:
```
mkdocs serve
```
## C. Extra information: Goodew Api
Goodwe Api information:
- [http://www.goodwe-power.com:82/Help](http://www.goodwe-power.com:82/Help)
- [http://www.goodwe-power.com:82/swagger/ui/index](http://www.goodwe-power.com:82/swagger/ui/index)