pypowerwall

What's Changed

• Refactored pyPowerwall by @emptywee in https://github.com/jasonacox/pypowerwall/pull/77 including:
• Moved Local and Cloud based operation code into respective modules, providing better abstraction and making it easier to maintain and extend going forward.
• Made meaning of the jsonformat parameter consistent across all method calls (breaking API change).
• Removed Python 2.7 support.
• Cleaned up code and adopted a more pythoinc style.
• Fixed battery_blocks() for non-vitals systems.

Full Changelog: https://github.com/jasonacox/pypowerwall/compare/v0.7.12...v0.8.0

What's Changed

• Added logic to pull string data from /api/solar_powerwall API if vitals data is not available by @jasonacox in #76.
• Added alerts from /api/solar_powerwall when vitals not present by @DerickJohnson in #75. The vitals API is not present in firmware versions > 23.44, this provides a workaround to get alerts.
• Allow customization of the cachefile location and name by @emptywee in #74 via cachefile parameter.

# Example
import pypowerwall
pw = pypowerwall.Powerwall(
     host="10.1.2.30",
     password="secret",
     email="[email protected]",
     timezone="America/Los_Angeles",
     pwcacheexpire=5, 
     timeout=5, 
     poolmaxsize=10,
     cloudmode=False, 
     siteid=None, 
     authpath="", 
     authmode="cookie",
     cachefile=".powerwall",
     )

New Contributors

• @emptywee made their first contribution in https://github.com/jasonacox/pypowerwall/pull/74

Full Changelog: https://github.com/jasonacox/pypowerwall/compare/v0.7.11...v0.7.12

• Updated logic to disable vitals API calls for Firmware 23.44.0+
• Added rate limit detection and cooldown mode to allow Powerwall gateway time to recover.

Full Changelog: https://github.com/jasonacox/pypowerwall/compare/v0.7.10...v0.7.11

• Add cache and extended TTL for 404 responses from Powerwall as identified in issue https://github.com/jasonacox/Powerwall-Dashboard/issues/449. This will help reduce load on Powerwall gateway that may be causing rate limiting for some users (Firmware 23.44.0+).

Full Changelog: https://github.com/jasonacox/pypowerwall/compare/v0.7.9...v0.7.10

• Bug fix for correct grid status for Solar-Only systems on cloud mode (see https://github.com/jasonacox/Powerwall-Dashboard/issues/437)

Full Changelog: https://github.com/jasonacox/pypowerwall/compare/v0.7.8...v0.7.9

What's Changed

• Fix enumeration of energy sites during cloud mode setup to handle incomplete sites with Unknown names or types by @dcgibbons in https://github.com/jasonacox/pypowerwall/pull/72
• Proxy t41 Updates - Bug fixes for Solar-Only systems using cloud mode (see https://github.com/jasonacox/Powerwall-Dashboard/issues/437).

New Contributors

• @dcgibbons made their first contribution in https://github.com/jasonacox/pypowerwall/pull/72

Full Changelog: https://github.com/jasonacox/pypowerwall/compare/v0.7.7...v0.7.8

What's Changed

• Proxy t40: Use /api/system_status battery blocks data to augment /pod and /freq macro data APIs by @jasonacox in https://github.com/jasonacox/pypowerwall/pull/67 thanks to @ceeeekay in https://github.com/jasonacox/Powerwall-Dashboard/discussions/402#discussioncomment-8193776
• Network Scanner: Improve network scan speed by scanning multiple hosts simultaneously by @mcbirse in https://github.com/jasonacox/pypowerwall/pull/67. The number of hosts to scan simultaneously can be adjusted using the optional -hosts= argument (default = 30, maximum = 100), e.g. python -m pypowerwall scan -hosts=50

Full Changelog: https://github.com/jasonacox/pypowerwall/compare/v0.7.6...v0.7.7

What's Changed

• Fix Critical Bug Fix that addresses HTTP 404 response handling for API calls #65 #57 by @jasonacox in https://github.com/jasonacox/pypowerwall/pull/66 https://github.com/jasonacox/pypowerwall/issues/65

🔥 CRITICAL Upgrade - Please take a moment and upgrade your installation of pypowerwall if you using it for your own scripts. The latest release fixes 404 HTTP status code handling for API calls. Older versions of pypowerwall will cause a repeating loop of login attempts eventually resulting in rate limiting and failure to get any metrics.

NOTE: IF YOU HAVE FIRMWARE 23.44.0 YOU ARE IMPACTED AND SHOULD UPGRADE AS SOON AS POSSIBLE.

pip install --upgrade pypowerwall

# Verify version 0.7.6 or greater:
python -m pypowerwall version

pyPowerwall [0.7.6]

Note: Users of pypowerwall proxy docker container should upgrade to the latest as well: jasonacox/pypowerwall:0.7.6t39

Full Changelog: https://github.com/jasonacox/pypowerwall/compare/v0.7.5...v0.7.6

What's Changed

• Added optional email address argument to Cloud Mode setup (python -m pypowerwall setup -email=<email>) by @mcbirse in https://github.com/jasonacox/pypowerwall/pull/64 to streamline Powerwall-Dashboard setup script.
• Updated network scanner output to advise Powerwall 3 is supported in Cloud Mode by @mcbirse in https://github.com/jasonacox/pypowerwall/pull/64

Full Changelog: https://github.com/jasonacox/pypowerwall/compare/v0.7.4...v0.7.5

What's Changed

• Add Bearer Token Auth by @jasonacox in https://github.com/jasonacox/pypowerwall/pull/63
• Powerwall Network Scanner - Added optional IP address argument to network scanner by @mcbirse in https://github.com/jasonacox/pypowerwall/pull/63. The Scan Function can now accept an additional argument -ip= to override the host IP address detection (python -m pypowerwall scan -ip=192.168.1.100). This may be useful where the host IP address/network cannot be detected correctly, for instance if pypowerwall is running inside a container.

pyPowerwall

• This release adds the ability to use a Bearer Token for Authentication for the local Powerwall gateway API calls. This is selectable by defining authmode='token' in the initialization. The default mode uses the existing AuthCookie and UserRecord method.

import pypowerwall

pw = pypowerwall.Powerwall(HOST, PASSWORD, EMAIL, TIMEZONE, authmode="token")

Proxy

• The above option is extended to the pyPowerwall Proxy via the envrionmental variable PW_AUTH_MODE set to cookie (default) or token.

Full Changelog: https://github.com/jasonacox/pypowerwall/compare/v0.7.3...v0.7.4

What's Changed

• v0.7.3 - Setup will now check for PW_AUTH_PATH environmental variable to set the path for .pypowerwall.auth and .pypowerwall.site by @mcbirse in https://github.com/jasonacox/pypowerwall/pull/62
• Proxy t37 - Move signal handler to capture SIGTERM when proxy halts due to config error by @mcbirse in https://github.com/jasonacox/pypowerwall/pull/62. This ensures a containerized proxy will exit without delay when stopping or restarting the container.

Full Changelog: https://github.com/jasonacox/pypowerwall/compare/v0.7.2...v0.7.3

What's Changed

• v0.7.2 - Add cloud mode configuration setting by @jasonacox in https://github.com/jasonacox/pypowerwall/pull/61

Details

This adds the option to set file path for cloud auth (.pypowerwall.auth) and site (.pypowerwall.site) cache files:

• API - The initializer now has authpath which defaults to current directory (authpath="")
• Proxy - An environmental variable PW_AUTH_PATH is added which defaults to current directory.

This also adds the option to specify the energy site ID (siteid):

• API - The initializer now has siteid which defaults to None.
• Proxy - The existing environmental variable PW_SITEID is available to set the siteid.

import pypowerwall

pw = pypowerwall.Powerwall(email="[email protected]",cloudmode=True,siteid=1234567,authpath=".auth")

This will provide more flexibility to run the pypowerwall proxy in a container for cloud mode support.

Full Changelog: https://github.com/jasonacox/pypowerwall/compare/v0.7.1...v0.7.2

What's Changed

• Localize PowerFlow Animation by @jasonacox in https://github.com/jasonacox/pypowerwall/pull/58
• Added new API function to compute estimated backup time remaining on the battery: get_time_remaining()
• Simulate Powerwall Energy Gateway via Tesla Cloud API calls. In cloudmode API calls to pypowerwall APIs will result in calls made to the Tesla API to fetch the data. Tesla Cloud Option by @jasonacox and @mcbirse in https://github.com/jasonacox/pypowerwall/pull/59

Cloud Mode Setup - Use pypowerwall to fetch your Tesla Owners API Token

python3 -m pypowerwall setup

# Token and site information stored in .pypowerwall.auth and .pypowerwall.site

Cloud Mode Code Example

import pypowerwall

pw = pypowerwall.Powerwall(email="[email protected]",cloudmode=True)

pw.power()
# Output: {'site': 2977, 'solar': 1820, 'battery': -3860, 'load': 937}

pw.poll('/api/system_status/soe')
# Output: '{"percentage": 26.403205103271222}'

Full Changelog: https://github.com/jasonacox/pypowerwall/compare/v0.6.3...v0.7.1

What's Changed

• Add alert PVS_a036_PvArcLockout by @JordanBelford in https://github.com/jasonacox/pypowerwall/pull/33
• Create tessolarcharge.py by @venturanc in https://github.com/jasonacox/pypowerwall/pull/36
• Fix typos and spelling errors by @mcbirse in https://github.com/jasonacox/pypowerwall/pull/40
• Add alert definitions per #42 by @jasonacox in https://github.com/jasonacox/pypowerwall/pull/43
• Added two PVAC Alerts by @niabassey in https://github.com/jasonacox/pypowerwall/pull/46
• Added firmware 23.28.1 to README.md by @niabassey in https://github.com/jasonacox/pypowerwall/pull/48
• Exit proxy gracefully with SIGTERM by @rcasta74 in https://github.com/jasonacox/pypowerwall/pull/49
• v0.6.2b - Proxy Grafana Support for Dark Mode by @jasonacox in https://github.com/jasonacox/pypowerwall/pull/52
• Update README.md by @niabassey in https://github.com/jasonacox/pypowerwall/pull/53
• v0.6.3 Powerwall 3 Detection by @jasonacox in https://github.com/jasonacox/pypowerwall/pull/55 - Added scan detection for new Powerwall 3 systems. API discovery is still underway so pypowerwall currently does not support Powerwall 3s. See https://github.com/jasonacox/Powerwall-Dashboard/issues/387

$ python3 -m pypowerwall scan

pyPowerwall Network Scanner [0.6.3]
Scan local network for Tesla Powerwall Gateways

    Your network appears to be: 10.0.1.0/24

    Enter Network or press enter to use 10.0.1.0/24: 

    Running Scan...
      Host: 10.0.1.2 ... OPEN - Not a Powerwall
      Host: 10.0.1.5 ... OPEN - Found Powerwall 3 [Currently Unsupported]
      Host: 10.0.1.8 ... OPEN - Not a Powerwall
      Host: 10.0.1.9 ... OPEN - Found Powerwall 3 [Currently Unsupported]
      Done                           

Discovered 2 Powerwall Gateway
     10.0.1.5 [Powerwall-3] Firmware Currently Unsupported - See https://tinyurl.com/pw3support
     10.0.1.9 [Powerwall-3] Firmware Currently Unsupported - See https://tinyurl.com/pw3support

New Contributors

• @JordanBelford made their first contribution in https://github.com/jasonacox/pypowerwall/pull/33
• @venturanc made their first contribution in https://github.com/jasonacox/pypowerwall/pull/36
• @jasonacox made their first contribution in https://github.com/jasonacox/pypowerwall/pull/43
• @niabassey made their first contribution in https://github.com/jasonacox/pypowerwall/pull/46
• @rcasta74 made their first contribution in https://github.com/jasonacox/pypowerwall/pull/49

Full Changelog: https://github.com/jasonacox/pypowerwall/compare/v0.6.2...v0.6.3

What's Changed

• v0.6.2b - Proxy Grafana Support for Dark Mode
• Proxy t28: Add a grafana-dark style for PW_STYLE settings to accommodate placing as iframe in newer Grafana versions (e.g. v9.4.14) by @jasonacox in https://github.com/jasonacox/pypowerwall/pull/52. See https://github.com/jasonacox/Powerwall-Dashboard/discussions/371.

Full Changelog: https://github.com/jasonacox/pypowerwall/compare/v0.6.2a...v0.6.2b

What's Changed

• Add alert PVS_a036_PvArcLockout by @JordanBelford in https://github.com/jasonacox/pypowerwall/pull/33
• Create tessolarcharge.py by @venturanc in https://github.com/jasonacox/pypowerwall/pull/36 & https://github.com/jasonacox/pypowerwall/pull/37 & https://github.com/jasonacox/pypowerwall/pull/38
• Fix typos and spelling errors by @mcbirse in https://github.com/jasonacox/pypowerwall/pull/40
• Add alert definitions per #42 by @jasonacox in https://github.com/jasonacox/pypowerwall/pull/43
• Added two PVAC Alerts by @niabassey in https://github.com/jasonacox/pypowerwall/pull/46
• Added Firmware 23.28.1 to README.md by @niabassey in https://github.com/jasonacox/pypowerwall/pull/48
• Add proxy gracefully exit with SIGTERM by @rcasta74 in https://github.com/jasonacox/pypowerwall/pull/49

New Contributors

• @JordanBelford made their first contribution in https://github.com/jasonacox/pypowerwall/pull/33
• @venturanc made their first contribution in https://github.com/jasonacox/pypowerwall/pull/36
• @niabassey made their first contribution in https://github.com/jasonacox/pypowerwall/pull/46
• @rcasta74 made their first contribution in https://github.com/jasonacox/pypowerwall/pull/49

Full Changelog: https://github.com/jasonacox/pypowerwall/compare/v0.6.2...v0.6.2a

What's Changed

• PyPI 0.6.2
• Update docs for alerts by @DerickJohnson in https://github.com/jasonacox/pypowerwall/pull/29 and https://github.com/jasonacox/pypowerwall/pull/30
• Proxy t25 - Fix Cache-Control no-cache header and allow for setting max-age, fixes #31 by @dkerr64 in https://github.com/jasonacox/pypowerwall/pull/32 - Docker: jasonacox/pypowerwall:0.6.2t25

New Contributors

• @dkerr64 made their first contribution in https://github.com/jasonacox/pypowerwall/pull/32

Full Changelog: https://github.com/jasonacox/pypowerwall/compare/v0.6.1...v0.6.2

What's Changed

• PyPI 0.6.1
• Added new SystemMicroGridFaulted and SystemWaitForUser grid conditions to grid_status() function. Both are mapped to "DOWN" conditions. Discovery by @mcbrise in https://github.com/jasonacox/Powerwall-Dashboard/issues/158#issuecomment-1441648085.
• Revised error handling of SITE_DATA request due to issues noted in #12 when multiple sites are linked to the Tesla account by @mcbirse in https://github.com/jasonacox/pypowerwall/pull/25
• Proxy t24: Added new /alerts/pw endpoint with dictionary/object response format by @DerickJohnson in https://github.com/jasonacox/pypowerwall/pull/26

New Contributors

• @DerickJohnson made their first contribution in https://github.com/jasonacox/pypowerwall/pull/26

Full Changelog: https://github.com/jasonacox/pypowerwall/compare/v0.6.0...v0.6.1

What's Changed

• PyPI 0.6.0
• Added HTTP persistent connections for API requests to Powerwall Gateway by @mcbirse in https://github.com/jasonacox/pypowerwall/pull/21
• Requests to Gateway will now re-use persistent http connections which reduces load and increases response time.
• Uses default connection poolmaxsize=10 to align with Session object defaults. Note: pool use applies to multi-threaded use of pyPowerwall only, e.g. as with the pyPowerwall Proxy Server.
• Added env PW_POOL_MAXSIZE to proxy server to allow this to be controlled (persistent connections disabled if set to zero).
• Added env PW_TIMEOUT to proxy server to allow timeout on requests to be adjusted.

Full Changelog: https://github.com/jasonacox/pypowerwall/compare/v0.5.1...v0.6.0

What's Changed

• PyPI 0.5.1
• Add FreeBSD-specific installation instructions by @zi0r in https://github.com/jasonacox/pypowerwall/pull/18
• Add grid_status() responses for syncing to off-grid by @mcbirse in https://github.com/jasonacox/pypowerwall/pull/19

New Contributors

• @mcbirse made their first contribution in https://github.com/jasonacox/pypowerwall/pull/19

Full Changelog: https://github.com/jasonacox/pypowerwall/compare/v0.5.0...v0.5.1