Skip to main content

Library to read data from the BMW Connected Drive portal

Project description

https://pepy.tech/badge/bimmer-connected/week https://pepy.tech/badge/bimmer-connected/month https://pepy.tech/badge/bimmer-connected https://badge.fury.io/py/bimmer-connected.svg https://travis-ci.org/bimmerconnected/bimmer_connected.svg?branch=master https://coveralls.io/repos/github/bimmerconnected/bimmer_connected/badge.svg?branch=master

bimmer_connected

This is a simple library to query and control the status of your BMW or Mini vehicle from the Connected Drive portal.

See bimmerconnected for usage instruction or the API Documentation.

This library is written to include it in Home Assistant.

Compatibility

This works with BMW (and Mini) vehicles with a Connected Drive account. So far it is tested on vehicles with a ‘MGU’, ‘NBTEvo’, ‘EntryEvo’, ‘NBT’, or ‘EntryNav’ navigation system. If you have any trouble with other navigation systems, please create an issue with your server responses (see next section).

To use this library, your BMW (or Mini) must have the remote services enabled for your vehicle. You might need to book this in the Connected Drive/Mini Connected portal and this might cost some money. In addition to that you need to enable the Remote Services in your infotainment system in the vehicle.

Different models of vehicles and infotainment systems result in different types of attributes provided by the server. So the experience with the library will certaily vary across the different vehicle models.

Data Contributions

If some features do not work for your vehicle, we would need the data returned form the server to analyse this and potentially extend the code. Different models and head unit generations lead to different responses from the server.

If you want to contribute your data, perform the following steps:

# get the latest version of the library
pip3 install --upgrade bimmer_connected

# run the fingerprint function
bimmerconnected fingerprint <username> <password> <region>

This will create a set of log files in the “vehicle_fingerprint” folder. Before sending the data to anyone please check for any personal data. The following attributes should be replaced with default values: * vin (=Vehicle Identification Number) * lat and lon (=GPS position) * licensePlate

Create a new issue in bimmer_connected and add the files as attachment to the issue.

Please add your model and year to the title of the issue, to make it easier to organize. If you know the “chassis code” of your car, you can include that too. (For example, Googling “2017 BMW X5” will show a Wikipedia article entitled “BMW X5 (F15)”. F15 is therefore the chassis code of the car.)

Note: We will then use this data as additional test cases. So we will publish (parts of) it (after checking for personal information again) and use this as test cases for our library. If you do not want this, please let us know in advance.

Code Contributions

Contributions are welcome! Please make sure that your code passed the “tox” checks. And please add tests where it makes sense. The more the better.

https://travis-ci.org/bimmerconnected/bimmer_connected.svg?branch=master https://coveralls.io/repos/github/bimmerconnected/bimmer_connected/badge.svg?branch=master

Thank you

Thank you Christian, @m1n3rva, @kernelkraut, @robbz23 and @lawtancool for your research and contributions!

This library is basically a best-of of other similar solutions, yet none of them provided a ready to use library with a matching interface to be used in Home Assistant and is available on pypi.

Thank you for your great software!

License

The bimmer_connected library is licensed under the Apache License 2.0.

Disclaimer

This library is not affiliated with or endorsed by BMW Group.

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

bimmer_connected-0.7.2.tar.gz (25.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

bimmer_connected-0.7.2-py3-none-any.whl (25.8 kB view details)

Uploaded Python 3

File details

Details for the file bimmer_connected-0.7.2.tar.gz.

File metadata

  • Download URL: bimmer_connected-0.7.2.tar.gz
  • Upload date:
  • Size: 25.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.43.0 CPython/3.8.2

File hashes

Hashes for bimmer_connected-0.7.2.tar.gz
Algorithm Hash digest
SHA256 b7064407a1ed0faf01987054e4818ccdb7366b2c7ed86e4a4224f3020edcc326
MD5 052156651cd83a6e029379b47b7e0fc1
BLAKE2b-256 f0b3d03c7e2f898abb5fa9b159c67b74a4be3e3987065f5a0c4f5d4d7bc40a8c

See more details on using hashes here.

File details

Details for the file bimmer_connected-0.7.2-py3-none-any.whl.

File metadata

  • Download URL: bimmer_connected-0.7.2-py3-none-any.whl
  • Upload date:
  • Size: 25.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.43.0 CPython/3.8.2

File hashes

Hashes for bimmer_connected-0.7.2-py3-none-any.whl
Algorithm Hash digest
SHA256 1aea18ee8f3ec9bb5a2a92de0d721378ab0de248d77bc5b8c071ab719e4aee58
MD5 a21765ee9d24ffdc7ae53ee835f51d3e
BLAKE2b-256 f2e456d0bd279cf955842c11edf3ac395c6a5423c8d31a4b65a92c8954aa258e

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page