@tally/fordconnect-node-red

1.1.2 • Public • Published

The FordConnect API allows developers to integrate FordConnect features into their applications. With the API, you can access vehicle data, control vehicle functions. This instructions will guide you through the process of using the FordConnect API in your node-red flows. Let's get started!

Prerequisites

  • Ford developer account. Generate clientId/clientSecret pair. More on: https://developer.ford.com/
  • FordPass account. Be sure to complete your account setup before attempting to account link.

Account Link

Obtaining tokens

Generate tokens using auth code and clientId, clientSecret generate tokens flow

Using the API

After tokens are generated and saved to context you can start making requests to the API get vehicles list

Access token is valid for 20 minutes, so if the request is failed with 401 status the token is probably expired. Failed requests with 401 status code will trigger output on the second output (to which get new tokens node can be hooked up). Other errors will be forwarded to the third output get vehicle details

By default the car should send update on ignition status change. Sometimes vehicle info can be outdated, because server will return cached last values. To fetch the relevant data vehicle status request can be made. The request is non-blocking, so to delay output until refresh is completed "Wait for result check box" can be enabled in node config. There's also poll interval and max retry settings. refresh vehicle status

To get relevant data from the car the flow might look like this get updated vehicle data

[!CAUTION] Ford advises to be mindful of how often the vehicle is polled, because it has impact on battery life.

Readme

Keywords

Package Sidebar

Install

npm i @tally/fordconnect-node-red

Weekly Downloads

0

Version

1.1.2

License

MIT

Unpacked Size

707 kB

Total Files

28

Last publish

Collaborators

  • tally