Python Boilerplate contains all the boilerplate you need to create a Python package.

Navigation

Verified details

These details have been verified by PyPI
Maintainers
Avatar for fuatakgun from gravatar.com fuatakgun

Unverified details

These details have not been verified by PyPI
Project links
Meta
  • License: MIT License (MIT license)
  • Author: Fuat Akgun
  • Tags hyundai_kia_connect_api
  • Requires: Python >=3.6
Classifiers
Report project as malware

Project description

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.

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:

region: int
brand: int,
username: str
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:

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}

Once this is done you can now make the following calls against the vehicle manager:

#Checks the token is still valid and updates it if not.  Should be called before anything else if the code has been running for any length of time.
check_and_refresh_token(self)

Ideal refresh command. Checks if the car has been updated since the time in seconds provided.  If so does a cached update. If not force calls the car.
check_and_force_update_vehicles(self, force_refresh_interval) # Interval in seconds - consider API Rate Limits https://github.com/Hacksore/bluelinky/wiki/API-Rate-Limits

Used to return a specific vehicle object:
get_vehicle(self, vehicle_id)

#Updates all cars with what is cached in the cloud:
update_all_vehicles_with_cached_state(self)

Updates a specific car with cached state:
update_vehicle_with_cached_state(self, vehicle_id)

Force refreshes all cars:
force_refresh_all_vehicles_states(self)

Force refreshes a single car:
force_refresh_vehicles_states(self, vehicle_id)

An example call would be:

from hyundai_kia_connect_api import *
vm = VehicleManager(region=2, brand=1, username="username@gmail.com", password="password", pin="1234")
vm.check_and_refresh_token()
vm.update_all_vehicles_with_cached_state()
print(vm.vehicles)

If geolocation is required you can also allow this by running:

vm = VehicleManager(region=2, brand=1, username="username@gmail.com", password="password", pin="1234", geocode_api_enable=True, geocode_api_use_email=True)

This will populate the address of the vehicle in the vehicle instance.

The Bluelink App is reset to English for users who have set another language in the Bluelink App in Europe when using hyundai_kia_connect_api. To avoid this, you can pass the optional parameter language (default is “en”) to the constructor of VehicleManager, e.g. for Dutch:

vm = VehicleManager(region=2, brand=1, username="username@gmail.com", password="password", pin="1234", language="nl")

Note: this is only implemented for Europe currently.

For a list of language codes, see here: https://www.science.co.il/language/Codes.php. Currently in Europe the Bluelink App shows the following languages:

- "en" English
- "de" German
- "fr" French
- "it" Italian
- "es" Spanish
- "sv" Swedish
- "nl" Dutch
- "no" Norwegian
- "cs" Czech
- "sk" Slovak
- "hu" Hungarian
- "da" Danish
- "pl" Polish
- "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 - 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")
yyyymmdd = now.strftime("%Y%m%d")
vm.update_month_trip_info(vehicle.id, yyymm)
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
            vm.update_day_trip_info(vehicle.id, day.yyyymmdd)
            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}")

Project details

Verified details

These details have been verified by PyPI
Maintainers
Avatar for fuatakgun from gravatar.com fuatakgun

Unverified details

These details have not been verified by PyPI
Project links
Meta
  • License: MIT License (MIT license)
  • Author: Fuat Akgun
  • Tags hyundai_kia_connect_api
  • Requires: Python >=3.6
Classifiers

Release history Release notifications | RSS feed

4.12.0

4.11.1

4.11.0

4.10.4

4.10.3

4.10.2

4.10.1

4.10.0

4.9.0

4.8.4

4.8.3

4.8.2

4.8.1

4.8.0

4.7.3

4.7.2

4.7.1

4.7.0

4.6.1

4.6.0

4.5.2

4.5.1

4.5.0

4.4.0

4.3.13

4.3.12

4.3.11

4.3.10

4.3.9

4.3.8

4.3.7

4.3.6

4.3.5

4.3.4

4.3.3

4.3.2

4.3.1

4.3.0

4.2.0

4.1.0

4.0.2

3.52.3

3.52.2

3.52.1

3.52.0

3.51.5

3.51.4

3.51.3

3.51.2

3.51.1

3.51.0

3.50.0

3.49.4

3.49.3

3.49.2

3.49.1

3.49.0

3.48.1

3.48.0

3.47.0

3.46.1

3.46.0

3.45.6

3.45.5

3.45.4

3.45.3

3.45.2

3.45.1

3.45.0

3.44.7

3.44.6

3.44.5

3.44.4

3.44.3

3.44.1

3.44.0

3.43.6

3.43.5

3.43.4

3.43.3

3.43.2

3.43.1

3.43.0

3.42.13

3.42.12

3.42.11

3.42.4

3.42.2

3.42.1

3.42.0

3.41.5

3.41.4

3.41.3

3.41.2

3.41.1

3.41.0

3.40.6

3.40.5

3.40.4

3.40.3

3.40.2

3.40.1

3.40.0

3.39.0

3.38.1

3.38.0

3.37.0

3.36.0

3.35.12

3.35.11

3.35.10

3.35.9

3.35.8

3.35.7

3.35.6

3.35.5

3.35.4

3.35.3

3.35.2

3.35.1

3.35.0

3.34.4

3.34.3

3.34.2

3.34.1

3.34.0

3.33.5

3.33.4

3.33.3

3.33.2

3.33.1

3.33.0

3.32.16

3.32.15

3.32.14

3.32.13

3.32.12

3.32.11

3.32.10

3.32.9

3.32.8

3.32.7

3.32.6

3.32.5

3.32.4

3.32.3

3.32.2

3.32.1

3.32.0

3.31.0

3.30.3

3.30.2

3.30.1

3.30.0

3.29.2

3.29.1

3.27.0

3.26.0

3.25.0

3.24.3

3.24.2

3.24.1

3.24.0

3.23.9

3.23.8

3.23.7

3.23.6

3.23.5

3.23.4

3.23.3

3.23.2

3.23.1

3.23.0

3.22.10

3.22.9

3.22.8

3.22.7

3.22.6

3.22.3

3.22.2

3.22.1

3.22.0

3.21.1

3.21.0

3.20.7

3.20.6

3.20.5

3.20.3

3.20.2

3.19.1

3.19.0

This version

3.18.0

3.17.10

3.17.9

3.17.8

3.17.7

3.17.6

3.17.5

3.17.4

3.17.3

3.17.2

3.17.1

3.17.0

3.16.0

3.15.1

3.15.0

3.14.3

3.14.2

3.14.1

3.14.0

3.13.2

3.13.1

3.13.0

3.12.0

3.11.4

3.11.3

3.11.2

3.11.1

3.11.0

3.10.12

3.10.11

3.10.10

3.10.9

3.10.8

3.10.7

3.10.6

3.10.5

3.10.4

3.10.3

3.10.2

3.10.1

3.10.0

3.9.1

3.9.0

3.8.6

3.8.5

3.8.4

3.8.3

3.8.2

3.8.1

3.8.0

3.7.0

3.6.0

3.5.0

3.4.0

3.3.13

3.3.12

3.3.11

3.3.10

3.3.9

3.3.8

3.3.7

3.3.6

3.3.5

3.3.4

3.3.3

3.3.2

3.3.1

3.3.0

3.2.0

3.1.10

3.1.9

3.1.8

3.1.7

3.1.6

3.1.3

3.1.2

3.1.1

3.1.0

3.0.0

2.4.4

2.4.3

2.4.2

2.4.1

2.4.0

2.3.3

2.3.2

2.3.1

2.3.0

2.2.0

2.1.2

2.1.1

2.1.0

2.0.2

2.0.1

2.0.0

1.53.2

1.53.1

1.53.0

1.52.13

1.52.12

1.52.11

1.52.10

1.52.9

1.52.8

1.52.7

1.52.6

1.52.5

1.52.4

1.52.3

1.52.2

1.52.1

1.52.0

1.51.1

1.51.0

1.50.3

1.47.3

1.47.2

1.47.1

1.47.0

1.46.0

1.45.6

1.45.5

1.45.4

1.45.3

1.45.2

1.45.1

1.45.0

1.44.4

1.44.3

1.44.2

1.44.1

1.44.0

1.43.3

1.43.2

1.43.1

1.43.0

1.42.5

1.42.4

1.42.3

1.42.2

1.42.1

1.42.0

1.41.4

1.41.3

1.41.2

1.41.1

1.41.0

1.40.13

1.40.12

1.40.11

1.40.10

1.40.9

1.40.8

1.40.7

1.40.6

1.40.5

1.40.4

1.40.3

1.40.2

1.40.1

1.40.0

1.39.7

1.39.6

1.39.5

1.39.4

1.39.3

1.39.2

1.39.1

1.39.0

1.38.0

1.37.10

1.37.9

1.37.8

1.37.7

1.37.6

1.37.5

1.37.4

1.37.3

1.37.2

1.37.1

1.37.0

1.36.12

1.36.11

1.36.10

1.36.9

1.36.8

1.36.7

1.36.6

1.36.5

1.36.4

1.36.3

1.36.2

1.36.1

1.36.0

1.35.5

1.35.4

1.35.3

1.35.2

1.35.1

1.35.0

1.34.9

1.34.8

1.34.7

1.34.6

1.34.5

1.34.4

1.34.3

1.34.2

1.34.1

1.34.0

1.33.0

1.32.0

1.31.0

1.30.0

1.29.3

1.29.2

1.29.1

1.29.0

1.28.5

1.28.4

1.28.3

1.28.2

1.28.1

1.28.0

1.27.1

1.27.0

1.26.5

1.26.4

1.26.3

1.26.2

1.26.1

1.26.0

1.25.0

1.24.0

1.23.1

1.23.0

1.22.9

1.22.8

1.22.7

1.22.6

1.22.5

1.22.4

1.22.3

1.22.2

1.22.1

1.22.0

1.21.7

1.21.6

1.21.5

1.21.4

1.21.3

1.21.2

1.21.1

1.21.0

1.20.0

1.19.10

1.19.9

1.19.8

1.19.7

1.19.6

1.19.5

1.19.4

1.19.3

1.19.2

1.19.1

1.19.0

1.18.18

1.18.17

1.18.16

1.18.15

1.18.14

1.18.13

1.18.12

1.18.11

1.18.10

1.18.8

1.18.7

1.17.3

1.17.1

1.14.4

1.14.3

1.14.2

1.14.1

1.14.0

1.12.1

1.12.0

1.11.0

1.10.4

1.10.2

1.10.1

1.8.2

1.8.1

1.8.0

1.7.4

1.7.3

1.7.2

1.7.1

1.7.0

1.6.0

1.5.0

1.4.0

1.3.0

1.2.0

0.1.4

0.1.3

0.1.2

0.1.1

0.1.0

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

hyundai_kia_connect_api-3.18.0.tar.gz (62.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

hyundai_kia_connect_api-3.18.0-py2.py3-none-any.whl (64.7 kB view details)

Uploaded Python 2Python 3

File details

Details for the file hyundai_kia_connect_api-3.18.0.tar.gz.

File metadata

  • Download URL: hyundai_kia_connect_api-3.18.0.tar.gz
  • Upload date:
  • Size: 62.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.12.2

File hashes

Hashes for hyundai_kia_connect_api-3.18.0.tar.gz
Algorithm Hash digest
SHA256 a679050f6d98959b31121bedd3840dcbdb15ab9033b6a351e6d40466455db31a
MD5 a7dae4368bfb3983d0d359ec6e559670
BLAKE2b-256 6bc1f66a3d7a16e522e6a704c2859247371280436e05e93b33da4f32ecf2f057

See more details on using hashes here.

File details

Details for the file hyundai_kia_connect_api-3.18.0-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for hyundai_kia_connect_api-3.18.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 17fccd4b5ef22142a44684bcef61961e94c69f43e9ab6b69270b01f9719be9cf
MD5 cb035de1f93abcb389ed600d822230f6
BLAKE2b-256 c036ba2367491c6368278b7f82a3738887de71fb97ddd8329fe48a7e1eb0645b

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page