.. pyneovi documentation master file, created by
   sphinx-quickstart on Sat Apr  9 17:51:27 2016.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to pyneovi's documentation!
===================================

Overview
--------

pyneovi is a Python wrapper around the API provided by `Intrepid Control Systems <https://www.intrepidcs.com/>`_ for communicating with their NeoVI range of devices.

There are three layers to pyneovi and application code can be written against any of them:

* API wrapper layer. This is a Python wrapper around the API provided by ICS in their DLL/shared object. Code written against this will primarily use the :doc:`neovi <neovi.neovi>` module, which contains the function wrappers and associated constants. Additionally, some constants are defined in the :doc:`can <neovi.can>` module and structures are defined in the :doc:`structures <neovi.structures>` module.
* neoVI device layer. This provides a more Pythonic implementation of the API based around objects representing neoVI devices. Code written against this will primarily use the :doc:`neodevice <neovi.neodevice>` module.
* ECU layer. This shifts the focus to the devices being interacted with, providing objects representing ECUs on the network. Code written against this will primarily use the neoVI device layer to set up the interface plus the :doc:`neodevice <neovi.ecu>` module.

The API wrapper layer and the neoVI device layer may both be used as provided. The ECU layer, however, requires additional information about the ECUs being communicated with. This may be provided by the application code directly, but it will usually be preferable to construct a "vehicle spec" file. This describes the networks provided by the vehicle, the ECUs on those networks, and the signals made available by the ECUs. ECUs and signals may then be identified by their names rather than addresses and conversion of the values read from the ECU will be performed automatically. The :doc:`spec <neovi.spec>` module is used to create a vehicle spec.


Examples
--------

:doc:`examples`


Submodules
----------

.. toctree::

   neovi.can
   neovi.ecu
   neovi.neodevice
   neovi.neovi
   neovi.spec
   neovi.structures


Indices and tables
------------------

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`


Contact
-------

Web: http://kempj.co.uk

Email: kemp@kempj.co.uk