From 89c96e205c1dc1ef146569aeebe85626513b720e Mon Sep 17 00:00:00 2001 From: tdorssers Date: Wed, 29 Dec 2021 14:56:31 +0100 Subject: [PATCH] Minor version incremented --- README.md | 38 +++++++++++++++++++------------------- setup.cfg | 2 +- teslapy/__init__.py | 2 +- 3 files changed, 21 insertions(+), 21 deletions(-) diff --git a/README.md b/README.md index 7745b19..a80837d 100644 --- a/README.md +++ b/README.md @@ -52,30 +52,30 @@ The convenience method `api()` uses named endpoints listed in *endpoints.json* t The `Vehicle` class extends `dict` and stores vehicle data returned by the Owner API, which is a pull API. The streaming API pushes vehicle data on-change after subscription. The `stream()` method takes an optional argument, a callback function that is called with one argument, a dict holding the changed data. The `Vehicle` object is always updated with the pushed data. If there are no changes within 10 seconds, the vehicle stops streaming data. The `stream()` method has two more optional arguments to control restarting. Additionally, the class implements the following methods: -| Call | Description | -| --- | --- | -| `api()` | performs an API call to named endpoint requiring vehicle_id with optional arguments | -| `get_vehicle_summary()` | gets the state of the vehicle (online, asleep, offline) | -| `sync_wake_up()` | wakes up and waits for the vehicle to come online | -| `option_code_list()` 1 | lists known descriptions (read from *option_codes.json*) of the vehicle option codes | -| `get_vehicle_data()` | gets a rollup of all the data request endpoints plus vehicle config | -| `get_nearby_charging_sites()` | lists nearby Tesla-operated charging stations | -| `get_service_scheduling_data()` | retrieves next service appointment for this vehicle | -| `get_charge_history()` | lists vehicle charging history data points | -| `get_user()` | gets user account data | -| `get_user_details()` | get user account details | -| `mobile_enabled()` | checks if mobile access is enabled in the vehicle | -| `compose_image()` 2 | composes a vehicle image based on vehicle option codes | -| `dist_units()` | converts distance or speed units to GUI setting of the vehicle | -| `temp_units()` | converts temperature units to GUI setting of the vehicle | -| `decode_vin()` | decodes the vehicle identification number to a dict | -| `command()` | wrapper around `api()` for vehicle command response error handling | +| Call | Online | Description | +| --- | --- | --- | +| `api()` | Yes | performs an API call to named endpoint requiring vehicle_id with optional arguments | +| `get_vehicle_summary()` | No | gets the state of the vehicle (online, asleep, offline) | +| `sync_wake_up()` | No | wakes up and waits for the vehicle to come online | +| `option_code_list()` 1 | No | lists known descriptions (read from *option_codes.json*) of the vehicle option codes | +| `get_vehicle_data()` | Yes | gets a rollup of all the data request endpoints plus vehicle config | +| `get_nearby_charging_sites()` | Yes | lists nearby Tesla-operated charging stations | +| `get_service_scheduling_data()` | No | retrieves next service appointment for this vehicle | +| `get_charge_history()` | No | lists vehicle charging history data points | +| `get_user()` | No | gets user account data | +| `get_user_details()` | No | get user account details | +| `mobile_enabled()` | Yes | checks if mobile access is enabled in the vehicle | +| `compose_image()` 2 | No | composes a vehicle image based on vehicle option codes | +| `dist_units()` | Yes | converts distance or speed units to GUI setting of the vehicle | +| `temp_units()` | Yes | converts temperature units to GUI setting of the vehicle | +| `decode_vin()` | No | decodes the vehicle identification number to a dict | +| `command()` | Yes | wrapper around `api()` for vehicle command response error handling | 1 Option codes appear to be deprecated. Vehicles return a generic set of codes related to a Model 3. 2 Pass vehicle option codes to this method or the image may not be accurate. -Only `get_vehicle_summary()`, `option_code_list()`, `get_service_scheduling_data()`, `compose_image()` and `decode_vin()` are available when the vehicle is asleep or offline. These methods will not prevent your vehicle from sleeping. Other methods and API calls require the vehicle to be brought online by using `sync_wake_up()` and can prevent your vehicle from sleeping if called within too short a period. +Only methods with *No* in the *Online* column are available when the vehicle is asleep or offline. These methods will not prevent your vehicle from sleeping. Other methods and API calls require the vehicle to be brought online by using `sync_wake_up()` and can prevent your vehicle from sleeping if called within too short a period. The `Product` class extends `dict` and stores product data of Powerwalls and solar panels returned by the API. Additionally, the class implements the following methods: diff --git a/setup.cfg b/setup.cfg index 8f7234f..fcdc7de 100644 --- a/setup.cfg +++ b/setup.cfg @@ -3,7 +3,7 @@ universal = 1 [metadata] name = TeslaPy -version = 2.2.0 +version = 2.3.0 author = Tim Dorssers author_email = tim.dorssers@xs4all.nl description = A Python module to use the Tesla Motors Owner API diff --git a/teslapy/__init__.py b/teslapy/__init__.py index 8450a06..bebaa54 100644 --- a/teslapy/__init__.py +++ b/teslapy/__init__.py @@ -6,7 +6,7 @@ # Author: Tim Dorssers -__version__ = '2.2.0' +__version__ = '2.3.0' import os import ast