Warning
There is a new token obtaining system.
The token used by this integration is currently removed whenever the integration is updated. With this 1.70 update, the token will be wiped during every update, requiring users to manually add the token during the initial setup.
To prevent this issue, we will be moving the token file outside of the FordPass directory. This change will ensure that the token is preserved during updates. This will require reconfiguration of your setup. Please see the Installation section, or the Wiki for help.
Important
Dear FordPass Integration Users, As you know there have been many challenges with the Ford API. We > are actively working on developments but please note that these developments will take time.
- FordConnect API: Ford has enabled developer accounts and released their
FordConnect API. However, this API and its documentation currently lack many data points or are not fully >implemented. It is presently supported only in North America. - FordPass APP: Ford has also released their refreshed
FordPass App. This refreshed app includes some new features while also >removing certain items, similar to the FordConnect API.
It is important to understand that our integration depends on the data provided by either the FordConnect API or the FordPass App, >which may limit some functionalities.
-
Enhancements: We are committed to enhancing the integration and ensuring its functionality. However, we both have limited time to allocate to this effort.
-
Implementation: We are actively working on integrating the new
FordConnect APIto ensure users who can access it will benefit from its features. At the same time, we will maintain functionality for users who are unable to use this new API.
If you have any questions or concerns, please either open a new issue or comment on an existing issue related to yours.
Thank you,
itchannel and SquidBytes
- https://github.com/clarkd - Initial Home Assistant automation idea and Python code (Lock/Unlock)
- https://github.com/pinballnewf - Figuring out the application ID issue
- https://github.com/degrashopper - Fixing 401 error for certain installs
- https://github.com/tonesto7 - Extra window statuses and sensors
- https://github.com/JacobWasFramed - Updated unit conversions
- https://github.com/heehoo59 - French Translation
- https://github.com/SquidBytes - EV updates and documentation
Use HACS to add this repository as a custom repo.
Upon installation navigate to your integrations, and follow the configuration options. You will need to provide:
- Fordpass Email
- Region (Where you are based, required for tokens to work correctly)
You will then be prompted with Setup Token
Follow the instructions on the Wiki to obtain your token
Your car must have the lastest onboard modem functionality and have registered/authorised the fordpass application
I have added a service to poll the car for updates, due to the battery drain I have left this up to you to set the interval. The service to be called is "refresh_status" and can be accessed in home assistant using "fordpas.refresh_status".
Optionally you can add the "vin" parameter followed by your VIN number to only refresh one vehicle. By default this service will refresh all registered cars in HA.
This will take up to 5 mins to update from the car once the service has been run
Click on options and choose imperial or metric to display in km/miles. Takes effect on next restart of home assistant. Default is Metric
If you are experiencing any sign in issues, please trying clearing your tokens using the "clear_tokens" service call.
This service allows you to manually refresh/poll the API without waiting the set poll interval. Handy if you need quicker updates e.g. when driving for gps coordinates
Sensors may change as the integration is being developed
- Guard Mode
- Lock/Unlock
- Remote Start
- Alarm Status
- Battery Status (12v)
- Coolant Temperature
- Deep sleep status
- Fordpass messages and alerts
This integration is not officially supported by Ford and as such using this integration could result in your account being locked out!