Skip to content

Commit

Permalink
docs: Update fuatakgun to Hyundai-Kia-Connect (#666)
Browse files Browse the repository at this point in the history
Co-authored-by: cdnninja <[email protected]>
  • Loading branch information
maruel and cdnninja authored Oct 31, 2024
1 parent d278b3a commit 8b47c3b
Show file tree
Hide file tree
Showing 4 changed files with 10 additions and 10 deletions.
4 changes: 2 additions & 2 deletions CONTRIBUTING.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down Expand Up @@ -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:

Expand Down
6 changes: 3 additions & 3 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,22 +6,22 @@ I no longer have a Kia or Hyundai so don't maintain this like I used to. Others
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.

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,
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::
Key values for the int exist in the constant(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}
Expand Down
8 changes: 4 additions & 4 deletions docs/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand All @@ -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
2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@
),
test_suite="tests",
tests_require=test_requirements,
url="https://github.com/fuatakgun/hyundai_kia_connect_api",
url="https://github.com/Hyundai-Kia-Connect/hyundai_kia_connect_api",
version="3.24.2",
zip_safe=False,
)

0 comments on commit 8b47c3b

Please sign in to comment.