pypowerwall

What's Changed

• Check if activeAlerts exists before listing alerts by @rmotapar in https://github.com/jasonacox/pypowerwall/pull/112
• TEDAPI: Fix bug with activeAlerts logic causing errors on systems with multiple Powerwall 3's. Identified by @rmotapar in https://github.com/jasonacox/Powerwall-Dashboard/issues/387#issuecomment-2336431741
• FleetAPI: Fix connect() to handle non-energy products in the getsites response. Identified by @gregrahn in https://github.com/jasonacox/pypowerwall/issues/111

New Contributors

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

Full Changelog: https://github.com/jasonacox/pypowerwall/compare/v0.11.0...v0.11.1

What's Changed

• Add PW3 Vitals by @jasonacox in https://github.com/jasonacox/pypowerwall/pull/110
• Add polling of Powerwall 3 Devices to pull in PW3 specific string data, PW capacity, voltages, frequencies, and alerts.
• This creates TEPOD, PVAC and PVS compatible payloads available in vitals().

Proxy URLs updated for PW3:

• http://localhost:8675/vitals
• http://localhost:8675/help (verify pw3 shows True)
• http://localhost:8675/tedapi/components
• http://localhost:8675/tedapi/battery

Full Changelog: https://github.com/jasonacox/pypowerwall/compare/v0.10.10...v0.11.0

What's Changed

• Add Grid Control Functions by @jasonacox in https://github.com/jasonacox/pypowerwall/pull/109
• Add functions and command line options to allow user to get and set grid charging and exporting modes (re: https://github.com/jasonacox/pypowerwall/issues/108).
• Supports FleetAPI and Cloud modes only (not Local mode)

Command Line Examples

# Connect to Cloud
python3 -m pypowerwall setup # or fleetapi

# Get Current Settings
python3 -m pypowerwall get

# Turn on Grid charging
python3 -m pypowerwall set -gridcharging on

# Turn off Grid charging
python3 -m pypowerwall  set -gridcharging off

# Set Grid Export to Solar (PV) energy only
python3 -m pypowerwall set -gridexport pv_only

# Set Grid Export to Battery and Solar energy
python3 -m pypowerwall set -gridexport battery_ok

# Disable export of all energy to grid
python3 -m pypowerwall set -gridexport never

Programming Examples

import pypowerwall

# FleetAPI Mode
PW_HOST=""
PW_EMAIL="[email protected]"
pw = pypowerwall.Powerwall(host=PW_HOST, email=PW_EMAIL, fleetapi=True)

# Get modes
pw.get_grid_charging()
pw.get_grid_export()

# Set modes
pw.set_grid_charging("on") # set grid charging mode (on or off)
pw.set_grid_export("pv_only")   # set grid export mode (battery_ok, pv_only, or never)

Full Changelog: https://github.com/jasonacox/pypowerwall/compare/v0.10.9...v0.10.10

What's Changed

• Add computed voltage and current to /api/meters/aggregates from TEDAPI status data by @jasonacox in https://github.com/jasonacox/pypowerwall/pull/107
• Fix error in num_meters_aggregated calculation in aggregates.

Full Changelog: https://github.com/jasonacox/pypowerwall/compare/v0.10.8...v0.10.9

What's Changed

• TEDAPI functions for firmware version and PW3 by @jasonacox in https://github.com/jasonacox/pypowerwall/pull/106
• Add TEDAPI get_firmware_version() to poll Powerwall for firmware version. Discovered by @geptto in https://github.com/jasonacox/pypowerwall/issues/97. This function has been integrated into pypowerwall existing APIs (e.g. pw.version())
• Add TEDAPI get_components() and get_battery_block() functions which provide additional Powerwall 3 related device vital information for Powerwall 3 owners. Discovered by @lignumaqua in https://github.com/jasonacox/Powerwall-Dashboard/discussions/392#discussioncomment-9864364. The plan it to integrate this data into the other device vitals payloads for PW3 systems (TODO).

Full Changelog: https://github.com/jasonacox/pypowerwall/compare/v0.10.7...v0.10.8

What's Changed

• Add power history retrieval to FleetAPI by @jasonacox in https://github.com/jasonacox/pypowerwall/pull/105
• FleetAPI - Add get_history() and get_calendar_history() to return energy, power, soe, and other history data.

import pypowerwall

pw = pypowerwall.Powerwall(host=PW_HOST, email=PW_EMAIL, fleetapi=True)
pw.client.fleet.get_calendar_history(kind="soe")
pw.client.fleet.get_history(kind="power")

Full Changelog: https://github.com/jasonacox/pypowerwall/compare/v0.10.6...v0.10.7

What's Changed

• Address pyLint cleanup and minor bug fixes by @jasonacox in https://github.com/jasonacox/pypowerwall/pull/103
• TEDAPI get_reserve() fix to address unscaled battery backup reserve level results.
• Address pyLint Cleanup of Code.
• Proxy: Command mode error handling.
• Cloud Mode: Fix logic for selecting FleetAPI mode
• Add request timeout settings to FleetAPI and TEDAPI calls.

Full Changelog: https://github.com/jasonacox/pypowerwall/compare/v0.10.5...v0.10.6

What's Changed

• v0.10.5 - Minor Fixes by @jasonacox in https://github.com/jasonacox/pypowerwall/pull/102
• Fix for TEDAPI "full" (e.g. Powerwall 3) mode, including grid_status bug resulting in false reports of grid status, level() bug where data gap resulted in 0% state of charge and alerts() where data gap from tedapi resulted in a null alert.
• Add TEDAPI API call locking to limit load caused by concurrent polling.
• Proxy - Add battery full_pack and remaining energy data to /pod API call for all cases.

Full Changelog: https://github.com/jasonacox/pypowerwall/compare/v0.10.4...v0.10.5

What's Changed

• Add Powerwall 3 Local API Support by @jasonacox in https://github.com/jasonacox/pypowerwall/pull/101
• TEDAPI will activate in hybrid (using TEDAPI for vitals and existing local APIs for other metrics) or full (all data from TEDAPI) mode to provide better Powerwall 3 support.
• The full mode will automatically activate when the customer password is blank and gw_pwd is set.
• Note: The full mode will provide less metrics than hybrid mode since Powerwall 2/+ systems have additional APIs that are used in hybrid mode to fetch additional data

import pypowerwall

# Activate HYBRID mode (for Powerwall / 2 / + systems)
pw = pypowerwall.Powerwall("192.168.91.1", password=PASSWORD, email=EMAIL, gw_pwd=PW_GW_PWD)

# Activate FULL mode (for all systems including Powerwall 3)
pw = pypowerwall.Powerwall("192.168.91.1", gw_pwd=PW_GW_PWD)

Related:

• #97
• https://github.com/jasonacox/Powerwall-Dashboard/issues/387

Full Changelog: https://github.com/jasonacox/pypowerwall/compare/v0.10.3...v0.10.4

What's Changed

• v0.10.3 - TEDAPI Connect by @jasonacox in https://github.com/jasonacox/pypowerwall/pull/100
• Update setup.py to include dependencies on protobuf>=3.20.0.
• Fix TEDAPI connect() logic error to better validate PW3 Gateway endpoint access as raised in #97 by @ttl74ls100
• Add documentation for TEDAPI setup.
• Update CLI to support TEDAPI calls.
• Proxy t60 - Fix edge case where /csv API will error due to NoneType inputs.
• Add TEDAPI argument to set custom GW IP address.

# Connect to TEDAPI and pull data
python3 -m pypowerwall tedapi

# Direct call to TEDAPI class test function (optional password)
python3 -m pypowerwall.tedapi GWPASSWORD
python3 -m pypowerwall.tedapi --debug
python3 -m pypowerwall.tedapi --gw_ip 192.168.91.1 --debug

Full Changelog: https://github.com/jasonacox/pypowerwall/compare/v0.10.2...v0.10.3

What's Changed

• Fix FleetAPI Setup by @jasonacox in https://github.com/jasonacox/pypowerwall/pull/99 as raised in https://github.com/jasonacox/pypowerwall/issues/98.
• Update FleetAPI documentation and CLI usage.

Full Changelog: https://github.com/jasonacox/pypowerwall/compare/v0.10.1...v0.10.2

What's Changed

• v0.10.1 - TEDAPI Vitals Hotfix by @jasonacox in https://github.com/jasonacox/pypowerwall/pull/96
• Fix PVAC lookup error logic in TEDAPI class vitals() function.
• Add alerts and other elements to PVAC TETHC TESYNC vitals.
• Update vitals Neurio block to include correct location and adjust RealPower based on power scale factor.

Full Changelog: https://github.com/jasonacox/pypowerwall/compare/v0.10.0...v0.10.1

What's Changed

• v0.10.0 - New Device Vitals by @jasonacox in https://github.com/jasonacox/pypowerwall/pull/95
• Add support for /tedapi API access on Gateway (requires connectivity to 192.168.91.1 GW and Gateway Password) with access to "config" and "status" data.
• Adds drop-in replacement for depreciated /vitals API and payload using the new TEDAPI class. This allows easy access to Powerwall device vitals.
• Proxy update to t58 to support TEDAPI with environmental variable PW_GW_PWD for Gateway Password. Also added FleetAPI, Cloud and TEDAPI specific GET calls, /fleetapi, /cloud, and /tedapi respectively.

# How to Activate the TEDAPI Mode
import pypowerwall

# You will need the Gateway/WiFi Password usually found on QR code on Gateway (not the customer password)
gw_pwd = "GW_PASSWORD" 

# Direct Connect to GW
host = "192.168.91.1" 
pw = pypowerwall.Powerwall(host,password,email,timezone,gw_pwd=gw_pwd)
print(pw.vitals())

# New TEDAPI Class
import pypowerwall.tedapi

tedapi = pypowerwall.tedapi.TEDAPI("GW_PASSWORD")

config = tedapi.get_config()
status = tedapi.get_status()

meterAggregates = status.get('control', {}).get('meterAggregates', [])
for meter in meterAggregates:
    location = meter.get('location', 'Unknown').title()
    realPowerW = int(meter.get('realPowerW', 0))
    print(f"   - {location}: {realPowerW}W")

Full Changelog: https://github.com/jasonacox/pypowerwall/compare/v0.9.1...v0.10.0

What's Changed

• v0.9.1 Bug Fixes and Updates by @jasonacox in https://github.com/jasonacox/pypowerwall/pull/94
• Fix bug in time_remaining_hours() and convert print statements in FleetAPI to log messages.
• Fix CLI bug related to site_id as raised by @darroni in https://github.com/jasonacox/pypowerwall/issues/93
• Add CLI option for local mode to get status:

python -m pypowerwall get -host 10.1.2.3 -password 'myPassword'

Full Changelog: https://github.com/jasonacox/pypowerwall/compare/v0.9.0...v0.9.1

What's Changed

• v0.9.0 - Tesla (official) FleetAPI cloud mode support by @jasonacox in https://github.com/jasonacox/pypowerwall/pull/91 - This adds the FleetAPI class and mapping for pypowerwall.
• FleetAPI setup provided by module CLI: python -m pypowerwall fleetapi
• Adds auto_select mode for instatiating a Powerwall connection: local mode, fleetapi mode and cloud mode. Provides pw.mode class variable as the mode selected.

    import pypowerwall

    # Option 1 - LOCAL MODE - Credentials for your Powerwall - Customer Login
    password="password"
    email="[email protected]"
    host = "10.0.1.123"               # Address of your Powerwall Gateway
    timezone = "America/Los_Angeles"  # Your local timezone

    # Option 2 - FLEETAPI MODE - Requires Setup
    host = password = email = ""
    timezone = "America/Los_Angeles" 

    # Option 3 - CLOUD MODE - Requires Setup
    host = password = ""
    email='[email protected]'
    timezone = "America/Los_Angeles"
 
    # Connect to Powerwall - auto_select mode (local, fleetapi, cloud)
    pw = pypowerwall.Powerwall(host,password,email,timezone,auto_select=True)

    print(f"Connected to Powerwall with mode: {pw.mode}")

Full Changelog: https://github.com/jasonacox/pypowerwall/compare/v0.8.5...v0.9.0

What's Changed

• v0.8.5 - Fix bug with setup for certain Solar Only systems by @jasonacox in https://github.com/jasonacox/pypowerwall/pull/92
• Fix bug with setup for certain Solar Only systems where setup process fails. Identified by @hulkster in https://github.com/jasonacox/Powerwall-Dashboard/discussions/475

Full Changelog: https://github.com/jasonacox/pypowerwall/compare/v0.8.4...v0.8.5

What's Changed

• v0.8.4 by @jasonacox in https://github.com/jasonacox/pypowerwall/pull/86
• Updated set_reserve(level) logic to handle levels from 0 to 100. Identified by @spoonwzd in #85

Proxy t55 (4 May 2024)

• Fix /pod API to add time_remaining_hours and backup_reserve_percent for cloud mode.
• Replaced t54 - Move control to POST per @KevM in https://github.com/jasonacox/pypowerwall/issues/87
• Added GET APIs to retrieve backup reserve and operating mode settings
• Added POST command APIs to set backup reserve and operating mode settings. Requires setting PW_CONTROL_SECRET for the proxy. Use with caution.

# Set Mode
export MODE=self_consumption
export RESERVE=20
export PW_CONTROL_SECRET=mySecretKey

curl -X POST -d "value=$MODE&token=$PW_CONTROL_SECRET" http://localhost:8675/control/mode

# Set Reserve
curl -X POST -d "value=$RESERVE&token=$PW_CONTROL_SECRET" http://localhost:8675/control/reserve

# Read Settings
curl http://localhost:8675/control/mode
curl http://localhost:8675/control/reserve

Full Changelog: https://github.com/jasonacox/pypowerwall/compare/v0.8.3...v0.8.4

What's Changed

• v0.8.3 - Control APIs by @jasonacox in https://github.com/jasonacox/pypowerwall/pull/83
• Added additional error handling logic to clean up exceptions #81

Proxy (t54):

• Fix /pod API to add time_remaining_hours and backup_reserve_percent for cloud mode.
• Added control APIs to set backup reserve and operating mode settings. Requires setting PW_CONTROL_SECRET. Use with caution! #79

# Set Mode
curl "http://localhost:8675/control/mode?token=$PW_CONTROL_SECRET&value=self_consumption"

# Set Reserve
curl "http://localhost:8675/control/reserve?token=$PW_CONTROL_SECRET&value=20"

# Omit Value to Read Settings
curl "http://localhost:8675/control/mode?token=$PW_CONTROL_SECRET"
curl "http://localhost:8675/control/reserve?token=$PW_CONTROL_SECRET"

Full Changelog: https://github.com/jasonacox/pypowerwall/compare/v0.8.2...v0.8.3

What's Changed

• Handle 503 Errors and Disabled Powerwall APIs by @jasonacox in https://github.com/jasonacox/pypowerwall/pull/80
• Added 5 minute cooldown for HTTP 503 Service Unavailable errors from API calls.
• Proxy: Added DISABLED API handling logic.

Full Changelog: https://github.com/jasonacox/pypowerwall/compare/v0.8.1...v0.8.2

What's Changed

• v0.8.1 - Set battery reserve, operation mode by @emptywee in https://github.com/jasonacox/pypowerwall/pull/78
• Added get_mode(), set_mode(),set_reserve(),and set_operation() function to set battery operation mode and/or reserve level by @emptywee in https://github.com/jasonacox/pypowerwall/pull/78. Likely won't work in the local mode.
• Added basic validation for main class __init__() parameters (a.k.a. user input).
• Better handling of 401/403 errors from Powerwall in local mode.
• Handle 50x errors from Powerwall in local mode.
• Added Alerts for Grid Status alerts().
• New command line functions (set and get):

usage: PyPowerwall [-h] {setup,scan,set,get,version} ...

PyPowerwall Module v0.8.1

options:
  -h, --help            show this help message and exit

commands (run <command> -h to see usage information):
  {setup,scan,set,get,version}
    setup               Setup Tesla Login for Cloud Mode access
    scan                Scan local network for Powerwall gateway
    set                 Set Powerwall Mode and Reserve Level
    get                 Get Powerwall Settings and Power Levels
    version             Print version information

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