hyundai-kia-connect-api 3.17.6__tar.gz → 3.32.0__tar.gz

{hyundai_kia_connect_api-3.17.6 → hyundai_kia_connect_api-3.32.0}/CONTRIBUTING.rst

@@ -15,7 +15,7 @@ Types of Contributions
 Report Bugs
 ~~~~~~~~~~~
 
-Report bugs at https://github.com/fuatakgun/hyundai_kia_connect_api/issues.
+Report bugs at https://github.com/Hyundai-Kia-Connect/hyundai_kia_connect_api/issues.
 
 If you are reporting a bug, please include:
 
@@ -45,7 +45,7 @@ articles, and such.
 Submit Feedback
 ~~~~~~~~~~~~~~~
 
-The best way to send feedback is to file an issue at https://github.com/fuatakgun/hyundai_kia_connect_api/issues.
+The best way to send feedback is to file an issue at https://github.com/Hyundai-Kia-Connect/hyundai_kia_connect_api/issues.
 
 If you are proposing a feature:
 
@@ -76,14 +76,14 @@ Ready to contribute? Here's how to set up `hyundai_kia_connect_api` for local de
 
    Now you can make your changes locally.
 
-5. When you're done making changes, check that your changes pass flake8 and the
-   tests, including testing other Python versions with tox::
+5. When you're done making changes, check that your changes pass flake8. Most
+   tests require environment variables to supply the username and password and
+   they will run as part of the PR pre-requisites:
 
     $ flake8 hyundai_kia_connect_api tests
     $ python setup.py test or pytest
-    $ tox
 
-   To get flake8 and tox, just pip install them into your virtualenv.
+   To get flake8, pip install them into your virtualenv.
 
 6. Commit your changes and push your branch to GitHub::
 
@@ -102,8 +102,7 @@ Before you submit a pull request, check that it meets these guidelines:
 2. If the pull request adds functionality, the docs should be updated. Put
    your new functionality into a function with a docstring, and add the
    feature to the list in README.rst.
-3. The pull request should work for Python 3.5, 3.6, 3.7 and 3.8, and for PyPy. Check
-   https://travis-ci.com/fuatakgun/hyundai_kia_connect_api/pull_requests
+3. The pull request should work for recent Python. Check GitHub Actions checks
    and make sure that the tests pass for all supported Python versions.
 
 Tips

{hyundai_kia_connect_api-3.17.6 → hyundai_kia_connect_api-3.32.0}/LICENSE

@@ -19,4 +19,3 @@ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 SOFTWARE.
-

{hyundai_kia_connect_api-3.17.6/hyundai_kia_connect_api.egg-info → hyundai_kia_connect_api-3.32.0}/PKG-INFO

@@ -1,8 +1,8 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.2
 Name: hyundai_kia_connect_api
-Version: 3.17.6
+Version: 3.32.0
 Summary: Python Boilerplate contains all the boilerplate you need to create a Python package.
-Home-page: https://github.com/fuatakgun/hyundai_kia_connect_api
+Home-page: https://github.com/Hyundai-Kia-Connect/hyundai_kia_connect_api
 Author: Fuat Akgun
 Author-email: fuatakgun@gmail.com
 License: MIT license
@@ -11,27 +11,48 @@ Classifier: Development Status :: 2 - Pre-Alpha
 Classifier: Intended Audience :: Developers
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Natural Language :: English
-Classifier: Programming Language :: Python :: 3.9
-Requires-Python: >=3.6
+Classifier: Programming Language :: Python :: 3.10
+Requires-Python: >=3.10
 License-File: LICENSE
 License-File: AUTHORS.rst
 Requires-Dist: beautifulsoup4>=4.10.0
 Requires-Dist: curlify>=2.2.1
 Requires-Dist: python-dateutil
 Requires-Dist: pytz>=2021.3
+Requires-Dist: certifi>=2024.6.2
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: home-page
+Dynamic: keywords
+Dynamic: license
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
+
+Code Maintainers Wanted
+=======================
+
+I no longer have a Kia or Hyundai so don't maintain this like I used to.  Others who are interested in jumping in are welcome to join the project!   Even just pull requests are appreciated!
 
 Introduction
 ============
 
-This is a Kia UVO, Hyundai Bluelink, Genesis Connect(Canada Only) written in python.  It is primary consumed by home assistant.  If you are looking for a home assistant Kia / Hyundai implementation please look here: https://github.com/fuatakgun/kia_uvo.  Much of this base code came from reading bluelinky and contributions to the kia_uvo home assistant project.
+This is a Kia UVO, Hyundai Bluelink, Genesis Connect(Canada Only) written in python.  It is primary consumed by home assistant.  If you are looking for a home assistant Kia / Hyundai implementation please look here: https://github.com/Hyundai-Kia-Connect/kia_uvo.  Much of this base code came from reading `bluelinky <https://github.com/Hacksore/bluelinky>`_ and contributions to the kia_uvo home assistant project.
 
+Chat on discord:: |Discord|
 
-Usage
-=====
+.. |Discord| image:: https://img.shields.io/discord/652755205041029120
+   :target: https://discord.gg/HwnG8sY
+   :alt: Discord
+
+API Usage
+=========
 
 This package is designed to simplify the complexity of using multiple regions.  It attempts to standardize the usage regardless of what brand or region the car is in.  That isn't always possible though, in particular some features differ from one to the next.
 
-Python 3.9 or newer is required to use this package. Vehicle manager is the key class that is called to manage the vehicle lists.  One vehicle manager should be used per login. Key data points required to instantiate vehicle manager are::
+Python 3.10 or newer is required to use this package. Vehicle manager is the key class that is called to manage the vehicle lists.  One vehicle manager should be used per login. Key data points required to instantiate vehicle manager are::
 
     region: int
     brand: int,
@@ -39,7 +60,7 @@ Python 3.9 or newer is required to use this package. Vehicle manager is the key
     password: str
     pin: str (required for CA, and potentially USA, otherwise pass a blank string)
 
-Key values for the int exist in the constant(https://github.com/fuatakgun/hyundai_kia_connect_api/blob/master/hyundai_kia_connect_api/const.py) file as::
+Key values for the int exist in the `const.py <https://github.com/Hyundai-Kia-Connect/hyundai_kia_connect_api/blob/master/hyundai_kia_connect_api/const.py>`_ file as::
 
     REGIONS = {1: REGION_EUROPE, 2: REGION_CANADA, 3: REGION_USA, 4: REGION_CHINA, 5: REGION_AUSTRALIA}
     BRANDS = {1: BRAND_KIA, 2: BRAND_HYUNDAI, 3: BRAND_GENESIS}
@@ -67,7 +88,6 @@ Once this is done you can now make the following calls against the vehicle manag
  Force refreshes a single car:
  force_refresh_vehicles_states(self, vehicle_id)
 
-
 An example call would be::
 
     from hyundai_kia_connect_api import *
@@ -107,16 +127,17 @@ For a list of language codes, see here: https://www.science.co.il/language/Codes
 - "fi" Finnish
 - "pt" Portuguese
 
-In Europe also trip info can be retrieved. For a month you can ask the days with trips. And you can ask for a specific day for all the trips of that specific day.::
-- First call vm.update_month_trip_info(vehicle.id, yyymm) before getting vehicle.month_trip_info for that month
+
+In Europe and some other regions also trip info can be retrieved. For a month you can ask the days with trips. And you can ask for a specific day for all the trips of that specific day.::
+- First call vm.update_month_trip_info(vehicle.id, yyyymm) before getting vehicle.month_trip_info for that month
 - First call vm.update_day_trip_info(vehicle.id, day.yyyymmdd) before getting vehicle.day_trip_info for that day
 
 Example of getting trip info of the current month and day (vm is VehicleManager instance)::
 
     now = datetime.now()
-    yyymm = now.strftime("%Y%m")
+    yyyymm = now.strftime("%Y%m")
     yyyymmdd = now.strftime("%Y%m%d")
-    vm.update_month_trip_info(vehicle.id, yyymm)
+    vm.update_month_trip_info(vehicle.id, yyyymm)
     if vehicle.month_trip_info is not None:
         for day in vehicle.month_trip_info.day_list:  # ordered on day
             if yyyymmdd == day.yyyymmdd:  # in example only interested in current day
@@ -124,3 +145,17 @@ Example of getting trip info of the current month and day (vm is VehicleManager
                 if vehicle.day_trip_info is not None:
                     for trip in reversed(vehicle.day_trip_info.trip_list):  # show oldest first
                         print(f"{day.yyyymmdd},{trip.hhmmss},{trip.drive_time},{trip.idle_time},{trip.distance},{trip.avg_speed},{trip.max_speed}")
+
+
+CLI Usage
+=========
+
+A tool `bluelink` is provided that enable querying the vehicles and save the
+state to a JSON file. Example usage:
+
+::
+
+    bluelink --region Canada --brand Hyundai --username FOO --password BAR --pin 1234 info --json infos.json
+
+Environment variables BLUELINK_XXX can be used to provide a default value for
+the corresponding --xxx argument.

hyundai_kia_connect_api-3.17.6/PKG-INFO → hyundai_kia_connect_api-3.32.0/README.rst

@@ -1,37 +1,25 @@
-Metadata-Version: 2.1
-Name: hyundai_kia_connect_api
-Version: 3.17.6
-Summary: Python Boilerplate contains all the boilerplate you need to create a Python package.
-Home-page: https://github.com/fuatakgun/hyundai_kia_connect_api
-Author: Fuat Akgun
-Author-email: fuatakgun@gmail.com
-License: MIT license
-Keywords: hyundai_kia_connect_api
-Classifier: Development Status :: 2 - Pre-Alpha
-Classifier: Intended Audience :: Developers
-Classifier: License :: OSI Approved :: MIT License
-Classifier: Natural Language :: English
-Classifier: Programming Language :: Python :: 3.9
-Requires-Python: >=3.6
-License-File: LICENSE
-License-File: AUTHORS.rst
-Requires-Dist: beautifulsoup4>=4.10.0
-Requires-Dist: curlify>=2.2.1
-Requires-Dist: python-dateutil
-Requires-Dist: pytz>=2021.3
+Code Maintainers Wanted
+=======================
+
+I no longer have a Kia or Hyundai so don't maintain this like I used to.  Others who are interested in jumping in are welcome to join the project!   Even just pull requests are appreciated!
 
 Introduction
 ============
 
-This is a Kia UVO, Hyundai Bluelink, Genesis Connect(Canada Only) written in python.  It is primary consumed by home assistant.  If you are looking for a home assistant Kia / Hyundai implementation please look here: https://github.com/fuatakgun/kia_uvo.  Much of this base code came from reading bluelinky and contributions to the kia_uvo home assistant project.
+This is a Kia UVO, Hyundai Bluelink, Genesis Connect(Canada Only) written in python.  It is primary consumed by home assistant.  If you are looking for a home assistant Kia / Hyundai implementation please look here: https://github.com/Hyundai-Kia-Connect/kia_uvo.  Much of this base code came from reading `bluelinky <https://github.com/Hacksore/bluelinky>`_ and contributions to the kia_uvo home assistant project.
+
+Chat on discord:: |Discord|
 
+.. |Discord| image:: https://img.shields.io/discord/652755205041029120
+   :target: https://discord.gg/HwnG8sY
+   :alt: Discord
 
-Usage
-=====
+API Usage
+=========
 
 This package is designed to simplify the complexity of using multiple regions.  It attempts to standardize the usage regardless of what brand or region the car is in.  That isn't always possible though, in particular some features differ from one to the next.
 
-Python 3.9 or newer is required to use this package. Vehicle manager is the key class that is called to manage the vehicle lists.  One vehicle manager should be used per login. Key data points required to instantiate vehicle manager are::
+Python 3.10 or newer is required to use this package. Vehicle manager is the key class that is called to manage the vehicle lists.  One vehicle manager should be used per login. Key data points required to instantiate vehicle manager are::
 
     region: int
     brand: int,
@@ -39,7 +27,7 @@ Python 3.9 or newer is required to use this package. Vehicle manager is the key
     password: str
     pin: str (required for CA, and potentially USA, otherwise pass a blank string)
 
-Key values for the int exist in the constant(https://github.com/fuatakgun/hyundai_kia_connect_api/blob/master/hyundai_kia_connect_api/const.py) file as::
+Key values for the int exist in the `const.py <https://github.com/Hyundai-Kia-Connect/hyundai_kia_connect_api/blob/master/hyundai_kia_connect_api/const.py>`_ file as::
 
     REGIONS = {1: REGION_EUROPE, 2: REGION_CANADA, 3: REGION_USA, 4: REGION_CHINA, 5: REGION_AUSTRALIA}
     BRANDS = {1: BRAND_KIA, 2: BRAND_HYUNDAI, 3: BRAND_GENESIS}
@@ -67,7 +55,6 @@ Once this is done you can now make the following calls against the vehicle manag
  Force refreshes a single car:
  force_refresh_vehicles_states(self, vehicle_id)
 
-
 An example call would be::
 
     from hyundai_kia_connect_api import *
@@ -107,16 +94,17 @@ For a list of language codes, see here: https://www.science.co.il/language/Codes
 - "fi" Finnish
 - "pt" Portuguese
 
-In Europe also trip info can be retrieved. For a month you can ask the days with trips. And you can ask for a specific day for all the trips of that specific day.::
-- First call vm.update_month_trip_info(vehicle.id, yyymm) before getting vehicle.month_trip_info for that month
+
+In Europe and some other regions also trip info can be retrieved. For a month you can ask the days with trips. And you can ask for a specific day for all the trips of that specific day.::
+- First call vm.update_month_trip_info(vehicle.id, yyyymm) before getting vehicle.month_trip_info for that month
 - First call vm.update_day_trip_info(vehicle.id, day.yyyymmdd) before getting vehicle.day_trip_info for that day
 
 Example of getting trip info of the current month and day (vm is VehicleManager instance)::
 
     now = datetime.now()
-    yyymm = now.strftime("%Y%m")
+    yyyymm = now.strftime("%Y%m")
     yyyymmdd = now.strftime("%Y%m%d")
-    vm.update_month_trip_info(vehicle.id, yyymm)
+    vm.update_month_trip_info(vehicle.id, yyyymm)
     if vehicle.month_trip_info is not None:
         for day in vehicle.month_trip_info.day_list:  # ordered on day
             if yyyymmdd == day.yyyymmdd:  # in example only interested in current day
@@ -124,3 +112,17 @@ Example of getting trip info of the current month and day (vm is VehicleManager
                 if vehicle.day_trip_info is not None:
                     for trip in reversed(vehicle.day_trip_info.trip_list):  # show oldest first
                         print(f"{day.yyyymmdd},{trip.hhmmss},{trip.drive_time},{trip.idle_time},{trip.distance},{trip.avg_speed},{trip.max_speed}")
+
+
+CLI Usage
+=========
+
+A tool `bluelink` is provided that enable querying the vehicles and save the
+state to a JSON file. Example usage:
+
+::
+
+    bluelink --region Canada --brand Hyundai --username FOO --password BAR --pin 1234 info --json infos.json
+
+Environment variables BLUELINK_XXX can be used to provide a default value for
+the corresponding --xxx argument.

{hyundai_kia_connect_api-3.17.6 → hyundai_kia_connect_api-3.32.0}/docs/installation.rst

@@ -32,13 +32,13 @@ You can either clone the public repository:
 
 .. code-block:: console
 
-    $ git clone git://github.com/fuatakgun/hyundai_kia_connect_api
+    $ git clone git://github.com/Hyundai-Kia-Connect/hyundai_kia_connect_api
 
 Or download the `tarball`_:
 
 .. code-block:: console
 
-    $ curl -OJL https://github.com/fuatakgun/hyundai_kia_connect_api/tarball/master
+    $ curl -OJL https://github.com/Hyundai-Kia-Connect/hyundai_kia_connect_api/tarball/master
 
 Once you have a copy of the source, you can install it with:
 
@@ -47,5 +47,5 @@ Once you have a copy of the source, you can install it with:
     $ python setup.py install
 
 
-.. _Github repo: https://github.com/fuatakgun/hyundai_kia_connect_api
-.. _tarball: https://github.com/fuatakgun/hyundai_kia_connect_api/tarball/master
+.. _Github repo: https://github.com/Hyundai-Kia-Connect/hyundai_kia_connect_api
+.. _tarball: https://github.com/Hyundai-Kia-Connect/hyundai_kia_connect_api/tarball/master

{hyundai_kia_connect_api-3.17.6 → hyundai_kia_connect_api-3.32.0}/hyundai_kia_connect_api/ApiImpl.py

@@ -1,16 +1,23 @@
 """ApiImpl.py"""
 
-# pylint:disable=unnecessary-pass,missing-class-docstring,invalid-name,missing-function-docstring,wildcard-import,unused-wildcard-import,unused-argument,missing-timeout
+# pylint:disable=unnecessary-pass,missing-class-docstring,invalid-name,missing-function-docstring,wildcard-import,unused-wildcard-import,unused-argument,missing-timeout,logging-fstring-interpolation
 
 import datetime as dt
 import logging
 from dataclasses import dataclass
 
 import requests
-
+from requests.exceptions import JSONDecodeError
 from .Token import Token
 from .Vehicle import Vehicle
-from .const import *
+from .const import (
+    WINDOW_STATE,
+    CHARGE_PORT_ACTION,
+    OrderStatus,
+    DOMAIN,
+    VALET_MODE_ACTION,
+    VEHICLE_LOCK_ACTION,
+)
 from .utils import get_child_value
 
 _LOGGER = logging.getLogger(__name__)
@@ -27,6 +34,7 @@ class ClimateRequestOptions:
     front_right_seat: int = None
     rear_left_seat: int = None
     rear_right_seat: int = None
+    steering_wheel: int = None
 
 
 @dataclass
@@ -37,6 +45,26 @@ class WindowRequestOptions:
     front_right: WINDOW_STATE = None
 
 
+@dataclass
+class ScheduleChargingClimateRequestOptions:
+    @dataclass
+    class DepartureOptions:
+        enabled: bool = None
+        days: list[int] = None  # Sun=0, Mon=1, ..., Sat=6
+        time: dt.time = None
+
+    first_departure: DepartureOptions = None
+    second_departure: DepartureOptions = None
+    charging_enabled: bool = None
+    off_peak_start_time: dt.time = None
+    off_peak_end_time: dt.time = None
+    off_peak_charge_only_enabled: bool = None
+    climate_enabled: bool = None
+    temperature: float = None
+    temperature_unit: int = None
+    defrost: bool = None
+
+
 class ApiImpl:
     data_timezone = dt.timezone.utc
     temperature_range = None
@@ -57,10 +85,6 @@ class ApiImpl:
         Required for Kia USA as key is session specific"""
         return vehicles
 
-    def get_last_updated_at(self, value) -> dt.datetime:
-        """Convert last updated value of vehicle into into datetime"""
-        pass
-
     def update_vehicle_with_cached_state(self, token: Token, vehicle: Vehicle) -> None:
         """Get cached vehicle data and update Vehicle instance with it"""
         pass
@@ -82,26 +106,39 @@ class ApiImpl:
     def update_geocoded_location(
         self, token: Token, vehicle: Vehicle, use_email: bool
     ) -> None:
-        email_parameter = ""
-        if use_email is True:
-            email_parameter = "&email=" + token.username
-
-        url = (
-            "https://nominatim.openstreetmap.org/reverse?lat="
-            + str(vehicle.location_latitude)
-            + "&lon="
-            + str(vehicle.location_longitude)
-            + "&format=json&addressdetails=1&zoom=18"
-            + email_parameter
-        )
-        response = requests.get(url)
-        response = response.json()
-        vehicle.geocode = (
-            get_child_value(response, "display_name"),
-            get_child_value(response, "address"),
-        )
-
-    def lock_action(self, token: Token, vehicle: Vehicle, action: str) -> str:
+        if vehicle.location_latitude and vehicle.location_longitude:
+            email_parameter = ""
+            if use_email is True:
+                email_parameter = "&email=" + token.username
+
+            url = (
+                "https://nominatim.openstreetmap.org/reverse?lat="
+                + str(vehicle.location_latitude)
+                + "&lon="
+                + str(vehicle.location_longitude)
+                + "&format=json&addressdetails=1&zoom=18"
+                + email_parameter
+            )
+            _LOGGER.debug(
+                f"{DOMAIN} - Running update geocode location with value: {url}"
+            )
+            response = requests.get(url)
+            _LOGGER.debug(f"{DOMAIN} - geocode location raw response: {response}")
+            try:
+                response = response.json()
+            except JSONDecodeError:
+                _LOGGER.debug(f"{DOMAIN} - failed to decode json for geocode location")
+                vehicle.geocode = None
+            else:
+                _LOGGER.debug(f"{DOMAIN} - geocode location json response: {response}")
+                vehicle.geocode = (
+                    get_child_value(response, "display_name"),
+                    get_child_value(response, "address"),
+                )
+
+    def lock_action(
+        self, token: Token, vehicle: Vehicle, action: VEHICLE_LOCK_ACTION
+    ) -> str:
         """Lock or unlocks a vehicle.  Returns the tracking ID"""
         pass
 
@@ -129,6 +166,13 @@ class ApiImpl:
         """Sets charge limits. Returns the tracking ID"""
         pass
 
+    def set_charging_current(self, token: Token, vehicle: Vehicle, level: int) -> str:
+        """
+        feature only available for some regions.
+        Sets charge current level (1=100%, 2=90%, 3=60%). Returns the tracking ID
+        """
+        pass
+
     def set_windows_state(
         self, token: Token, vehicle: Vehicle, options: WindowRequestOptions
     ) -> str:
@@ -145,7 +189,7 @@ class ApiImpl:
         self, token: Token, vehicle: Vehicle, yyyymm_string: str
     ) -> None:
         """
-        Europe feature only.
+        feature only available for some regions.
         Updates the vehicle.month_trip_info for the specified month.
 
         Default this information is None:
@@ -158,7 +202,7 @@ class ApiImpl:
         self, token: Token, vehicle: Vehicle, yyyymmdd_string: str
     ) -> None:
         """
-        Europe feature only.
+        feature only available for some regions.
         Updates the vehicle.day_trip_info information for the specified day.
 
         Default this information is None:
@@ -166,3 +210,32 @@ class ApiImpl:
         day_trip_info: DayTripInfo = None
         """
         pass
+
+    def schedule_charging_and_climate(
+        self,
+        token: Token,
+        vehicle: Vehicle,
+        options: ScheduleChargingClimateRequestOptions,
+    ) -> str:
+        """
+        feature only available for some regions.
+        Schedule charging and climate control. Returns the tracking ID
+        """
+        pass
+
+    def start_hazard_lights(self, token: Token, vehicle: Vehicle) -> str:
+        """Turns on the hazard lights for 30 seconds"""
+        pass
+
+    def start_hazard_lights_and_horn(self, token: Token, vehicle: Vehicle) -> str:
+        """Turns on the hazard lights and horn for 30 seconds"""
+        pass
+
+    def valet_mode_action(
+        self, token: Token, vehicle: Vehicle, action: VALET_MODE_ACTION
+    ) -> str:
+        """
+        feature only available for some regions.
+        Activate or Deactivate valet mode. Returns the tracking ID
+        """
+        pass