tesla-powerwall 0.2.12

API for Tesla Powerwall

Python Tesla Powerwall API

Python Tesla Powerwall API for consuming a local endpoint.

Note: This is not an official API and as such might be incomplete and fail at any time

Supported Powerwall Software versions:

• 1.45.X
• 1.46.0
• 1.47.0

For more information about versioning see API versiooning.

Installation

$ pip install tesla_powerwall

Usage

Setup connection

from tesla_powerwall import Powerwall

power_wall = Powerwall("<ip of your Powerwall>")
#=> <Powerwall ...>

Note: By default the API client does not verify the SSL Certificate of the Powerwall. If you want to verify the SSL Certificate you can set verify_ssl to True. Also the API client suppresses warnings about an inseucre request (because we aren't verifing the certificate). If you want to enable those warnings you can set disable_insecure_warning to False.

It can also happen that the API is sending different responses than what was expected. Those responses would normally produce an APIChangedError indicating what exactly changed. If this happens please open an Issue to report this error. If you need to cotinue to use the API you can disable the response validation:

power_wall = Powerwall("<ip of your Powerwall>", dont_validate_response=True)
# If you need to change the original setting
power_wall.set_dont_validate_response(False)

# Using a context manager if you only need to change it for some methods
with power_wall.no_verify():
    power_wall.get_status()

Authentication

To login you can either use login or login_as. login logs you in as User.CUSTOMER whereas with login_as you can choose a different user:

from tesla_powerwall import User

# Login as customer
power_wall.login("<email>", "<password>")
#=> <LoginResponse ...>

# Login with different user
power_wall.login_as(User.INSTALLER, "<email>", "<password>")
#=> <LoginResponse ...>

# Check if we are logged in 
power_wall.is_authenticated()
#=> True

# Logout
power_wall.logout()

API versioning

The powerwall API is inconsitent across different versions. This is why some versions may return different responses. If no version is specified the newest known version is assumed.

If you are sure which version your powerwall has you can pin the Powerwall object to a version:

from tesla_powerwall import Version
# Pin powerwall object
power_wall = Powerwall("<powerwall-ip>", pin_version="1.46.0")

# You can also pin a version after the powerwall object was created
power_wall.pin_version(Version.v1_46_0)

Otherwise you can let the API try to detect the version and pin it. This method should be prefered over the manual detection and pinning of the version:

power_wall.detect_and_pin_version()

Current battery level

Get charge in percent:

power_wall.get_charge()
#=> 98

The API also returns the exact percentage. You can get the exact percentage by passing False to rounded:

power_wall.get_charge(rounded=False)
#=> 97.59281925744594

Powerwall Status

status = power_wall.get_status()
#=> <PowerwallStatusResponse ...>
status.version
#=> '1.45.2'

Sitemaster

sm = power_wall.sitemaster 
#=> <SiteMasterResponse ...>
sm.status 
#=> StatusUp
sm.running
#=> true
sm.connected_to_tesla
#=> true

Siteinfo

info = power_wall.get_site_info()
#=> <SiteInfoResponse ...>
info.site_name
#=> Tesla Home
info.country
#=> Germany

Meters

Aggregates

meters = power_wall.get_meters()
#=> <MetersAggregateResponse ...>
meters.solar
#=> <MetersResponse ...>

Details about meter

Returns details about the meter. When no details are available None is returned.

power_wall.meter_detailed(MeterType.SOLAR)
#=> [<MeterDetailsResponse ...>]
power_wall.meter_detailed(MeterType.LOAD)
#=> None

Current power supply/draw

Get current power supply/draw for home, solar, battery and grid.

power_wall.is_drawing_from(MeterType.SOLAR)
#=> True
power_wall.is_sending_to(MeterType.LOAD)
#=> True
power_wall.is_active(MeterType.BATTERY)
#=> False
power_wall.get_power(MeterType.SOLAR)
#=> 2.8 (in kWh)

Note: For MeterType.LOAD is_drawing_from always returns False because it cannot be drawn from load.

Each of those methods are wrappers for their respective methods on MetersResponse. When you call those wrapper methods get_meters() is always called. So if you need to query multiple meters you should first retrive all meters and execute the respective methods on the response:

meters = power_wall.get_meters()
meters.solar.is_drawing_from()
#=> True
meters.load.is_sending_to()
#=> True
meters.battery.is_active()
#=> False
meters.solar.get_power()
#=> 2.8 (in kWh)

get_power is just a convenience method which is equivalent to:

from tesla_powerwall.helpers import convert_to_kw

convert_to_kw(meters.solar.instant_power, precision=1)

Device Type

power_wall.device_type
#=> <DeviceType.GW1: 'hec'>

Grid Status

Get current grid status.

power_wall.get_grid_status()
#=> <GridStatus.Connected: 'SystemGridConnected'>
power_wall.get_grid_services_active()
#=> False

Operation mode

power_wall.get_operation_mode()
#=> <OperationMode.SELF_CONSUMPTION: ...>

Powerwall status

status = power_wall.get_status()
#=> <PowerwallStatusResponse ...>
status.version
#=> '1.45.2'

# If you just need the version you can also use `get_version`
power_wall.get_version()
#=> '1.45.2'

Powerwalls

Get all powerwalls

powerwalls_resp = power_wall.get_powerwalls()
#=> <ListPowerwallsResponse ...>
powerwalls_resp.powerwalls
#=> [{"Package...}]

Get powerwalls status when authenticated:

powerwalls_status = power_wall.get_poweralls_status()
#=> <PowerwalllsStatusResponse ...>

For some unkown reason the response to get_powerwalls also includes the powerwalls status, so if you are not authenticated you can just retrive the status from the ListPowerwallsResponse

powerwalls_resp = power_wall.get_powerwalls()
powerwalls_resp.status
#=> <PowerwallsStatusResponse ...>
power_wall.get_serial_numbers()
#=> ["...", "...", ...]

More

Most methods return a Response object except for those that only return a single value like get_charge and those that have to complex output like get_networks.

Most times those Responses reflect the json response but for most nested data objects this is not the case. You can access the original response using <Response>.json_response.

Some other methods include:

• get_vin
• get_solars
• get_meters_info
• get_installer_info
• get_meter_readings
• get_meters_info
• get_phase_usage