Skip to content

Python wrapper for the FordPass API for Ford vehicle information and control: start, stop, lock, unlock.

License

Notifications You must be signed in to change notification settings

NicKoehler/fordpass-python

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

14 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

fordpass-python

This is a basic Python wrapper around the FordPass APIs. The wrapper provides methods to return vehicle status as well as some basic commands, e.g. start/stop, lock/unlock.

It's more or less a straight port of @d4v3y0rk's NPM module d4v3y0rk/ffpass - props to him for his work figuring out the relevant API requests needed.

Forked from clarkd/fordpass-python and currently mantained by me.

Features

  • Automatically auth & re-fetches tokens once expired
  • Get status of the vehicle (this returns a ton of info about the car: lat/long, oil, battery, fuel, odometer, tire pressures, open windows and a bunch of other stuff that may/may not apply to your car, e.g. charge level, diesel filters.)
  • Start the engine (if supported)
  • Stop the engine (if supported)
  • Lock the doors
  • Unlock the doors

Install

Install using pip:

pip install fordpass

Demo

To test the libary there is a demo script demo.py.

demo.py USERNAME PASSWORD VIN

e.g.

demo.py [email protected] mypassword WX12345678901234

Publishing new versions of this package

  1. Bump the version number inside setup.py.
  2. Build the package: python setup.py sdist bdist_wheel.
  3. Upload to TestPyPi using twine upload --repository-url https://test.pypi.org/legacy/ dist/* and verify everything is as expected.
  4. Upload to PyPi using twine upload dist/*.
  5. All done!

About

Python wrapper for the FordPass API for Ford vehicle information and control: start, stop, lock, unlock.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Python 100.0%