USPP
Universal Serial Port Python Library
(Librería en Python para el acceso universal al puerto serie)
Copyright 2001 Isaac Barona
ibarona@tid.es
Indice
  1. Introducción
  2. Motivación
  3. Características
  4. Pre-requisitos
  5. Utilización y documentación
  6. Dónde funciona
  7. Portado a otras plataformas
  8. Licencia
  9. Autor
  10. Versiones
Introducción
    La librería USPP es un módulo desarrollado en Python para el acceso multiplataforma al puerto serie. En el momento, sólo funciona en Linux y en Windows (las plataformas a las que tengo acceso), pero como está escrita completamente en Python (no es únicamente un recubrimiento en Python de una librería desarrollada en C/C++) espero que pueda ser ampliada para que soporte otras plataformas.
Motivación

    A mí me gusta mucho hacer pequeños cacharros electrónicos con microcontroladores, especialmente aquellos que pueden ser conectados a un ordenador para enviar y recibir datos.

    Hace un par de meses descubrí Python y realmente me encantó. Empezé a jugar con él y ví que podía utilizarlo para hacer prototipos de protocolos de comunicación entre el ordenador y los microcontroladores de manera mucho más fácil y rápida que utilizando C (que era el lenguaje que solía utilizar). Al mismo tiempo, estaba interesado en poder utilizar los desarrollos bajo diferentes arquitecturas.

    Empezé a buscar en la red módulos de Python que accedieran al puerto serie y encontré los siguientes:

    • win32comport_demo que viene junto a la extensión win32.
    • Módulo win32comm de wheineman@uconect.net.
    • Sio Module de Roger Rurnham (rburnham@cri-inc.com).
    • pyxal (Python X10 Abstraction Layer) de Les Smithson (lsmithson@open-networks.co.uk).

    pero no eran multiplataforma, eran únicamente un recubrimiento de una librería propietaria o eran simples ejemplos de acceso al puerto serie bajo una determinada plataforma.

    Por estas razones, y también por supuesto, por aprender más Python, decidí empezar este proyecto. Por supuesto, he utilizado los módulos indicados anteriormente como referencia para realizar mi librería y por tanto, me creo en la obligación de felicitar a sus autores por su excelente trabajo y por haberlo compartido con los demás.

    Espero que disfrutes utilizándo el módulo uspp tanto como yo lo he hecho haciéndolo.

Características
Este módulo tiene las siguientes características destacadas:
  • acceso de alto nivel al puerto serie bajo diversas plataformas.
  • autodetecta la plataforma en la que se está ejecutando y carga las clases adecuadas para esa plataforma.
  • Orientado a objetos.
  • Las operaciones sobre el puerto serie tienen la misma semántica que las operaciones sobre objetos de tipo fichero.
  • permite utilizar el puerto serie con diferentes velocidades y características.
  • permite la utilización del puerto bajo dos modos de funcionamiento: RS-232 y RS-485 (de momento, sólo RS-232). En modo 485 la comunicación es half-duplex y se utiliza la línea RTS para controlar la dirección de la transferencia.
  • lecturas en modo bloqueante, no bloqueante o con timeout.
Pre-requisitos
Se necesita lo siguiente para utilizar la librería:
  • Python 1.5.2 o superior.
  • En windows los módulos win32
Utilización y documentación
Únicamente tienes que importar en tu programa el módulo uspp y automáticamente él se encarga de cargar las clases adecuadas para la plataforma en la que se está ejecutando el programa.

Lo primero de todo, tendrás que crear un objeto de tipo SerialPort con las características que desees. Si no se genera ninguna excepción del tipo SerialPortException, puedes utilizar los métodos de lectura y escritura del objeto para leer y escibir en el puerto serie.

Ejemplo:


>>> from uspp import *
>>> tty=SerialPort("COM2", 1000, 9600)  
>>> # Abre el puerto serie COM2 a 9600 bps y con un timeout de 1 segundo.
>>> tty.write("a")  # Envía el carácter 'a' al puerto serie.
>>> # Ahora suponemos que recibimos el string 'abc'
>>> tty.inWaiting()
3
>>> tty.read()
'a'
>>> tty.inWaiting()
2
>>> tty.read(2)
'bc'

La documentación de las diferentes clases y métodos que componen el módulo puede encontrarse en el string de documentación del módulo uspp.

Dónde funciona
La librería ha sido probada en una máquina con Windows 95 y Python 2.0 y en un Linux (con el kernel 2.0.34) con Python 1.5.2 y Python 2.0.1.
Portado a otras plataformas
Si quieres portar la librería a otras plataformas sólo tienes que seguir los siguientes pasos:
  • Crear un nuevo fichero en python llamado SerialPort_XXX.pyen el que implementes las mismas clases y métodos públicos que aparecen en los módulos SerialPort_win y SerialPort_linux.
  • Añadir la nueva plataforma en el fichero uspp.py.
Licencia
Este código se libera bajo la licencia "GPL" que puedes encontrar en http://www.gnu.org/copyleft/gpl.html o en el fichero GPL.txt que acompaña a la librería.

Si utilizas este software estaría muy agradecido de saberlo.

Autor
Esta librería ha sido creada por Isaac Barona Martínez (ibarona@tid.es)
Versiones
  • Versión 0.1 - 01/09/2001

  • Ficheros:

    Problemas pendientes

    Bajo Linux, obtengo el siguiente error cuando llamo al método inWaiting:
    
    >>> tty.inWaiting()
    Traceback (most recent call last):
      File "", line 1, in ?
      File "SerialPort_linux.py", line 179, in inWaiting
        n=fcntl.ioctl(self.__handle, TERMIOS.TIOCINQ)
    IOError: [Errno 14] Bad address
    

    Yo he utilizado esta llamada ioctl en programas previos desarrollados en C y me funcionó perfectamente. Por favor, ¡¡¡¡necesito ayuda!!!!!

    Si quieres informar sobre algún error o indicar alguna sugerencia, envíame un mail a ibarona@tid.es.

    Tareas pendientes

    Esta es la lista de tareas pendientes:
    • corregir el error en la versión de Linux del método inWaiting.
    • implementar el modo RS-485.
    • portar la librería a otras plataformas de forma que sea realmente multiplataforma.
Copyright 2001 Isaac Barona