Skip to main content

Read data from GoodWe inverter via local network

Project description

GoodWe

PyPi Python Versions Build Status License

Library for connecting to GoodWe inverter over local network and retrieving runtime sensor values and configuration parameters.

It has been reported to work on GoodWe ET, EH, BT, BH, ES, EM, DT, D-NS, XS and BP families of inverters. It may work on other inverters as well, as long as they listen on UDP port 8899 and respond to one of supported communication protocols.

Usage

  1. Install this package pip install goodwe
  2. Write down your GoodWe inverter's IP address (or invoke goodwe.search_inverters())
  3. Connect to inverter and read all runtime data, example below
import asyncio
import goodwe


async def get_runtime_data():
    ip_address = '192.168.1.14'

    inverter = await goodwe.connect(ip_address)
    runtime_data = await inverter.read_runtime_data()

    for sensor in inverter.sensors():
        if sensor.id_ in runtime_data:
            print(f"{sensor.id_}: \t\t {sensor.name} = {runtime_data[sensor.id_]} {sensor.unit}")


asyncio.run(get_runtime_data())

or the old way (for XS inverters only), create a processor and inverter instance:

import asyncio
from goodwe import GoodWeInverter, GoodWeXSProcessor

async def get_data():
    ip_address = '192.168.200.100'
    processor = GoodWeXSProcessor()
    inverter = GoodWeInverter(inverter_address=(ip_address, 8899), processor=processor)
    data = await inverter.request_data()
    print(f'power is {data.power} at {data.date:%H:%M:%S}')

asyncio.run(get_data())

References and useful links

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

goodwe-0.2.1.tar.gz (30.9 kB view details)

Uploaded Source

Built Distribution

goodwe-0.2.1-py3-none-any.whl (40.1 kB view details)

Uploaded Python 3

File details

Details for the file goodwe-0.2.1.tar.gz.

File metadata

  • Download URL: goodwe-0.2.1.tar.gz
  • Upload date:
  • Size: 30.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.2 CPython/3.9.7

File hashes

Hashes for goodwe-0.2.1.tar.gz
Algorithm Hash digest
SHA256 4567ca2ccc4cbbbc587cceff78858e03e1dc788b292140afee8371a14d311827
MD5 df165ec83e7bf65321f791b8c044ca53
BLAKE2b-256 a446559af66621889c46737e2facc11d241bb9e6193381ad74e902c22368f3c1

See more details on using hashes here.

File details

Details for the file goodwe-0.2.1-py3-none-any.whl.

File metadata

  • Download URL: goodwe-0.2.1-py3-none-any.whl
  • Upload date:
  • Size: 40.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.2 CPython/3.9.7

File hashes

Hashes for goodwe-0.2.1-py3-none-any.whl
Algorithm Hash digest
SHA256 6ab917e3246c04ff2d6e07f6271174a417a1eeaf161786ba437186f21f0d0d5d
MD5 72c71b74da8da5cfbfdf17a5c59d5a42
BLAKE2b-256 e250492f64643b113f6b334a017208e72d27041c77266ac143df1c709c9637f6

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page