whendric / fordpass-scriptable

FordPass Widget for Scriptable

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

FordPass widget for iOS Scriptable

GitHub issues GitHub pull requests Donate

GitHub tag (latest SemVer)

Widget light example Widget dark example

Intro

This widget is based off the work of by David Schablowsky. It has been rewritten to add a new design, support infinitly more features, and will be much easier to maintain and improve over time. This version no longer requires you to edit the script file to configure login information and preferences. The widget now fetches all information required about your ford vehicle and displays them in a simple interactive widget. The widget has been tested on many many ford models, and should work on any vehicle that's supported in the FordPass mobile app.

Requirements

Features

  • Will automatically fetch data from server (default is every 3-5 minutes)

  • Tapping on the Vehicle location in the widget will open Apple Maps (or Google Maps) pin the position of your vehicle.

  • Tapping anywhere in the widget will open the scriptable app and provide a menu of quick actions support by your vehicles capabilities.

  • Automatically pulls in the following info about you and your vehicle:

    • Vehicles actual image
    • Distance and Pressure units defined in the FordPass app.
  • Debug Menu to view advanced information about your vehicle data:

    • View the Hidden OTA data embedded in Ford.com vehicle dashboard.
    • View all data pulled into the widget using various ford endpoints.

Screenshots

Menu example Advanced Control example Menu example Debug Menu example

Known Issues & Limitations

  • The widget offers limited controls for electric vehicles at the moment (I need to get the commands from the FordPass app mapped out.)
  • Sometimes the fuel and oil data will be missing or incorrect. This is due to the fact that the fuel and oil data is not always available in the Fordpass API when the vehicle is off.

Community Help

Discord Link: https://discord.gg/VPw3zw9v

Todo

  • Get small, large, and extra large layouts working.
  • Widget code updater mechanism (I don't have a way to do this yet)

Installation

Automated Install

  • COMING SOON

Manual Install

  • Browse here to view the latest code
  • Press "raw" in the upper left corner and copy everything after opening the Fordpass Widget.js script
  • Open Scriptable App
  • Press on "+" in the upper right corner and paste the code
  • Press "Done"
  • Tap on the widget and a menu will appear for you to enter your login information and VIN number.
  • Pressing "Done" will save the data and open another config page to allow you to change the settings.
  • Go to your iOS homescreen and make a long press to enter "homescreen edit mode"
  • Press "+" on the upper left corner and choose "Scriptable" as a medium sized widget
  • Still in "wiggle mode" tap on the newly created widget and choose the FordPass Widget from the list under "Script"

For easy maintenance of the script I recommend just saving the Fordpass Widget.js file directly to the Scriptable folder inside the iCloud Drive it will make it easier to update it without having to copy and paste the code again. Any changes are reflected in the scriptable app.

Troubleshooting and Debugging

The easiest way to edit the code and see the results in realtime is to use iCloud on your computer. On windows it requires installing the iCloud Drive.

If you browse to the iCloud Drive folder look for the Scriptable folder and you will see all the scripts you have in the app. Just edit the Fordpass Widget.js file and save it and within a few seconds it will be updated in the Scriptable app which you will need to tap the 3 dots on the widget in the app. You have to exit the editor view in the scripable app after each external code change. Then just hit the play symbol to run the code in the app.

Credits

Thanks to dschablowsky for his work on the original widget, d4v3y0rk for finding out the information about the ford api. Additional thanks to marco79cgn and Tobias Battenberg for your widgets. They inspired me to create my own widget!

Disclaimer

I have created this widget in my freetime. I do NOT work for Ford nor do I get anything for creating this widget. The api used can be changed at any moment by Ford. Do not share this widget code with your login data embedded in it. I am NOT liable for any kind of damage (special, direct, indirect, consequential or whatsoever) resulting from the use of this widget/script. Anybody who is in possesion of your data can control your car.

About

FordPass Widget for Scriptable

License:GNU General Public License v3.0


Languages

Language:JavaScript 100.0%