README
FordPass Api
This is a basic NodeJS 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, status, refresh status.
Features
- 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.)
- Refresh the vehicle status
- Start the engine
- Stop the engine
- Lock the doors
- Unlock the doors
Install
npm install --save fordpass-api
Usage
import { FordPass } from "fordpass-api";
const main = async () => {
const USERNAME = "user@user.com";
const PASSWORD = "password";
const VIN = "1AB2C3DE1KR123456"
const fordPass = new FordPass(USERNAME, PASSWORD, VIN);
const isRefreshed = await fordPass.refresh(); // Refresh vehicle status
const isLocked = await fordPass.lock(); // Lock vehicle
const isUnlocked = await fordPass.unlock(); // Unlock vehicle
const isStarted = await fordPass.start(); // Start vehicle engine
const isStopped = await fordPass.stop(); // Stop vehicle engine
const status = await fordPass.status(); // Get vehicle status
};
main();