Skip to content

Commit

Permalink
Update
Browse files Browse the repository at this point in the history
  • Loading branch information
cyr-ius committed Dec 29, 2023
1 parent 3763c87 commit b029d47
Showing 1 changed file with 15 additions and 20 deletions.
35 changes: 15 additions & 20 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,12 @@ Audi Connect Integration for Home Assistant
![GitHub](https://img.shields.io/github/license/cyr-ius/hass-audiconnect)
[![hacs_badge](https://img.shields.io/badge/HACS-Custom-41BDF5.svg)](https://github.com/hacs/integration)

Description
Description
------------

The `audiconnect` component provides an integration with the Audi Connect cloud service. It adds presence detection, sensors such as range, mileage, and fuel level, and provides car actions such as locking/unlocking and setting the pre-heater.

**Note:** Certain functions require special permissions from Audi, such as position update via GPS.
**Note:** Certain functions require special permissions from Audi, such as position update via GPS.

Credit for initial API discovery go to the guys at the ioBroker VW-Connect forum, who were able to figure out how the API and the PIN hashing works. Also some implementation credit to davidgiga1993 of the original [AudiAPI](https://github.com/davidgiga1993/AudiAPI) Python package, on which some of this code is loosely based.
Thank you at arjenvrh who knew how to maintain and evolve the code for many years
Expand All @@ -19,6 +20,7 @@ Installation
------------

Installation can be done manually by copying the files in this repository into the `custom_components` directory in the Home Assistant configuration directory:

1. Open the configuration directory of your Home Assistant installation.
2. If you do not have a `custom_components` directory, create it.
3. In the `custom_components` directory, create a new directory called `audiconnect`.
Expand All @@ -35,21 +37,13 @@ Configuration is done through the Home Assistant UI.

### Configuration Variables

**username**

- (string)(Required) The username associated with your Audi Connect account.

**password**
- **username** (string)(Required) The username associated with your Audi Connect account.

- (string)(Required) The password for your Audi Connect account.
- **password** (string)(Required) The password for your Audi Connect account.

**S-PIN**
- **S-PIN** (string)(Optional) The S-PIN for your Audi Connect account.

- (string)(Optional) The S-PIN for your Audi Connect account.

**region**

- (selector)(Required) The region where your Audi Connect account is registered.
- **region** (selector)(Required) The region where your Audi Connect account is registered.

Options
--------
Expand All @@ -75,13 +69,14 @@ Services

**audiconnect.refresh_vehicle_data**

Normal updates retrieve data from the Audi Connect service, and don't interact directly with the vehicle. _This_ service triggers an update request from the vehicle itself. When data is retrieved successfully, Home Assistant is automatically updated. The service requires a vehicle identification number (VIN) as a parameter.
Normal updates retrieve data from the Audi Connect service, and don't interact directly with the vehicle. _This_ service triggers an update request from the vehicle itself. When data is retrieved successfully, Home Assistant is automatically updated. The service requires a vehicle identification number (VIN) as a parameter.

**audiconnect.execute_vehicle_action**

Perform an action on the vehicle. The service takes a VIN and the action to perform as parameters. Possible action values:

- lock
- unlock
- unlock
- start_climatisation
- stop_climatisation
- start_charger
Expand All @@ -90,16 +85,16 @@ Perform an action on the vehicle. The service takes a VIN and the action to perf
- start_preheater
- stop_preheater
- start_window_heating
- stop_window_heating
- stop_window_heating

**Note:** Certain action require the S-PIN to be set in the configuration.
**Note:** Certain action require the S-PIN to be set in the configuration.

When an action is successfully performed, an update request is automatically triggered.
When an action is successfully performed, an update request is automatically triggered.

Example Dashboard Card
----------------------

Below is an example Dashboard (Lovelace) card illustrating some of the sensors this Home Assistant addon provides.
Below is an example Dashboard (Lovelace) card illustrating some of the sensors this Home Assistant addon provides.

![Example Dashboard Card](card_example.png)

Expand Down

0 comments on commit b029d47

Please sign in to comment.