pypowerwall 0.11.1

Python module to access Tesla Energy Gateway for Powerwall and solar power data

pyPowerwall

Python module to interface with Tesla Energy Gateways for Powerwall and solar power data. Currently supporting local access to Powerwall, Powerwall 2 and Powerwall+ systems and Tesla Owner cloud API for all systems including Solar Only and Powerwall 3 systems.

Description

This python module can be used to monitor and control Tesla Energy Powerwalls. It uses a single class (Powerwall) and simple functions to fetch energy data and poll API endpoints on the Gateway.

pyPowerwall will cache the authentication headers and API call responses to help reduce the number of calls made to the Gateway (useful if you are polling the Powerwall frequently for trending data).

• Works with Tesla Energy Gateways - Powerwall and Powerwall+
• Access provided via Local Gateway API, Tesla FleetAPI (official), and Tesla Owners API (unofficial).
• Will cache authentication to reduce load on Powerwall Gateway
• Will cache responses to limit number of calls to Powerwall Gateway or Cloud (optional/user definable)
• Will re-use http connections to Powerwall Gateway for reduced load and faster response times
• Provides solar string data for Powerwall+ systems.

Setup

You can clone this repo or install the package with pip. Once installed, pyPowerwall can scan your local network to find th IP address of your Tesla Powerwall Gateway.

# Install pyPowerwall
python3 -m pip install pypowerwall

# Option 1 - LOCAL MODE - Scan Network for Powerwalls
python3 -m pypowerwall scan

# Option 2 - FLEETAPI MODE - Setup to use the official Tesla FleetAPI - See notes below.
python3 -m pypowerwal fleetapi

# Option 3 - CLOUD MODE -  Setup to use Tesla Owners cloud API
python3 -m pypowerwall setup

Local Setup - Option 1

The Tesla Powerwall, Powerwall 2 and Powerwall+ have a local LAN based API that you can use to monitor your Powerwall. It requires that you (or your installer) have the IP address (see scan above) and set up Customer Login credentials on your Powerwall Gateway. That is all that is needed to connect. Unfortunately, the Powerwall 3 does not have a local API but you can access it via the cloud (see options 2 and 3).

Extended Device Vitals Metrics: With version v0.10.0+, pypowerwall can be set to access the TEDAPI on the Gateway to pull additional metrics. However, you will need the Gateway Password (often found on the QR sticker on the Powerwall Gateway). Additionally, your computer will need network access to the Gateway IP (192.168.91.1). You can have your computer join the Gateway local WiFi or you can add a route:

# Example - Change 192.168.0.100 to the IP address of Powerwall Gateway on your LAN

# Linux Ubuntu and RPi - Can add to /etc/rc.local for persistence 
sudo ip route add 192.168.91.1 via 192.168.0.100

# MacOS 
sudo route add -host 192.168.91.1 192.168.0.100 # Temporary 
networksetup -setadditionalroutes Wi-Fi 192.168.91.1 255.255.255.255 192.168.0.100 # Persistent

# Windows - Using persistence flag - Administrator Shell
route -p add 192.168.91.1 mask 255.255.255.255 192.168.0.100

FleetAPI Setup - Option 2

FleetAPI is the official Tesla API for accessing your Tesla products. This setup has some additional setup requirements that you will be prompted to do:

Step 1 - Tesla Partner Account - Sign in to Tesla Developer Portal and make an App Access Request: See Tesla App Access Request - During this process, you will need to set up and remember the following account settings:

• CLIENT_ID - This will be provided to you by Tesla when your request is approved.
• CLIENT_SECRET - Same as above.
• DOMAIN - The domain name of a website your own and control.
• REDIRECT_URI - This is the URL that Tesla will direct you to after you authenticate. This landing URL (on your website) will extract the GET variable code, which is a one-time use authorization code needed during the pyPowerwall setup. You can use index.html on your site and update REDIRECT_URI with that url. Alternatively, you can just copy the URL from the 404 page during the authorization process (the code is in the URL).

Step 2 - Run the create_pem_key.py script and place the public key on your website at the URL: https://{DOMAIN}/.well-known/appspecific/com.tesla.3p.public-key.pem

Step 3 - Run python3 -m pypowerwal fleetapi - The credentials and tokens will be stored in the .pypowerwall.fleetapi file.

Cloud Mode - Option 3

The unofficial Tesla Owners API allows FleetAPI access (option 2) without having to set up a website and PEM key. Follow the directions given to you by running python3 -m pypowerwall setup. The credentials and site_id will be stored in .pypowerwall.auth and .pypowerwall.site.

FreeBSD Install

FreeBSD users can install from ports or pkg FreshPorts:

Via pkg:

# pkg install net-mgmt/py-pypowerwall

Via ports:

# cd /usr/ports/net-mgmt/py-pypowerwall/ && make install clean

Note: pyPowerwall installation will attempt to install these required python packages: requests, protobuf and teslapy.

Programming with pyPowerwall

After importing pypowerwall, you simply create a handle for your Powerwall device and call function to poll data. Here is an example:

    import pypowerwall

    # Optional: Turn on Debug Mode
    # pypowerwall.set_debug(True)

    # Option 1 - LOCAL MODE - Credentials for your Powerwall - Customer Login
    password="password"
    email="[e-mail]"
    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='[e-mail]'
    timezone = "America/Los_Angeles"
 
    # Connect to Powerwall - auto_select mode (local, fleetapi, cloud)
    pw = pypowerwall.Powerwall(host,password,email,timezone,auto_select=True)

    # Some System Info
    print("Site Name: %s - Firmware: %s - DIN: %s" % (pw.site_name(), pw.version(), pw.din()))
    print("System Uptime: %s\n" % pw.uptime())

    # Pull Sensor Power Data
    grid = pw.grid()
    solar = pw.solar()
    battery = pw.battery()
    home = pw.home()

    # Display Data
    print("Battery power level: %0.0f%%" % pw.level())
    print("Combined power metrics: %r" % pw.power())
    print("")

    # Display Power in kW
    print("Grid Power: %0.2fkW" % (float(grid)/1000.0))
    print("Solar Power: %0.2fkW" % (float(solar)/1000.0))
    print("Battery Power: %0.2fkW" % (float(battery)/1000.0))
    print("Home Power: %0.2fkW" % (float(home)/1000.0))
    print("")

    # Raw JSON Payload Examples
    print("Grid raw: %r\n" % pw.grid(verbose=True))
    print("Solar raw: %r\n" % pw.solar(verbose=True))

    # Display Device Vitals
    print("Vitals: %r\n" % pw.vitals())

    # Display String Data
    print("String Data: %r\n" % pw.strings())

pyPowerwall Module Class and Functions

 set_debug(True, color=True)

 Classes
    Powerwall(host, password, email, timezone, pwcacheexpire, timeout, poolmaxsize, 
               cloudmode, siteid, authpath, authmode, cachefile, fleetapi, auto_select)

 Parameters
    host                      # Hostname or IP of the Tesla gateway
    password                  # Customer password for gateway
    email                     # (required) Customer email for gateway / cloud
    timezone                  # Desired timezone
    pwcacheexpire = 5         # Set API cache timeout in seconds
    timeout = 5               # Timeout for HTTPS calls in seconds
    poolmaxsize = 10          # Pool max size for http connection re-use (persistent
                                connections disabled if zero)
    cloudmode = False         # If True, use Tesla cloud for data (default is False)
    siteid = None             # If cloudmode is True, use this siteid (default is None)
    authpath = ""             # Path to cloud auth and site files (default current directory)
    authmode = "cookie"       # "cookie" (default) or "token" - use cookie or bearer token for auth
    cachefile = ".powerwall"  # Path to cache file (default current directory)
    fleetapi = False          # If True, use Tesla FleetAPI for data (default is False)
    auto_select = False       # If True, select the best available mode to connect (default is False)

 Functions 
    poll(api, json, force)    # Return data from Powerwall api (dict if json=True, bypass cache force=True)
    post(api, payload, json)  # Send payload to Powerwall api (dict if json=True)
    level()                   # Return battery power level percentage
    power()                   # Return power data returned as dictionary
    site(verbose)             # Return site sensor data (W or raw JSON if verbose=True)
    solar(verbose):           # Return solar sensor data (W or raw JSON if verbose=True)
    battery(verbose):         # Return battery sensor data (W or raw JSON if verbose=True)
    load(verbose)             # Return load sensor data (W or raw JSON if verbose=True)
    grid()                    # Alias for site()
    home()                    # Alias for load()
    vitals(json)              # Return Powerwall device vitals (dict or json if True)
    strings(json, verbose)    # Return solar panel string data
    din()                     # Return DIN
    uptime()                  # Return uptime - string hms format
    version()                 # Return system version
    status(param)             # Return status (JSON) or individual param
    site_name()               # Return site name
    temps()                   # Return Powerwall Temperatures
    alerts()                  # Return array of Alerts from devices
    system_status(json)       # Returns the system status
    battery_blocks(json)      # Returns battery specific information merged from system_status() and vitals()
    grid_status(type)         # Return the power grid status, type ="string" (default), "json", or "numeric"
                              #     - "string": "UP", "DOWN", "SYNCING"
                              #     - "numeric": -1 (Syncing), 0 (DOWN), 1 (UP)
    is_connected()            # Returns True if able to connect and login to Powerwall
    get_reserve(scale)        # Get Battery Reserve Percentage
    get_mode()                # Get Current Battery Operation Mode
    set_reserve(level)        # Set Battery Reserve Percentage
    set_mode(mode)            # Set Current Battery Operation Mode
    get_time_remaining()      # Get the backup time remaining on the battery
    set_operation(level, mode, json)  # Set Battery Reserve Percentage and/or Operation Mode
    set_grid_charging(mode)   # Enable or disable grid charging (mode = True or False)
    set_grid_export(mode)     # Set grid export mode (mode = battery_ok, pv_only, never)
    get_grid_charging()       # Get the current grid charging mode
    get_grid_export()         # Get the current grid export mode

Tools

The following are some useful tools based on pypowerwall:

• Powerwall Proxy - Use this caching proxy to handle authentication to the Powerwall Gateway and make basic read-only API calls to /api/meters/aggregates (power metrics), /api/system_status/soe (battery level) and many others. This is useful for metrics gathering tools like telegraf to pull metrics without needing to authenticate. Because pyPowerwall is designed to cache the auth and high frequency API calls, this will also reduce the load on the Gateway and prevent crash/restart issues that can happen if too many session are created on the Gateway.

• Powerwall Simulator - A Powerwall simulator to mimic the responses from the Tesla Powerwall Gateway. This is useful for testing purposes.

• Powerwall Dashboard - Monitoring Dashboard for the Tesla Powerwall using Grafana, InfluxDB, Telegraf and pyPowerwall.

Powerwall Command Line

pyPowerwall has a built in feature to scan your network for available Powerwall gateways and set/get operational and reserve modes.

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

   set options:
      -mode MODE          Powerwall Mode: self_consumption, backup, or autonomous
      -reserve RESERVE    Set Battery Reserve Level [Default=20]
      -current            Set Battery Reserve Level to Current Charge
      -gridcharging MODE  Set Grid Charging (allow) Mode ("on" or "off")
      -gridexport MODE    Set Export to Grid Mode ("battery_ok", "pv_only", or "never")

   get options:
      -format FORMAT      Output format: text, json, csv
      -host HOST          IP address of Powerwall Gateway
      -password PASSWORD  Password for Powerwall Gateway

# Install pyPowerwall if you haven't already
python -m pip install pypowerwall

# Scan Network for Powerwalls
python -m pypowerwall scan

Example Output

pyPowerwall Network Scanner [0.1.2]
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.16 ... OPEN - Not a Powerwall
      Host: 10.0.1.26 ... OPEN - Not a Powerwall
      Host: 10.0.1.36 ... OPEN - Found Powerwall 1232100-00-E--TG123456789ABG
      Done                           

Discovered 1 Powerwall Gateway
     10.0.1.36 [1232100-00-E--TG123456789ABG]

Get Power Levels, Operation Mode, and Battery Reserve Level

# Setup Connection with Tesla Cloud
python -m pypowerwall setup

# Get Power Levels, Operation Mode, and Battery Reserve Setting
#
# Usage: PyPowerwall get [-h] [-format FORMAT]
#  -h, --help      show this help message and exit
#  -format FORMAT  Output format: text, json, csv
#
python -m pypowerwall get
python -m pypowerwall get -format json
python -m pypowerwall get -format csv

# Set Operation Mode and Battery Reserve Setting
#
# Usage: PyPowerwall set [-h] [-mode MODE] [-reserve RESERVE] [-current]
#  -h, --help        show this help message and exit
#  -mode MODE        Powerwall Mode: self_consumption, backup, or autonomous
#  -reserve RESERVE  Set Battery Reserve Level [Default=20]
#  -current          Set Battery Reserve Level to Current Charge
#
python -m pypowerwall set -mode self_consumption
python -m pypowerwall set -reserve 30
python -m pypowerwall set -current

Example API Calls

The following APIs are a result of help from other projects as well as my own investigation.

• pw.poll('/api/system_status/soe') - Battery percentage (JSON with float 0-100)

  {"percentage":40.96227949234631}
  

• pw.poll('/api/meters/aggregates') - Site, Load, Solar and Battery (JSON)

  {
     "site": {
        "last_communication_time": "2021-11-22T22:15:06.590577619-07:00",
        "instant_power": -23,
        "instant_reactive_power": -116,
        "instant_apparent_power": 118.25819210524064,
        "frequency": 0,
        "energy_exported": 3826.313294918422,
        "energy_imported": 1302981.2128324094,
        "instant_average_voltage": 209.59546822390985,
        "instant_average_current": 5.4655000000000005,
        "i_a_current": 0,
        "i_b_current": 0,
        "i_c_current": 0,
        "last_phase_voltage_communication_time": "0001-01-01T00:00:00Z",
        "last_phase_power_communication_time": "0001-01-01T00:00:00Z",
        "timeout": 1500000000,
        "num_meters_aggregated": 1,
        "instant_total_current": 5.4655000000000005
     },
     "battery": {
        "last_communication_time": "2021-11-22T22:15:06.590178016-07:00",
        "instant_power": 1200,
        "instant_reactive_power": 0,
        "instant_apparent_power": 1200,
        "frequency": 59.997,
        "energy_exported": 635740,
        "energy_imported": 730610,
        "instant_average_voltage": 242.15000000000003,
        "instant_average_current": -28.6,
        "i_a_current": 0,
        "i_b_current": 0,
        "i_c_current": 0,
        "last_phase_voltage_communication_time": "0001-01-01T00:00:00Z",
        "last_phase_power_communication_time": "0001-01-01T00:00:00Z",
        "timeout": 1500000000,
        "num_meters_aggregated": 2,
        "instant_total_current": -28.6
     },
     "load": {
        "last_communication_time": "2021-11-22T22:15:06.590178016-07:00",
        "instant_power": 1182.5,
        "instant_reactive_power": -130.5,
        "instant_apparent_power": 1189.6791584288599,
        "frequency": 0,
        "energy_exported": 0,
        "energy_imported": 2445454.899537491,
        "instant_average_voltage": 209.59546822390985,
        "instant_average_current": 5.641820455472543,
        "i_a_current": 0,
        "i_b_current": 0,
        "i_c_current": 0,
        "last_phase_voltage_communication_time": "0001-01-01T00:00:00Z",
        "last_phase_power_communication_time": "0001-01-01T00:00:00Z",
        "timeout": 1500000000,
        "instant_total_current": 5.641820455472543
     },
     "solar": {
        "last_communication_time": "2021-11-22T22:15:06.594908129-07:00",
        "instant_power": 10,
        "instant_reactive_power": 0,
        "instant_apparent_power": 10,
        "frequency": 59.988,
        "energy_exported": 1241170,
        "energy_imported": 0,
        "instant_average_voltage": 241.60000000000002,
        "instant_average_current": 0.04132231404958678,
        "i_a_current": 0,
        "i_b_current": 0,
        "i_c_current": 0,
        "last_phase_voltage_communication_time": "0001-01-01T00:00:00Z",
        "last_phase_power_communication_time": "0001-01-01T00:00:00Z",
        "timeout": 1000000000,
        "num_meters_aggregated": 1,
        "instant_total_current": 0.04132231404958678
     }
  }
  

• pw.strings(jsonformat=True)

  {
     "A": {
        "Connected": true,
        "Current": 1.81,
        "Power": 422.0,
        "State": "PV_Active",
        "Voltage": 230.0
     },
     "B": {
        "Connected": false,
        "Current": 0.0,
        "Power": 0.0,
        "State": "PV_Active",
        "Voltage": -2.5
     },
     "C": {
        "Connected": true,
        "Current": 4.47,
        "Power": 892.0,
        "State": "PV_Active",
        "Voltage": 202.4
     },
     "D": {
        "Connected": true,
        "Current": 4.44,
        "Power": 889.0,
        "State": "PV_Active_Parallel",
        "Voltage": 202.10000000000002
     }
  }
  

• pw.temps(jsonformat=True)

  {
     "TETHC--2012170-25-E--TGxxxxxxxxxxxx": 17.5,
     "TETHC--3012170-05-B--TGxxxxxxxxxxxx": 17.700000000000003
  }
  

• pw.status(jsonformat=True)

  {
     "din": "1232100-00-E--TGxxxxxxxxxxxx",
     "start_time": "2022-01-05 09:20:47 +0800",
     "up_time_seconds": "62h48m24.076725628s",
     "is_new": false,
     "version": "21.44.1 c58c2df3",
     "git_hash": "c58c2df39ec207708c4cde0c747db7cf31750f29",
     "commission_count": 8,
     "device_type": "teg",
     "sync_type": "v2.1",
     "leader": "",
     "followers": null,
     "cellular_disabled": false
  }
  

• pw.vitals(jsonformat=True)

  • Example Output: here
  • Produces device vitals and alerts. For more information see here.

• pw.grid_status(type="json")

  {
   "grid_services_active": false,
   "grid_status": "SystemGridConnected"
  }
  

• pw.system_status(jsonformat=True)

  {
   "all_enable_lines_high": true,
   "auxiliary_load": 0,
   "available_blocks": 2,
   "battery_blocks": [
       {
           "OpSeqState": "Active",
           "PackagePartNumber": "3012170-10-B",
           "PackageSerialNumber": "TG122xxx", 
           "Type": "",
           "backup_ready": true,
           "charge_power_clamped": false,
           "disabled_reasons": [],
           "energy_charged": 21410,
           "energy_discharged": 950,
           "f_out": 60.016999999999996,
           "i_out": 6.800000000000001,
           "nominal_energy_remaining": 13755,
           "nominal_full_pack_energy": 13803,
           "off_grid": false,
           "p_out": -370,
           "pinv_grid_state": "Grid_Compliant",
           "pinv_state": "PINV_GridFollowing",
           "q_out": -10,
           "v_out": 243.60000000000002,
           "version": "b0ec24329c08e4",
           "vf_mode": false,
           "wobble_detected": false
       },
       {
           "OpSeqState": "Active",
           "PackagePartNumber": "3012170-10-B",
           "PackageSerialNumber": "TG122yyy", 
           "Type": "",
           "backup_ready": true,
           "charge_power_clamped": false,
           "disabled_reasons": [],
           "energy_charged": 20460,
           "energy_discharged": 1640,
           "f_out": 60.016000000000005,
           "i_out": 3.6,
           "nominal_energy_remaining": 13789,
           "nominal_full_pack_energy": 13816,
           "off_grid": false,
           "p_out": -210,
           "pinv_grid_state": "Grid_Compliant",
           "pinv_state": "PINV_GridFollowing",
           "q_out": 20,
           "v_out": 243.20000000000002,
           "version": "b0ec24329c08e4",
           "vf_mode": false,
           "wobble_detected": false
       }
   ],
   "battery_target_power": -706,
   "battery_target_reactive_power": 0,
   "blocks_controlled": 2,
   "can_reboot": "Yes",
   "command_source": "Configuration",
   "expected_energy_remaining": 0,
   "ffr_power_availability_high": 11658,
   "ffr_power_availability_low": 194,
   "grid_faults": [
       {
           "alert_is_fault": false,
           "alert_name": "PINV_a006_vfCheckUnderFrequency",
           "alert_raw": 432374469357469696,
           "decoded_alert": "[{\"name\":\"PINV_alertID\",\"value\":\"PINV_a006_vfCheckUnderFrequency\"},{\"name\":\"PINV_alertType\",\"value\":\"Warning\"},{\"name\":\"PINV_a006_frequency\",\"value\":58.97,\"units\":\"Hz\"}]",
           "ecu_package_part_number": "1081100-22-U",
           "ecu_package_serial_number": "CN321365D2U06J",
           "ecu_type": "TEPINV",
           "git_hash": "b0ec24329c08e4",
           "site_uid": "1232100-00-E--TG120325001C3D",
           "timestamp": 1645733844019
       }
   ],
   "grid_services_power": 0,
   "instantaneous_max_apparent_power": 30690,
   "instantaneous_max_charge_power": 14000,
   "instantaneous_max_discharge_power": 20000,
   "inverter_nominal_usable_power": 11700,
   "last_toggle_timestamp": "2022-02-22T08:18:22.51778899-07:00",
   "load_charge_constraint": 0,
   "max_apparent_power": 10000,
   "max_charge_power": 10000,
   "max_discharge_power": 10000,
   "max_power_energy_remaining": 0,
   "max_power_energy_to_be_charged": 0,
   "max_sustained_ramp_rate": 2512500,
   "nominal_energy_remaining": 27624,
   "nominal_full_pack_energy": 27668,
   "primary": true,
   "score": 10000,
   "smart_inv_delta_p": 0,
   "smart_inv_delta_q": 0,
   "solar_real_power_limit": -1,
   "system_island_state": "SystemGridConnected"
  }
  

• pw.battery_blocks(jsonformat=True)

  {  
     "TG122xxx": {
        "OpSeqState": "Active",
        "PackagePartNumber": "3012170-10-B",
        "THC_State": "THC_STATE_AUTONOMOUSCONTROL",
        "Type": "",
        "backup_ready": true,
        "charge_power_clamped": false,
        "disabled_reasons": [],
        "energy_charged": 21020,
        "energy_discharged": 880,
        "f_out": 60.016000000000005,
        "i_out": 2.7,
        "nominal_energy_remaining": 13812,
        "nominal_full_pack_energy": 13834,
        "off_grid": false,
        "p_out": -160,
        "pinv_grid_state": "Grid_Compliant",
        "pinv_state": "PINV_GridFollowing",
        "q_out": 20,
        "temperature": 21.799999999999997,
        "v_out": 243.9,
        "version": "b0ec24329c08e4",
        "vf_mode": false,
        "wobble_detected": false
     },
     "TG122yyy": {
        "OpSeqState": "Active",
        "PackagePartNumber": "3012170-10-B",
        "THC_State": "THC_STATE_AUTONOMOUSCONTROL",
        "Type": "",
        "backup_ready": true,
        "charge_power_clamped": false,
        "disabled_reasons": [],
        "energy_charged": 21020,
        "energy_discharged": 880,
        "f_out": 60.016000000000005,
        "i_out": 2.7,
        "nominal_energy_remaining": 13812,
        "nominal_full_pack_energy": 13834,
        "off_grid": false,
        "p_out": -160,
        "pinv_grid_state": "Grid_Compliant",
        "pinv_state": "PINV_GridFollowing",
        "q_out": 20,
        "temperature": 18.5,
        "v_out": 243.9,
        "version": "b0ec24329c08e4",
        "vf_mode": false,
        "wobble_detected": false
     }
  }
  

Powerwall Reference

Firmware Version History

Firmware version of the Powerwall can be seen with pw.version(). An estimate of Firmware versions in the wild can be seen here: https://www.netzeroapp.io/firmware_versions

Powerwall Firmware	Date Seen	Features	pyPowerwall	Tesla App
20.49.0	Unknown	Unknown	N/A
21.13.2	May-2021	Improved Powerwall behavior during power outage. Push notification when charge level is low during outage.	N/A
21.31.2	Sep-2021	Unknown	N/A
21.39.1 7759c368	Nov-2021	Unknown	v0.1.0
21.44 223a5cd	Unknown	Issue with this firmware is that when the Neurio meter (1.6.1-Tesla) loses connection with gateway (happens frequently) it stops solar generation.	v0.1.0
21.44.1 c58c2df3	1-Jan-2022	Neurio converted to RGM only so that when it disconnects it no longer stop solar power generation	v0.2.0
22.1 92118b67	21-Jan-2022	Upgrades Neurio Revenue Grade Meter (RGM) to 1.7.1-Tesla addressing Neurio instability and missing RGM data	v0.3.0
22.1.1	22-Feb-2022	Unknown	v0.3.0
22.1.2 34013a3f	N/A	Unknown	N/A
22.9	1-Apr-2022	* More options for ‘Advanced Settings’ in the Tesla app to control grid charging and export behavior * Improved Powerwall performance when charge level is below backup reserve and Powerwall is importing from the grid * Capability to configure the charge rate of Powerwall below backup reserve * Improved metering accuracy when loads are not balanced across phases	v0.4.0	4.8.0
22.9.1	12-Apr-2022	Unknown	v0.4.0	4.8.0
22.9.1.1 75c90bda	2-May-2022	Unknown	v0.4.0	4.8.0-1025
22.9.2 a54352e6	2-May-2022	Unknown	v0.4.0 Proxy t11	4.8.0-1025
22.18.3 21c0ad81	28-Jun-2022	Two new alerts did show up in device vitals: HighCPU and SystemConnectedToGrid * The HighCPU was particularly interesting. If you updated your customer password on the gateway, it seems to have reverted during the firmware upgrade. Any monitoring tools using the new password were getting errors. The gateway was presenting "API rate limit" errors (even for installer mode). Reverting the password to the older one fixes the issue but revealed the HighCPU alert.	v0.4.0 Proxy t15	4.9.2-1087
22.18.6 7884188e	27-Sep-2022	STSTSM HighCPU Alert appeared after upgrade. The firmwareVersion now shows "2022-08-01-g8b6399632f". Alerts during upgrade: "PINV_a010_can_gtwMIA", "PINV_a039_can_thcMIA".	v0.4.0 Proxy t15	4.13.1-1312
22.26.1-foxtrot 4d562eaf	13-Oct-2022	This release seems to have introduced a Powerwall charging slowdown mode. After 95% full, the charging will slow dramatically with excess solar production getting pushed to the grid even if the battery is less than 100% (see discussion). This upgrade also upgrades the Neurio Revenue Grade Meter (RGM) to 1.7.2-Tesla with STSTSM firmware showing 2022-09-28-g7cb0d69c2b. Tesla Release Notes: Time-Based Control mode updates, Improved off-grid retry, improved commissioning, improved metering accuracy on Neurio Smart CTs	v0.6.0 Proxy t19	4.13.1-1334
22.26.2 8cd8cac4	26-Oct-2022	STSTSM firmware showing 2022-10-24-g64e8c689f9 - This version seems to have fixed a slow charging issue with the Powerwall. With version 22.26.1, it started trickle charging at around 85-90% and would never get above 95%. With this new version it charges up to 98% and then starts trickle charging to the final 100%.	v0.6.0 Proxy t19	4.14.1-1395
22.26.4 fc00d5dd	22-Nov-2022	STSTSM firmware showing 2022-10-26-g9b8e445626 - No noticeable changes so far.	v0.6.0 Proxy t22	4.14.4-1455
22.36.6 cf1839cb	11-Mar-2023	STSTSM firmware showing 2023-03-04-gd9f19c06f2 - Improved detection of open circuit breakers on Powerwall systems (see Tesla release notes). Change was reverted and rolled back to 22.26.4	v0.6.0 Proxy t24	4.18.0-1607
22.36.7 08d06dad	21-Mar-2023	STSTSM firmware showing 2023-03-04-gd9f19c06f2 - No noticeable changes so far.	v0.6.1 Proxy t24	4.18.0-1607
22.36.9 c55384d2	11-Apr-2023	STSTSM firmware showing 2023-03-29-g66549e6ca7	v0.6.2 Proxy t25	4.19.5-1665
23.4.2-1 fe55682a	3-May-2023	STSTSM firmware showing localbuild	v0.6.2 Proxy t25	4.20.69-1691
23.12.10 30f95d0b	1-Jul-2023	STSTSM firmware showing 2023-07-11-geb56bf57ab	v0.6.2 Proxy t26	4.23.6-1844
23.12.11 452c76cb	4-Aug-2023	STSTSM firmware showing 2023-07-20-ga38210a892	v0.6.2 Proxy t26	4.23.6-1844
23.28.1 fa0c1ad0	11-Sep-2023	STSTSM firmware showing 2023-08-22-g807640ca4a	v0.6.2 Proxy t26	4.24.5-1931
23.28.2 27626f98	13-Oct-2023	STSTSM firmware showing 2023-09-12-gafa2393b50	v0.6.2 Proxy t26	4.25.6-1976
23.36.3 aa269d353	22-Dec-2023	STSTSM firmware showing 2023-11-30-g6e07d12eea	..	..
23.36.4 4064fc6a	17-Jan-2024	STSTSM firmware showing 2023-11-30-g6e07d12eea	..	..
23.44.0 eb113390	25-Jan-2024	STSTSM firmware showing Unknown - No vitals available	..	..
23.44.3-msa	7-Feb-2024	No vitals available	..	..
24.4.0 0fe780c9	15-Mar-2024	No vitals available	..	..
24.12.3 1feaff3a	May-2024	No vitals available	..	..

• Beginning with 23.44.0, Tesla has removed the /api/devices/vitals API endpoint. For discussion about this and future updates, see Tesla Powerwall Firmware Upgrades - Observations.

Devices and Alerts

Devices and Alerts will show up in the device vitals API (e.g. /api/device/vitals). Below are a list of the devices and alerts that I have seen. I'm looking for information on what these mean. Please submit an Issue or PR if you have more alerts or definitions we can add. The device details below are mostly educated guesses.

    import pypowerwall

    # Connect to Powerwall
    pw = pypowerwall.Powerwall(host,password,email,timezone)

    # Display Device Vitals
    print("Device Vitals:\n %s\n" % pw.vitals(True))

Example Output: here

Devices

Device	ECU Type	Description
STSTSM	207	Tesla Energy System
TETHC	224	Tesla Energy Total Home Controller - Energy Storage System (ESS)
TEPOD	226	Tesla Energy Powerwall
TEPINV	253	Tesla Energy Powerwall Inverter
TESYNC	259	Tesla Energy Synchronizer
TEMSA	300	Tesla Backup Switch
PVAC	296	Photovoltaic AC - Solar Inverter
PVS	297	Photovoltaic Strings
TESLA	x	Internal Device Attributes
NERUIO	x	Wireless Revenue Grade Solar Meter

STSTSM - Tesla Energy System

• Details

  • This appears to be the primary control unit for the Tesla Energy Systems.
  • ECU Type is 207
  • Part Numbers: 1232100-XX-Y, 1152100-XX-Y, 1118431-xx-y
  • Tesla Gateway 1 (1118431-xx-y) or Tesla Gateway 2 (1232100-xx-y)
  • Tesla Backup Switch (1624171-xx-y)

• Alerts

  • BackfeedLimited - The system is configured for inadvertent export and therefore will not further discharge to respect this limit. It appears this controls backfeed before PTO, under the "Permission to Operate" option under the settings menu. Prior to PTO the backfeed rate is limited, as the system needs to produce over the load, but by the minimum possible. The system seems to regulate this by switching MCI's open/closed, to minimize the overage that must be backfed, as the power has to go somewhere, and at this point the batteries are 100%. This seems to toggle that setting per inverter.
  • BatteryBreakerOpen - Battery disabled via breaker
  • BatteryComms - Communication issue with Battery
  • BatteryFault - Powerwall Failure
  • BatteryUnexpectedPower - Commanded real power does not match measured power from battery meter.
  • CANUsageAlert - Unknown
  • DeviceShutdownRequested
  • ExcessiveVoltageDrop
  • FWUpdateFailed - Firmware Upgrade Failed
  • FWUpdateSucceeded - Firmware Upgrade Succeeded
  • GridCodesWrite - Unknown
  • GridCodesWriteError - Unknown
  • GridFaultContactorTrip
  • HighCPU - Occurs when too many API calls are made against the gateway especially with bad credentials
  • IslandingControllerMIA
  • OpticasterExe - See Opticaster
  • PanelMaxCurrentLimited
  • PodCommissionTimeError - Unknown but happened when some of the Powerwalls failed during a firmware upgrade and was disabled (see discussion)
  • PodCommissionTime - Unknown
  • PVInverterComms - Communication issue with Solar Inverter (abnormal)
  • RealPowerAvailableLimited - The command is greater than the Available Battery Real Charge or Discharge Power (seen when Powerwall 100% full). Seems related to BackfeedLimited.
  • RealPowerConfigLimited - The system is unable to meet the commanded power because a limit that was configured during commissioning
  • ScheduledIslandContactorOpen - Manually Disconnected from Grid (nominal)
  • SelfConsumptionReservedLimit - Battery reached reserve limit during self-consumption mode and switches to grid (nominal)
  • SiteMaxPowerLimited - Unknown
  • SiteMeterComms - Communication issue with Site Meter (abnormal)
  • SiteMinPowerLimited - Cannot meet command because the Site Minimum Power Limit has been set
  • SolarChargeOnlyLimited - The system has been configured to only charge from solar. Solar is not available, therefore the charge request cannot be met.
  • SolarMeterComms - Communication issue with Solar Meter (abnormal)
  • SolarRGMMeterComms - Communication issue with Solar Revenue Grade Meter (abnormal)
  • SystemConnectedToGrid - Connected successfully to Grid (nominal)
  • SystemShutdown
  • UnscheduledIslandContactorOpen
  • WaitForUserNoInvertersReady - Occurs during grid outage when battery shuts down more than once due to load or error. Requires user intervention to restart.

TETHC - Tesla Energy Total Home Controller

• Details

  • Appears to be controller for Powerwall/2/+ Systems
  • ECU Type is 224
  • Part 1092170-XX-Y (Powerwall 2)
  • Part 2012170-XX-Y (Powerwall 2.1)
  • Part 3012170-XX-Y (Powerwall +)

• Alerts

  • THC_w042_POD_MIA - Unknown (abnormal)
  • THC_w051_Thermal_Power_Req_Not_Met - Unknown but seen during firmware upgrade.
  • THC_w061_CAN_TX_FIFO_Overflow - Unknown (abnormal)
  • THC_w155_Backup_Genealogy_Updated - Unknown but seen during firmware upgrade.

TEPOD - Tesla Energy Powerwall

• Details

  • Appears to be the Powerwall battery system (not sure of what POD stands for)
  • ECU Type is 226
  • Part 1081100-XX-Y
  • Component of TETHC

• Alerts

  • POD_f029_HW_CMA_OV
  • POD_f053_SW_CMA_Cell_MIA
  • POD_w017_SW_Batt_Volt_Sens_Irrational
  • POD_w024_HW_Fault_Asserted
  • POD_w029_HW_CMA_OV
  • POD_w031_SW_Brick_OV - It seems that the Brick warnings are related to preventing the condition where the powerwall doesn't have the minimum amount of power it needs to turn back on. When this happens, a third party charger is needed to get the powerwall back to it's minimum operating battery requirement to turn back on, or it's "bricked". Solar cannot return it to this state, because it needs power to make power.
  • POD_w041_SW_CMA_Comm_Integrity
  • POD_w044_SW_Brick_UV_Warning - see POD_w031_SW_Brick_OV
  • POD_w045_SW_Brick_OV_Warning - see POD_w031_SW_Brick_OV
  • POD_w048_SW_Cell_Voltage_Sens
  • POD_w049_SW_CMA_Voltage_Mismatch
  • POD_w058_SW_App_Boot - Possibly indicating autostart of a generator.
  • POD_w063_SW_SOC_Imbalance
  • POD_w064_SW_Brick_Low_Capacity - see POD_w031_SW_Brick_OV
  • POD_w067_SW_Not_Enough_Energy_Precharge
  • POD_w090_SW_SOC_Imbalance_Limit_Charge
  • POD_w093_SW_Charge_Request
  • POD_w105_SW_EOD
  • POD_w109_SW_Self_Test_Request_Not_Serviced - Unknown
  • POD_w110_SW_EOC - "End of Charge" This triggers when full backfeed starts and battery at 100%.

TEPINV - Tesla Energy Powerwall Inverter

• Details

  • Appears to be the Powerwall Inverter for battery energy storage/release
  • ECU Type is 253
  • Part 1081100-XX-Y
  • Component of TETHC

• Alerts

  • PINV_a001_vfCheckPIIErrorHigh
  • PINV_a006_vfCheckUnderFrequency
  • PINV_a010_can_gtwMIA - Indicate that gateway/sync is MIA (seen during firmware upgrade reboot)
  • PINV_a011_can_podMIA - Unknown (abnormal)
  • PINV_a016_basicAcCheckUnderVoltage
  • PINV_a022_SwitchingBridgeIrrational - Reported during grid outage and on the transition back to grid.
  • PINV_a023_LossOfCurrentControl
  • PINV_a039_can_thcMIA - Seems to indicate that Home Controller is MIA (seen during firmware upgrade reboot)
  • PINV_a041_sensedGridDisturbance - Reported during "lights flickering" events and after "grid outage"
  • PINV_a043_gridResistanceTooHigh - Unknown (see https://github.com/jasonacox/Powerwall-Dashboard/discussions/323)
  • PINV_a047_BusCatcherActivated
  • PINV_a067_overvoltageNeutralChassis - Unknown (nominal)
  • PINV_a086_motorStarting

TESYNC - Tesla Energy Synchronizer

• Details

  • Tesla Backup Gateway includes a synchronizer constantly monitoring grid voltage and frequency to relay grid parameters to Tesla Powerwall during Backup to Grid-tied transition.
  • ECU Type is 259
  • Part 1493315-XX-Y
  • Component of TETHC

• Alerts

  • SYNC_a001_SW_App_Boot - Unknown
  • SYNC_a005_vfCheckUnderVoltage
  • SYNC_a020_LoadsDropped
  • SYNC_a030_Sitemaster_MIA
  • SYNC_a036_LoadsDroppedLong
  • SYNC_a038_DoOpenArguments - Request to disconnect from grid (nominal)
  • SYNC_a044_IslanderDisconnectWithin2s
  • SYNC_a046_DoCloseArguments - Request to join the grid (nominal)

TEMSA - Tesla Backup Switch

• Details
  • Tesla Backup Switch is designed to simplify installation of your Powerwall system. It plugs into your meter socket panel, with the meter plugging directly into the Backup Switch. Within the Backup Switch housing, the contactor controls your system’s connection to the grid. The controller provides energy usage monitoring, providing you with precise, real-time data of your home’s energy consumption.
  • ECU Type is 300
  • Part 1624171-XX-E - Tesla Backup Switch (1624171-xx-y)

PVAC - Photovoltaic AC - Solar Inverter

• Details

  • ECU Type is 296
  • Part 1534000-xx-y - 3.8kW
  • Part 1538000-xx-y - 7.6kW
  • Component of TETHC

• Alerts

  • PVAC_a014_PVS_disabled_relay - Happens during solar startup where PVS shows PVS_SelfTesting, PVS_SelfTestMci (nominal)
  • PVAC_a019_ambient_overtemperature - Temp warning (abnormal)
  • PVAC_a024_PVACrx_Command_mia - Unknown (abnormal)
  • PVAC_a025_PVS_Status_mia - Unknown (abnormal)
  • PVAC_a028_inv_K2_relay_welded
  • PVAC_a030_fan_faulted - Inverter fan failure (abnormal)
  • PVAC_a035_VFCheck_RoCoF - Unknown
  • PVAC_a041_excess_PV_clamp_triggered
  • PVAC_a043_fan_speed_mismatch_detected

PVS - Photovoltaic Strings

• Details

  • ECU Type is 297
  • This terminates the Photovoltaic DC power strings
  • Component of PVAC
  • This includes the Tesla PV Rapid Shutdown MCI (“mid-circuit interrupter") devices which ensure that if one photovoltaic cell stops working, the others continue working.

• Alerts

  • PVS_a010_PvIsolationTotal
  • PVS_a0[17-20]_MciString[A-D] - This indicates a solar string (A, B, C or D) that is not connected.
  • PVS_a021_RapidShutdown
  • PVS_a026_Mci1PvVoltage
  • PVS_a027_Mci2PvVoltage
  • PVS_a031_Mci3PvVoltage
  • PVS_a032_Mci4PvVoltage
  • PVS_a036_PvArcLockout
  • PVS_a039_SelfTestRelayFault
  • PVS_a044_FaultStatePvStringSafety
  • PVS_a048_DcSensorIrrationalFault
  • PVS_a050_RelayCoilIrrationalWarning
  • PVS_a058_MciOpenOnFault
  • PVS_a059_MciOpen - "Mid-Circuit Interrupter" is open, this happens when there is not enough solar power to turn on the string, or the emergency shut down button is pressed. These are safety devices on the strings to turn them on and off.
  • PVS_a060_MciClose - "Mid-Circuit Interrupter" is closed, this is normal operation. An AC signal is sent from the inverter up the DC string triggering the MCI relay to close, allowing for DC solar production to start.

NEURIO - Wireless Revenue Grade Solar Meter

• Details
  • This is a third party (Generac) meter with Tesla proprietary firmware. It is generally installed as a wireless meter to report on solar production. Link
  • Component of STSTSM

TESLA - Internal Device Attributes

• Details
  • This is used to describe attributes of the inverter, meters and others
  • Component of STSTSM

Glossary

This is an unofficial list of terms that are seen in Powerwall responses and message.

• Site = Utility Grid
• Load = Home (think of it as the "load" that the battery or grid powers)
• instant_power = Current power (instant) - also called "true power" in wattage (W)
• instant_reactive_power = The dissipated power resulting from inductive and capacitive loads measured in volt-amperes reactive (VAR)
• instant_apparent_power = The combination of reactive and true power measure in volt-amperes (VA)
• energy_imported = kWh pulled from grid over a duration of time (since Powerwall commissioning it seems)
• energy_exported = kWh pushed to grid

Credits and References

• Tesla Powerwall 2 – Local Gateway API documentation – https://github.com/vloschiavo/powerwall2
• TESLA PowerWall 2 Security Shenanigans – https://github.com/hackerschoice/thc-tesla-powerwall2-hack
• Powerwall Monitoring – https://github.com/mihailescu2m/powerwall_monitor
• Protocol Buffers (protobuf) Basics - https://developers.google.com/protocol-buffers/docs/pythontutorial
• Tesla (tesla.proto) Research and Credit to @brianhealey
• Status Functions - Thanks to @wcwong for contribution: system_status(), battery_blocks(), grid_status()

Other Tools and Similar Projects

• NetZero app - iOS and Android App for monitoring your System - https://www.netzeroapp.io/
• Python Tesla Powerwall API – https://github.com/jrester/tesla_powerwall
• GoTesla - go based Tesla API - https://github.com/bmah888/gotesla

Citation

If you wish to cite this project, please use:

@software{pyPowerwall,
  author = {Cox, Jason A.},
  title = {pyPowerwall: Python API for Tesla Powerwall and Solar Energy Data.},
  year = {2023},
  publisher = {GitHub},
  journal = {GitHub repository},
  howpublished = {\url{https://github.com/jasonacox/pypowerwall}},
}