https://github.com/yaleman/pygoodwe

Python library for querying the GoodWe Solar SEMS API
https://github.com/yaleman/pygoodwe

api-client goodwe python python3 sems-portal solar

Last synced: about 2 months ago
JSON representation

Python library for querying the GoodWe Solar SEMS API

• Host: GitHub
• URL: https://github.com/yaleman/pygoodwe
• Owner: yaleman
• License: mit
• Created: 2019-09-25T12:45:09.000Z (about 5 years ago)
• Default Branch: main
• Last Pushed: 2024-04-27T02:31:39.000Z (8 months ago)
• Last Synced: 2024-05-01T20:02:01.394Z (8 months ago)
• Topics: api-client, goodwe, python, python3, sems-portal, solar
• Language: Python
• Homepage: https://yaleman.github.io/pygoodwe/
• Size: 2.86 MB
• Stars: 27
• Watchers: 7
• Forks: 9
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE
  • Codeowners: CODEOWNERS
  • Security: SECURITY.MD

Awesome Lists containing this project

README

        

# pygoodwe

A command line tool and python library to query the GOODWE SEMS Portal APIs.

## API Docs

Auto-generated documentation is here: 

## Installation

You need to have Python 3 and pip installed. Then:

    python -m pip install pygoodwe

Determine the Station ID from the GOODWE site as follows. Open the [Sems Portal](https://www.semsportal.com). The Plant Status will reveal the Station ID in the URL. Example:

    https://www.semsportal.com/powerstation/powerstatussnmin/11112222-aaaa-bbbb-cccc-ddddeeeeeffff

Then the Station ID is `11112222-aaaa-bbbb-cccc-ddddeeeeeffff`.

To use example.py or the other examples, copy config.py.example to config.py and add your details.

## Contributions

Please feel free to lodge an [issue or pull request on GitHub](https://github.com/yaleman/pygoodwe/issues).

## Thanks

* Originally based off the work of [Mark Ruys and his gw2pvo software](https://github.com/markruys/gw2pvo) - I needed something more flexible, so I made this.

## Disclaimer

GOODWE access is based on the undocumented API used by mobile apps. This could break at any time.

## Example Code

Please check out example.py or the examples folder in [the project repository](https://github.com/yaleman/pygoodwe) for some simple example code.