Add documentation about services for Mazda integration (#17946)

This commit is contained in:
Brandon Rothweiler 2021-05-26 07:36:55 -07:00 committed by GitHub
parent 7fef154549
commit f63415ee83
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -55,6 +55,69 @@ Displays the current door lock status of the vehicle, and locks/unlocks the door
The "Automatic Re-Lock" feature will automatically re-lock the doors if they are not opened shortly after being unlocked. This applies regardless of whether you are using the key, or unlocking the doors remotely using Home Assistant or the MyMazda app.
</div>
## Services
This integration offers several services for interacting with Mazda vehicles.
### Service `mazda.start_engine`
Starts the vehicle engine. The vehicle engine can only be remotely started 2 consecutive times. To reset this counter, the vehicle must be driven.
| Service Data Attribute | Required | Description |
| ---------------------- | -------- | ----------- |
| `device_id` | yes | The device ID of the vehicle to start |
### Service `mazda.stop_engine`
Stops the vehicle engine. This only works if the vehicle was remotely started.
| Service Data Attribute | Required | Description |
| ---------------------- | -------- | ----------- |
| `device_id` | yes | The device ID of the vehicle to stop |
### Service `mazda.start_charging`
Starts charging the vehicle battery. This only works with electric vehicles.
| Service Data Attribute | Required | Description |
| ---------------------- | -------- | ----------- |
| `device_id` | yes | The device ID of the vehicle to start charging |
### Service `mazda.stop_charging`
Stops charging the vehicle battery. This only works with electric vehicles.
| Service Data Attribute | Required | Description |
| ---------------------- | -------- | ----------- |
| `device_id` | yes | The device ID of the vehicle to stop charging |
### Service `mazda.send_poi`
Send a GPS location to the vehicle's navigation system as a POI (Point of Interest). Requires a navigation SD card installed in the vehicle.
| Service Data Attribute | Required | Description |
| ---------------------- | -------- | ----------- |
| `device_id` | yes | The device ID of the vehicle to send the GPS location to |
| `latitude` | yes | The latitude of the location to send. |
| `longitude` | yes | The longitude of the location to send. |
| `poi_name` | yes | A friendly name for the location. |
### Service `mazda.turn_on_hazard_lights`
Turn on the vehicle hazard lights. The lights will flash briefly and then turn off.
| Service Data Attribute | Required | Description |
| ---------------------- | -------- | ----------- |
| `device_id` | yes | The device ID of the vehicle to turn hazard lights on |
### Service `mazda.turn_off_hazard_lights`
Temporarily turn off the vehicle hazard lights if they have been manually turned on from inside the vehicle. If a door is opened, the hazard lights will turn back on.
| Service Data Attribute | Required | Description |
| ---------------------- | -------- | ----------- |
| `device_id` | yes | The device ID of the vehicle to turn hazard lights off |
## Disclaimer
This integration is not affiliated with or endorsed by Mazda.