Add documentation about lock platform for Mazda integration (#17815)

This commit is contained in:
Brandon Rothweiler 2021-05-14 01:21:49 -07:00 committed by GitHub
parent 17747d012d
commit a583f5d812
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -4,6 +4,7 @@ description: Instructions on how to integrate your Connected Services capable Ma
ha_release: '2021.3'
ha_category:
- Car
- Lock
- Presence Detection
- Sensor
ha_iot_class: Cloud Polling
@ -26,13 +27,34 @@ This integration requires an active Mazda Connected Services subscription and a
- CX-9: 2021+
- CX-5: 2021+
This integration provides the following platforms:
- Sensor: Fuel remaining, fuel distance remaining, odometer, and tire pressure. Tire pressure is not available for CX-5 and CX-9 models.
- Device tracker: Tracks the current location of the vehicle. This updates when the vehicle is switched off.
{% include integrations/config_flow.md %}
<div class='note warning'>
The MyMazda API only allows one active session at a time. Therefore, if you use the same account with both Home Assistant and the MyMazda mobile app, you may experience issues ("Multiple devices detected" notifications, session expired warnings, etc.) To fix this, you can create a secondary MyMazda account, and share your vehicle with the secondary account. Log in to the mobile app using the primary account and select Menu > MyMazda > My Vehicle > Drivers > Manage Drivers > Invite Driver. When finished, log into the secondary account with Home Assistant.
</div>
## Platforms
### Sensor
The following sensor entities are available:
- Fuel remaining
- Fuel distance remaining
- Odometer
- Tire pressure (not available for CX-5 and CX-9 models)
### Device tracker
Tracks the current location of the vehicle. This will generally update when the vehicle is switched off.
### Lock
Displays the current door lock status of the vehicle, and locks/unlocks the doors of the vehicle.
<div class='note info'>
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>
## Disclaimer
This integration is not affiliated with or endorsed by Mazda.