obd


Nameobd JSON
Version 0.6.1 PyPI version JSON
download
home_pagehttp://github.com/brendan-w/python-OBD
SummarySerial module for handling live sensor data from a vehicle's OBD-II port
upload_time2016-08-02 01:03:56
maintainerNone
docs_urlNone
authorBrendan Whitfield
requires_pythonNone
licenseGNU GPLv2
keywords obd obdii obd-ii obd2 car serial vehicle diagnostic
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage
            python-OBD
==========

A python module for handling realtime sensor data from OBD-II vehicle
ports. Works with ELM327 OBD-II adapters, and is fit for the Raspberry
Pi.

Installation
------------

.. code:: shell

    $ pip install obd

Basic Usage
-----------

.. code:: python

    import obd

    connection = obd.OBD() # auto-connects to USB or RF port

    cmd = obd.commands.SPEED # select an OBD command (sensor)

    response = connection.query(cmd) # send the command, and parse the response

    print(response.value) # returns unit-bearing values thanks to Pint
    print(response.value.to("mph")) # user-friendly unit conversions

Documentation
-------------

Available at `python-obd.readthedocs.org`_

Commands
--------

Here are a handful of the supported commands (sensors). For a full list,
see `the docs`_

*note: support for these commands will vary from car to car*

-  Calculated Engine Load
-  Engine Coolant Temperature
-  Fuel Pressure
-  Intake Manifold Pressure
-  Engine RPM
-  Vehicle Speed
-  Timing Advance
-  Intake Air Temp
-  Air Flow Rate (MAF)
-  Throttle Position
-  Engine Run Time
-  Fuel Level Input
-  Number of warm-ups since codes cleared
-  Barometric Pressure
-  Ambient air temperature
-  Commanded throttle actuator
-  Time run with MIL on
-  Time since trouble codes cleared
-  Hybrid battery pack remaining life
-  Engine fuel rate

License
-------

GNU GPL v2

This library is forked from:

-  https://github.com/peterh/pyobd
-  https://github.com/Pbartek/pyobd-pi

Enjoy and drive safe!

.. _python-obd.readthedocs.org: http://python-obd.readthedocs.org/en/latest/
.. _the docs: http://python-obd.readthedocs.io/en/latest/Command%20Tables/

            

Raw data

            {
    "_id": null,
    "maintainer": null,
    "docs_url": null,
    "requires_python": null,
    "maintainer_email": null,
    "cheesecake_code_kwalitee_id": null,
    "keywords": "obd obdii obd-ii obd2 car serial vehicle diagnostic",
    "upload_time": "2016-08-02 01:03:56",
    "author": "Brendan Whitfield",
    "home_page": "http://github.com/brendan-w/python-OBD",
    "github_user": "brendan-w",
    "download_url": "https://pypi.python.org/packages/db/47/2b2edf5a5d04ac8f61b3c5a71a785851b87dc7e604557162fdaef2ab5643/obd-0.6.1.tar.gz",
    "platform": "UNKNOWN",
    "version": "0.6.1",
    "cheesecake_documentation_id": null,
    "description": "python-OBD\n==========\n\nA python module for handling realtime sensor data from OBD-II vehicle\nports. Works with ELM327 OBD-II adapters, and is fit for the Raspberry\nPi.\n\nInstallation\n------------\n\n.. code:: shell\n\n    $ pip install obd\n\nBasic Usage\n-----------\n\n.. code:: python\n\n    import obd\n\n    connection = obd.OBD() # auto-connects to USB or RF port\n\n    cmd = obd.commands.SPEED # select an OBD command (sensor)\n\n    response = connection.query(cmd) # send the command, and parse the response\n\n    print(response.value) # returns unit-bearing values thanks to Pint\n    print(response.value.to(\"mph\")) # user-friendly unit conversions\n\nDocumentation\n-------------\n\nAvailable at `python-obd.readthedocs.org`_\n\nCommands\n--------\n\nHere are a handful of the supported commands (sensors). For a full list,\nsee `the docs`_\n\n*note: support for these commands will vary from car to car*\n\n-  Calculated Engine Load\n-  Engine Coolant Temperature\n-  Fuel Pressure\n-  Intake Manifold Pressure\n-  Engine RPM\n-  Vehicle Speed\n-  Timing Advance\n-  Intake Air Temp\n-  Air Flow Rate (MAF)\n-  Throttle Position\n-  Engine Run Time\n-  Fuel Level Input\n-  Number of warm-ups since codes cleared\n-  Barometric Pressure\n-  Ambient air temperature\n-  Commanded throttle actuator\n-  Time run with MIL on\n-  Time since trouble codes cleared\n-  Hybrid battery pack remaining life\n-  Engine fuel rate\n\nLicense\n-------\n\nGNU GPL v2\n\nThis library is forked from:\n\n-  https://github.com/peterh/pyobd\n-  https://github.com/Pbartek/pyobd-pi\n\nEnjoy and drive safe!\n\n.. _python-obd.readthedocs.org: http://python-obd.readthedocs.org/en/latest/\n.. _the docs: http://python-obd.readthedocs.io/en/latest/Command%20Tables/\n",
    "lcname": "obd",
    "name": "obd",
    "github": true,
    "bugtrack_url": null,
    "license": "GNU GPLv2",
    "travis_ci": false,
    "github_project": "python-OBD",
    "summary": "Serial module for handling live sensor data from a vehicle's OBD-II port",
    "split_keywords": [
        "obd",
        "obdii",
        "obd-ii",
        "obd2",
        "car",
        "serial",
        "vehicle",
        "diagnostic"
    ],
    "author_email": "brendanw@windworksdesign.com",
    "urls": [
        {
            "has_sig": false,
            "upload_time": "2016-08-02T01:03:56",
            "comment_text": "",
            "python_version": "source",
            "url": "https://pypi.python.org/packages/db/47/2b2edf5a5d04ac8f61b3c5a71a785851b87dc7e604557162fdaef2ab5643/obd-0.6.1.tar.gz",
            "md5_digest": "8fce664d69981bff1c839d30a4ce7102",
            "downloads": 0,
            "filename": "obd-0.6.1.tar.gz",
            "packagetype": "sdist",
            "path": "db/47/2b2edf5a5d04ac8f61b3c5a71a785851b87dc7e604557162fdaef2ab5643/obd-0.6.1.tar.gz",
            "size": 48826
        }
    ],
    "cheesecake_installability_id": null,
    "coveralls": true
}
        
Elapsed time: 0.03216s