Skip to main content

vehiclepass

A Python 3.9+ API to manage your FordPass-enabled vehicle. Requires a FordPass account and a vehicle registered to it.

NOTE: This project is in early development. The API may change significantly before reaching v1.0.0.

Reads many status values, such as outside temperature, engine RPM, and door lock status. Full documentation pending.

Currently supports these commands:

  • Remote start
  • Cancel remote start
  • Lock
  • Unlock

Install

pip install vehiclepass

Quickstart

import vehiclepass

with vehiclepass.vehicle(
    username="you@example.com",
    password="s3cr3t",
    vin="YOURVIN12345"
) as v:
    print(v.doors.are_locked)  # False
    # By default, this issues the unlock command, waits 30s, and verifies it took effect.
    # Pass verify=False to skip this check.
    v.doors.unlock()
    print(v.doors.are_locked)  # True

    # Most status values return a unit object that makes converting and printing the
    # value convenient.
    print(v.engine_coolant_temp.f)  # 55.4
    print(v.engine_coolant_temp.c)  # 13.0
    
    # When casting to string, uses the unit defined in env var VEHICLEPASS_DEFAULT_TEMP_UNIT.
    print(v.engine_coolant_temp)  # 55.4°F

    # Request a remote start. By default, the vehicle will automatically shut off after 15 minutes. Pass extend_shutoff=True to add another 15 minutes (30 minutes total).
    v.start()
    print(v.is_running)  # True
    print(v.is_remotely_started)  # True
    # Remotely started isn't the same as starting manually from the ignition in the vehicle.
    print(v.is_ignition_started)  # False
    print(v.shutoff_countdown)  # 14m 58s
    print(v.shutoff_countdown.s)  # 898.0
    print(v.shutoff_time)  # 2025-04-02 10:41:53.175933

Contributing

Contributions welcome! Please open an issue to discuss what you'd like to do first.

Development

Prerequisites

Environment

  1. Fork this repo to your personal GitHub account
  2. Clone the repo locally
    USERNAME=<your-github-username>
    git clone https://github.com/$USERNAME/vehiclepass.git
    cd vehiclepass
    
  3. Create a feature branch off of the develop branch
    git checkout develop
    git checkout -b 1234-short-description  # 1234 is the issue number you opened
    
  4. Make your changes
  5. Add at least one new test that covers your code, but as many as necessary
  6. Ensure all tests pass
    nox -r  # The -r flag re-uses virtualenvs for faster re-runs
    
  7. Open a pull request

Metadata

Release files for vehiclepass 0.3.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for vehiclepass 0.3.0
File Size Uploaded
vehiclepass-0.3.0.tar.gz 71.5 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for vehiclepass 0.3.0
File Interpreter ABI Platform
vehiclepass-0.3.0-py3-none-any.whl Python 3 none any Details

Total release size: 88.1 kB

Release files / vehiclepass-0.3.0.tar.gz

Download URL vehiclepass-0.3.0.tar.gz
Size 71.5 kB
Tags Source
SHA-256 checksum
How to use checksums
cd8323d0841fe985c9dd711f99db120685058becdab7846a7db968233aece4f1
BLAKE2b-256 checksum
How to use checksums
2c080e09d72b970db4874ea74feadf54a4c41d4adcf435be712a56cad4dfd1b3
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via uv/0.6.11

Release files / vehiclepass-0.3.0-py3-none-any.whl

Download URL vehiclepass-0.3.0-py3-none-any.whl
Size 16.6 kB
Tags Python 3
SHA-256 checksum
How to use checksums
2977c63ddc0345c13bf0589fbbd4920338f65a8278dfa9d29fb38405e854bf44
BLAKE2b-256 checksum
How to use checksums
fc16a5e3a3c90b5bcd1d6ddea4c4820e321296febf63e30fe6136bf390ba4c01
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via uv/0.6.11

Release history Release notifications | RSS feed

This release

0.3.0 This release

2 release files

0.2.0

2 release files

0.1.1

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page