Metadata-Version: 2.1
Name: usb-iss
Version: 2.0.1
Summary: Python library for the USB-ISS board.
Home-page: https://github.com/sneakypete81/usb_iss
Author: Pete Burgers
Author-email: sneakypete81@gmail.com
License: GNU General Public License v3
Keywords: usb_iss
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
License-File: LICENSE

======================
USB-ISS Python Library
======================

.. image:: https://img.shields.io/pypi/v/usb_iss.svg
    :target: https://pypi.python.org/pypi/usb_iss
    :alt: PyPi

.. image:: https://api.travis-ci.org/sneakypete81/usb_iss.svg?branch=master
    :target: https://travis-ci.org/sneakypete81/usb_iss/branches
    :alt: TravisCI

.. image:: https://readthedocs.org/projects/usb-iss/badge/?version=latest
    :target: https://usb-iss.readthedocs.io/en/latest/?badge=latest
    :alt: Documentation Status

Python library for the USB-ISS module.

.. image:: https://www.robot-electronics.co.uk/images/usb-iss-300.png
    :alt: USB ISS Module

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

**USB-ISS hardware module:**
  https://www.robot-electronics.co.uk/htm/usb_iss_tech.htm

**USB-ISS Python library (this project):**
  https://usb-iss.readthedocs.io

Features
--------

* Supports all USB-ISS functions (I2C, IO, SPI, Serial)

* Cross-platform (Windows, Linux, MacOS, BSD)

* Supports Python 2.7 & 3.5+

* Comprehensive documentation and unit test suite

Usage Example
-------------
.. code-block:: python

    from usb_iss import UsbIss, defs

    # Configure I2C mode

    iss = UsbIss()
    iss.open("COM3")
    iss.setup_i2c()

    # Write and read back some data
    # NOTE: I2C methods use 7-bit device addresses (0x00 - 0x7F)

    iss.i2c.write(0x62, 0, [0, 1, 2]);
    data = iss.i2c.read(0x62, 0, 3)

    print(data)
    # [0, 1, 2]

Installing
----------
.. code-block:: bash

    pip install usb-iss

----

This package was created with Cookiecutter_ and the
`audreyr/cookiecutter-pypackage`_ project template.

.. _Cookiecutter: https://github.com/audreyr/cookiecutter
.. _`audreyr/cookiecutter-pypackage`: https://github.com/audreyr/cookiecutter-pypackage


=========
Changelog
=========

2.0.1 (2021-01-21)
------------------

* Add serial+I2C operating modes to read_iss_mode()

2.0.0 (2019-11-04)
------------------

* BREAKING CHANGE: Use 7-bit I2C device addresses

1.0.0 (2019-10-16)
------------------

* BREAKING CHANGE: Remember the previous IO state in the setup_* methods (thanks SamP20)
* BREAKING CHANGE: Improve the serial mode API
* Add verbose logging option

0.3.1 (2018-07-02)
------------------

* Fix Python2 serial interface

0.3.0 (2018-05-28)
------------------

* Add SPI support
* Add Serial UART support
* Improve test coverage

0.2.4 (2018-05-23)
------------------

* Add SPI, Serial and IO setup methods

0.2.3 (2018-05-22)
------------------

* Fix and test Travis PyPI auto-deploy


0.2.0 (2018-05-21)
------------------

* Generate documentation
* Add dummy driver option for test purposes
* Configure I/O as input by default
* Add i2c.read/write aliases for read_ad1/write_ad1
* Update setup_i2c to split out clk_khz and use_i2c_hardware parameters


0.1.0 (2018-04-19)
------------------

* Initial release


