GithubHelp home page GithubHelp logo

mazdapi's Introduction

MazdAPI Client

A Flask application built atop the pymazda project, which somehow managed to demystify the non-public facing, inconsistantly designed, and (to my knowledge) entirely undocumented Mazda Connected Services API used by the MyMazda mobile app.

Overview

Those with a connected-service-capable Mazda vehicle can use this application to perform many of the same actions present in the MyMazda mobile app. This includes, but is not neccesarilly limited to:

  • Querying a list of vehicles associated with a MyMazda account
  • Querying the status (tire pressure, fuel remaining, last location, etc.) of a given vehicle
  • Remotely locking/unlocking the doors of a given vehicle
  • Remotely starting/stopping the engine of a given vehicle

Usage & Development

Getting this application up and running should require only the following few steps:

  1. Clone this repository
  2. Install the required dependencies (python3 -r requirements.txt)
  3. Create a config.yml file containing your MyMazda email, password, and region (see config_example.yml for reference)
  4. Run the application with python3 app.py

Scope & Limitations

This project was primarally intended to serve as a fun experiment in web-development, and was NOT designed to be all-encompassing in capability or particularly appealing to view. Furthermore, although the application does function quite well when working with my own vehicle, it will most certainly not function correctly if paired with certain other models. Specifically speaking, electric Mazda vehicles, which have an entirely different set of API routes associated with them, are not supported by this application.

It is also important to note that, due to the unstable nature of the backing API, this app could break at any time.

mazdapi's People

Contributors

homeworkhopper avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.