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, BP, DT, MS, D-NS, and XS 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.

(If you can't communicate with the inverter despite your model is listed above, it is possible you have old ARM firmware version. You should ask manufacturer support to upgrade your ARM firmware (not just inverter firmware) to be able to communicate with the inveter via UDP.)

White-label (GoodWe manufactured) inverters may work as well, e.g. General Electric GEP (PSB, PSC) and GEH models.

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.32.tar.gz (42.3 kB view details)

Uploaded Source

Built Distribution

goodwe-0.2.32-py3-none-any.whl (36.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: goodwe-0.2.32.tar.gz
  • Upload date:
  • Size: 42.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.9.18

File hashes

Hashes for goodwe-0.2.32.tar.gz
Algorithm Hash digest
SHA256 6c7e1a9e50883b3af36d1b111d291f4fe15aa2f9dccbeda1419617e46b7ec0ff
MD5 793628bb8d8f5aa0c85326a86a7ca6e7
BLAKE2b-256 34907091b0e30d284a27b0988d5e29331b45fa31a1e77ca286ef46e6646c4e57

See more details on using hashes here.

File details

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

File metadata

  • Download URL: goodwe-0.2.32-py3-none-any.whl
  • Upload date:
  • Size: 36.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.9.18

File hashes

Hashes for goodwe-0.2.32-py3-none-any.whl
Algorithm Hash digest
SHA256 d55a97b921a36dc9e957c8fcaae00b9aa1d8bf5082d1fc7408e7853e3e1adf3d
MD5 67fd0701a8a2f066fe10980002f7df8d
BLAKE2b-256 39182067bb0e43543e1b3533f2d1baabb67e713676dde1120cf37002ca5e2238

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