Metadata-Version: 2.1
Name: serial_interface
Version: 2.1.3
Summary: Extends serial.Serial to add methods such as auto discovery of available serial ports in Linux, Windows, and Mac OS X
Home-page: https://github.com/janelia-pypi/serial_interface_python
Author: Peter Polidoro
Author-email: peter@polidoro.io
License: BSD
Keywords: serial
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: Topic :: Software Development :: Build Tools
Classifier: License :: OSI Approved :: BSD License
Classifier: Programming Language :: Python :: 3
License-File: LICENSE

serial_interface_python
=======================

This Python package (serial_interface) creates a class named
SerialInterface, which inherits from serial.Serial and adds methods to
it, like auto discovery of available serial ports in Linux, Windows,
and Mac OS X. The SerialInterface class can be used by itself, but it is
mostly intended to be a base class for other serial port devices with
higher level functions.

Authors::

    Peter Polidoro <peter@polidoro.io>

License::

    BSD

Example Usage::

    from serial_interface import SerialInterface, find_serial_interface_ports
    find_serial_interface_ports() # Returns list of available serial ports
    dev = SerialInterface() # Might automatically find device if one available
    # if it is not found automatically, specify port directly
    dev = SerialInterface(port='/dev/ttyUSB0') # Linux
    dev = SerialInterface(port='/dev/tty.usbmodem262471') # Mac OS X
    dev = SerialInterface(port='COM3') # Windows
    dev.get_device_info()
    from serial_interface import SerialInterfaces
    devs = SerialInterfaces()  # Might automatically find all available devices
    # if they are not found automatically, specify ports to use
    devs = SerialInterfaces(use_ports=['/dev/ttyUSB0','/dev/ttyUSB1']) # Linux
    devs = SerialInterfaces(use_ports=['/dev/tty.usbmodem262471','/dev/tty.usbmodem262472']) # Mac OS X
    devs = SerialInterfaces(use_ports=['COM3','COM4']) # Windows
    devs.get_devices_info()
    devs.sort_by_port()
    dev = devs[0]
    dev.get_device_info()


