packedCom.py

#!/usr/bin/env python
# -*- coding: utf-8 -*-
 
# notwendige Module einbinden (packedCom)
import struct
 
# notwendige Module einbinden (comport == serial interface)
import sys
import getopt
import serial
 
class packedCom(object):
    def __init__(self, pd, fmt):
        """ Initialisiert die Klasse zum Erzeugen des packed string
        Args:
            pd  : packet descriptor. Spezifische Nummer des Datenpakets.
            fmt : format string. Gibt die Datenart für jedes Datum als Zeichen
                  an (siehe auch https://docs.python.org/2/library/struct.html)
                  z.B. c == ?        (         char)
                       b == int8_t   (signed   char)
                       B == uint8_t  (unsigned char)
                       h == int16_t  (         short)
                       H == uint16_t (unsigned short)
        """
        self.pd = pd
        self.fmt = fmt
 
    def crc16(self, data):
        """ Berechnen einer Checksumme.
        Funktion wird eingesetzt, um eine Checksumme über einen Daten-String
        zu bilden. Diese ist Bestandteil jedes Datenpaketes welches gesendet
        oder empfangen wird und dient zum ermitteln einer fehlerhaften
        Übertragung.
 
        Args:
            data:  Zu sendender Datenstring (reine Daten)
 
        Returns:
            Die Checksumme als zwei Byte langen String.
        """
        crc = 0xff
        for x in data:
            crc = self.crc_update(crc, ord(x))
        return struct.pack('H', crc & 0xffff)
 
    def crc_update(self, crc, data):
        """ Hilfsfunktion für crc16.
        Args:
            crc:  aktuelle Checksumme
            data: Einzelnes Zeichen, was der Checksumme hinzugefügt wird.
 
        Returns:
            Die aktualisierte Checksumme (als short).
        """
        data ^= (crc & 0xff)
        data = data & 0xff
        data ^= data << 4
        data = data & 0xff
        return (((data << 8) | ((crc >> 8) & 0xff)) ^ (data >> 4) ^ (data << 3))
 
    def getAsString(self, data):
        """ Konvertiert die aktuellen Daten in einen String
        Args:
            data: Daten als Liste. Die Reihenfolge muss mit dem format-string
                  bei der Initialisierung übereinstimmen.
 
        Returns:
            Den vollständigen string mit Start- und Endzeichen.
        """
 
        datastr = ""
        for i in range(len(data)):
            datastr += struct.pack(self.fmt[i], data[i])
 
        sendstr = ">*>"
        sendstr += struct.pack('H', len(datastr))
        sendstr += struct.pack('c', chr(self.pd))
        sendstr += datastr
        sendstr += self.crc16(datastr)
        sendstr += "<#<"
 
        return sendstr
 
 
class comPort(serial.Serial):
    def __init__(self):
        """ Öffnet das entsprechende ComPort mit den richtigen Einstellungen
        """
        # Standarddevice ist Kabelgebundene USB Verbindung zum Roboter
        dev = "/dev/tucbot/all_usb"
 
        # Übergabeparameter auswerten
        # Um das Programm mit dem Roboter Hugo zu nutzen muss bspw.
        # python packed_com.py -r hugo
        # gestartet werden.
        opts, args = getopt.getopt(sys.argv[1:], "r:", "robot=")
        for opt, arg in opts:
            if opt in ("-r","--robot"):
                dev = "/dev/tucbot/%s_xbee" % arg
        print("packedCom.py: Using device '%s'" % dev)
 
        # Objekt zum Zugriff auf serielle Schnittstelle anlegen
        s = serial.Serial(dev, baudrate=57600, parity='N', stopbits=2, \
          timeout=0.01)
        # moeglicherweise noch im Puffer vorhandene Daten loeschen
        s.flushInput()
 
        serial.Serial.__init__(self, dev, baudrate=57600, parity='N', \
          stopbits=2, timeout=0.01)