pymodi 0.5.1

Easy😆 and fast💨 MODI Python API package.

===============
pyMODI
===============


.. image:: https://img.shields.io/pypi/v/pymodi.svg
:target: https://pypi.python.org/pypi/pymodi

.. image:: https://img.shields.io/pypi/pyversions/pymodi.svg
:target: https://pypi.python.org/pypi/pymodi

.. image:: https://img.shields.io/travis/LUXROBO/pyMODI.svg
:target: https://travis-ci.org/LUXROBO/pyMODI

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


.. image:: https://pyup.io/repos/github/LUXROBO/pyMODI/shield.svg
:target: https://pyup.io/repos/github/LUXROBO/pyMODI/
:alt: Updates



Easy😆 and fast💨 MODI Python API package.


* Free software: MIT license
* Documentation: https://pymodi.readthedocs.io.


Features
--------

* Connect to the MODI network module and control input & output modules.
* List serial ports of MODI network modules.
* Turn on or off the PnP mode of MODI modules.
* Get the position information of each modules.

Build Status
-------

master:

.. image:: https://travis-ci.org/LUXROBO/pyMODI.svg?branch=master
:target: https://travis-ci.org/LUXROBO/pyMODI

develop:

.. image:: https://travis-ci.org/LUXROBO/pyMODI.svg?branch=develop
:target: https://travis-ci.org/LUXROBO/pyMODI

Quickstart
-------

Install the latest pyMODI if you haven't installed it yet::

pip install -U pymodi

Import `modi` package and create `MODI` instance::

import modi
bundle = modi.MODI()

List connected modules::

bundle.modules

List connected LED modules and pick the first one::

bundle.leds # List.
bundle.leds[0] # Pick.

Let's blink the LED's light 5 times::

import time

led = bundle.leds[0]

for _ in range(10):
led.on()
time.sleep(1)
led.off()
time.sleep(1)

Credits
-------

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


=======
History
=======

0.1.0 (2018-06-28)
------------------

* First release on in-house GitLab.


0.1.1 (2018-07-20)
------------------

* Requirements fix.
* Packages' include path fix.


0.1.2 (2018-07-23)
------------------

* Python 3.4 support.


0.2.0 (2018-07-25)
------------------

* Speaker module support.
* Display module support.


0.2.1 (2018-07-27)
-----------------

* Add speaker module's tune() and off() methods.
* Remove duplicated codes.

0.3.0 (2018-07-28)
-----------------

* Support python 2.7.
* Speed up the performance.

0.3.1 (2018-07-28)
-----------------

* Requirements fix.

0.4.0 (2018-08-20)
-----------------

* Performance improvement.
* The first documentation complete.

0.5.0 (2018-08-22)
-----------------

* Change the project name to pyMODI.

0.5.1 (2018-11-07)
-----------------

* Fix #26 (No MODI network module connected) issue.