Skip to main content

A Python API to manage your FordPass-enabled vehicle.

Project description

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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

vehiclepass-0.2.0.tar.gz (70.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

vehiclepass-0.2.0-py3-none-any.whl (16.1 kB view details)

Uploaded Python 3

File details

Details for the file vehiclepass-0.2.0.tar.gz.

File metadata

  • Download URL: vehiclepass-0.2.0.tar.gz
  • Upload date:
  • Size: 70.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.6.11

File hashes

Hashes for vehiclepass-0.2.0.tar.gz
Algorithm Hash digest
SHA256 487050f445ca888231d3aaf29aeabcd660358877376f052506e3ebd531d2f691
MD5 331ad73913d898ad37ca8f5b337126b5
BLAKE2b-256 1f360fd02dbcb3506798dc246fa6f9465cb8fed3478356c69ccf4c96ca169ca3

See more details on using hashes here.

File details

Details for the file vehiclepass-0.2.0-py3-none-any.whl.

File metadata

File hashes

Hashes for vehiclepass-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 2a2bb1db6ca8c0fc28d821513b70330cfd3c5ce8141198c35f5cce5935442cc8
MD5 d9a82861bb92d1f2495b01d43c57bc3c
BLAKE2b-256 bd89e37fded9917c866cca5d8d490d96f188ba1d32ec3d7d66d056ac5c95ff25

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page