Update bmw_connected_drive documentation for buttons (#20959)

This commit is contained in:
rikroe 2022-01-06 12:06:03 +01:00 committed by GitHub
parent 5b08fc26e4
commit 4fde621751
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -4,6 +4,7 @@ description: Instructions on how to setup your BMW Connected Drive account with
ha_category: ha_category:
- Car - Car
- Binary Sensor - Binary Sensor
- Button
- Presence Detection - Presence Detection
- Lock - Lock
- Sensor - Sensor
@ -17,6 +18,7 @@ ha_codeowners:
ha_domain: bmw_connected_drive ha_domain: bmw_connected_drive
ha_platforms: ha_platforms:
- binary_sensor - binary_sensor
- button
- device_tracker - device_tracker
- lock - lock
- notify - notify
@ -37,10 +39,10 @@ This integration provides the following platforms:
- Binary Sensors: Doors, windows, condition based services, check control messages, parking lights, door lock state, charging status (electric cars) and connections status (electric cars). - Binary Sensors: Doors, windows, condition based services, check control messages, parking lights, door lock state, charging status (electric cars) and connections status (electric cars).
- Device tracker: The location of your car. - Device tracker: The location of your car.
- Lock: Control the lock of your car. - [Lock](/integrations/bmw_connected_drive/#lock): Control the lock of your car.
- Sensors: Mileage, remaining range, remaining fuel, charging time remaining (electric cars), charging status (electric cars), remaining range electric (electric cars). - Sensors: Mileage, remaining range, remaining fuel, charging time remaining (electric cars), charging status (electric cars), remaining range electric (electric cars).
- Notifications: Send Points of Interest (POI) to your car. - [Notifications](/integrations/bmw_connected_drive/#notifications): Send Points of Interest (POI) to your car.
- Services: Turn on air condition, sound the horn, flash the lights, update the vehicle location and update the state. More details can be found [here](/integrations/bmw_connected_drive/#services). - [Buttons](/integrations/bmw_connected_drive/#buttons): Turn on air condition, sound the horn, flash the lights, update the vehicle location and update the state.
## Configuration ## Configuration
@ -98,11 +100,7 @@ bmw_connected_drive:
The `bmw_connected_drive` integration offers a notification service. Using this service you can send Points of Interest (POI) to your vehicle. In your vehicle you can select this POI and the navigation will automatically start using the POI as a destination. The `bmw_connected_drive` integration offers a notification service. Using this service you can send Points of Interest (POI) to your vehicle. In your vehicle you can select this POI and the navigation will automatically start using the POI as a destination.
The name of the service is `notify.bmw_connected_drive_<your_vehicle>`. The name of the service is `notify.bmw_connected_drive_<your_vehicle>`.
### Examples ### Send a Point of Interest to your vehicle
A few examples on how to use the notification service.
#### Send a Point of Interest to your vehicle
```yaml ```yaml
... ...
@ -120,39 +118,37 @@ action:
country: Country # Optional country: Country # Optional
``` ```
## Services ## Lock
The `bmw_connected_drive` integration offers several services. In case you need to provide the vehicle identification number (VIN) as a parameter, you can see the VIN as attribute of all entities, e.g. (binary) sensors or the device tracker. The VIN is a 17 digit alphanumeric string, e.g., `WBANXXXXXX1234567`. The vehicle can be locked and unlocked via the lock integration that is created automatically for each vehicle. Before invoking, make sure it's safe to lock/unlock the vehicle in the current situation.
Using these services will impact the state of your vehicle. So use these services with care! ## Buttons
### Locking and unlocking The `bmw_connected_drive` integration offers several buttons to trigger actions in your car. The buttons are automatically created and can be pressed/executed from the UI or using the `button.press` service. Please see the [button documentation](/integrations/button/) for more information.
The vehicle can be locked and unlocked via the lock integration that is created automatically for each vehicle. Before invoking these services, make sure it's safe to lock/unlock the vehicle in the current situation. Using these buttons will impact the state of your vehicle. So use these services with care!
### Air condition ### Air condition
The air condition of the vehicle can be activated with the service `bmw_connected_drive.activate_air_conditioning`. The air condition of the vehicle can be activated with the `button.<your_vehicle>_activate_air_conditioning` button.
What exactly is started here depends on the type of vehicle. It might range from just ventilation over auxiliary heating to real air conditioning. If your vehicle is equipped with auxiliary heating, only trigger this service if the vehicle is parked in a location where it is safe to use it (e.g., not in an underground parking or closed garage). What exactly is started here depends on the type of vehicle. It might range from just ventilation over auxiliary heating to real air conditioning. If your vehicle is equipped with auxiliary heating, only trigger this service if the vehicle is parked in a location where it is safe to use it (e.g., not in an underground parking or closed garage).
Some newer cars also support stopping an active air conditioning with the service `bmw_connected_drive.deactivate_air_conditioning`. Some newer cars also support stopping an active air conditioning with the `button.<your_vehicle>_deactivate_air_conditioning` button.
This will only work if you have the option to stop the AC in the *MyBMW* app. If your car doesn't support this service, nothing will happen. This will only work if you have the option to stop the AC in the *MyBMW* app. If your car doesn't support this service, nothing will happen.
The vehicle is identified via the parameter `vin`.
### Sound the horn ### Sound the horn
The service `bmw_connected_drive.sound_horn` sounds the horn of the vehicle. This option is not available in some countries (among which the UK). Use this feature responsibly, as it might annoy your neighbors. The vehicle is identified via the parameter `vin`. The `button.<your_vehicle>_sound_horn` button sounds the horn of the vehicle. This option is not available in some countries (among which the UK). Use this feature responsibly, as it might annoy your neighbors.
### Flash the lights ### Flash the lights
The service `bmw_connected_drive.light_flash` flashes the lights of the vehicle. The vehicle is identified via the parameter `vin`. The `button.<your_vehicle>_light_flash` button flashes the lights of the vehicle.
### Vehicle finder ### Vehicle finder
The service `bmw_connected_drive.find_vehicle` requests the vehicle to update the GPS location. This can be used for older vehicles which don't automatically send the updated GPS location. The vehicle is identified via the parameter `vin`. The `button.<your_vehicle>_find_vehicle` button requests the vehicle to update the GPS location. This can be used for older vehicles which don't automatically send the updated GPS location.
<div class="note warning"> <div class="note warning">
@ -167,11 +163,9 @@ The service `bmw_connected_drive.find_vehicle` requests the vehicle to update th
</div> </div>
### Update the state ### Update the state / refresh from API
The service `bmw_connected_drive.update_state` fetches the last state of the vehicles of all your accounts from the BMW server. This does *not* trigger an update from the vehicle; it gets the data from the BMW servers. So this service does *not* interact with your vehicles. The `button.<vehicle_model>_refresh_from_api` button fetches the last state of the vehicles of all your accounts from the BMW server. This does *not* trigger an update from the vehicle; it gets the data from the BMW servers. So this service does *not* interact with your vehicles.
This service does not require any attributes.
## Disclaimer ## Disclaimer