khpylon / MachEWidget

Android Widget for Ford Mustang Mach-E
GNU General Public License v3.0
34 stars 9 forks source link

Ford Status (formerly Mustang Mach-E) Widget for Android

Donate Donate

Intro

This app/widget is based on the work of Anthony (tonesto7), which is in turn based on the earlier work of David Schablowsky, and also the work of @DevSecOps . It is not a complete implementation of the functionality of their widgets, as it:

My purpose for hosting this code on GitHub under the GPL v3 license is to provide a starting point for anyone who wants to extend its functionality.

Installation

Search for "Ford Status Widget" on the Google Play store, or download this app-release.apk file and sideload on your Android device.

Requirements

Features

Known Issues & Limitations

Contributing Help for Unsupported Vehicles

If you would like to use the app but your vehicle is not currently supported, there are a few things you can do:

  1. Load the app onto your phone and gather log data about your vehicle. See the "Bug Report" section for how to gather log data. The important piece of data is the JSON responses for car status.
  2. Consider contributing the necessary graphics for your vehicle. Free drawings would be great (provided they are usable and actually free), but chipping in a donation towards the purchase of SVG CAD drawings is also encouraged.
  3. Encourage fellow owners to do the same.

Contributing Language Translations

If you would like to use the app in your preferred language but there is no translation for it, read how to submit one.

Bug Reports

If you discover something which doesn't work the way you expect, check first on the forums to see whether someone else has reported a similar problem (or whether the app is actual working properly). Also search under "Issues" on GitHub to see if it's been reported. If not, you will need to gather some data to create a new bug report.

The app has some built-in support for gathering log information:

  1. Under "Settings", activate "Enable logging"
  2. Perform any actions you think will demonstrate the issue
  3. Under the three-dot menu, select "Save logfile"; this will save a file named fsw_logfile-.txt or something similar in the Downloads folder of your external storage
  4. Deactivate "Enable logging"
  5. Create/append to an Issue and upload the file as an attachment

A serious bug that causes the app to crash will dump some information to logcat. The app will check for this the next time it is run and write it to a file named fsw_logcat-.txt in your Downloads folder. You can then post this with a new issue on GitHub.

Frequently Asked Questions

Refer to the FAQ file. It's a work in progress. If your questions isn't there, ask on the forums or send a message to suggest adding it.

Donations

This project is free to use and free for anyone to copy, but there occasionally are some costs for the content it uses. If you are interested in supporting development, use the Paypal or BuyMeACoffee links at the top of the page. Any funds not spent on the project will be donated to charity.

Credits

Thanks to tonesto7 for his work on the new widget, and to dschablowsky for his work on the original widget, d4v3y0rk for finding out the information about the Ford api. Thanks to @DevSecOps on the Mach-E Forums for his valuable input and help with updating the appearance of the widget and permitting the use of the assets from his app. Additional thanks to marco79cgn and Tobias Battenberg for your widgets.
Thanks to @Papapoil, @su-ch-mache, @aulander, and [@miken] (https://www.macheforum.com/site/members/miken.14630/) for their input in porting the app to other languages. Also, thanks to those who have funded the project via PayPal so that I have funds to purchase additional resources to further enhance the app.

The ColorPickerView was written by skydoves (Jawwoong Eum), and copyrighted 2017 under the [Apache Licence, Version 2.0] (https://github.com/skydoves/ColorPickerView#license).

A number of the icons used in this app are derived from free ones found on Icon8; thanks to the original creators.

Disclaimer

I was inspired to create this app for Android in order to see more information about my vehicle, and to learn new things about Android programming. I am not employed by Ford, and this app is not supported by Ford. Ford's API may be changed at any time, rendering the app unusable. I am NOT liable for any kind of damage (special, direct, indirect, consequential or whatsoever) resulting from the use of this app.

License

This code is released as open source software under the GPL v3 license: see the LICENSE file in the project root for the full license text.