Api Calls for Ford vehicles equipped with the fordpass app.
example:
import ffpass var ford = Vehicle(username:"user@email.com", password:"myPassword", vin:"1FT#############") if ford.lock(): echo "Vehicle Locked" else: echo "Failed to lock Vehicle"
Types
Vehicle = object username*, password*, vin*: string
-
Username and password from fordpass app.
VIN from vehicle registered in app.
Procs
proc status(self: Vehicle): JsonNode {...}{.raises: [KeyError, ValueError, OSError, HttpRequestError, SslError, IOError, Defect, Exception, TimeoutError, ProtocolError, JsonParsingError], tags: [TimeEffect, ReadIOEffect, WriteIOEffect].}
- Returns jsonNode of vehicle status
proc lock(self: Vehicle): bool {...}{.raises: [KeyError, ValueError, OSError, HttpRequestError, SslError, IOError, Defect, Exception, TimeoutError, ProtocolError, JsonParsingError], tags: [TimeEffect, ReadIOEffect, WriteIOEffect].}
- Locks the vehicle. Returns true if successful
proc unlock(self: Vehicle): bool {...}{.raises: [KeyError, ValueError, OSError, HttpRequestError, SslError, IOError, Defect, Exception, TimeoutError, ProtocolError, JsonParsingError], tags: [TimeEffect, ReadIOEffect, WriteIOEffect].}
- Unlocks the vehicle. Returns true if successful
proc start(self: Vehicle): bool {...}{.raises: [KeyError, ValueError, OSError, HttpRequestError, SslError, IOError, Defect, Exception, TimeoutError, ProtocolError, JsonParsingError], tags: [TimeEffect, ReadIOEffect, WriteIOEffect].}
- Starts the vehicle. Returns true if successful
proc stop(self: Vehicle): bool {...}{.raises: [KeyError, ValueError, OSError, HttpRequestError, SslError, IOError, Defect, Exception, TimeoutError, ProtocolError, JsonParsingError], tags: [TimeEffect, ReadIOEffect, WriteIOEffect].}
- Stops the vehicle. Returns true if successful