Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merge changes from @BRLighthouse #1

Open
wants to merge 8 commits into
base: master
Choose a base branch
from
Open

Merge changes from @BRLighthouse #1

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
9cb3460
pep8 formating
Apr 2, 2016
ced9060
allocated dmxFrame, added setChannel function, changed sendDMX to ren…
Apr 2, 2016
143b510
added thanks to creator
Apr 2, 2016
3bccd09
added autorender feature to setChannel, and created a set multiple ch…
Apr 2, 2016
073ccb1
test now matches new methods
Apr 2, 2016
c248967
Update README.md
Geethree Apr 15, 2016
09954e4
Use 2 stop bits instead of the default of one.
fragmede Jul 13, 2016
6187323
Avoid python2 default empty list gotcha.
fragmede Jul 13, 2016
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
176 changes: 109 additions & 67 deletions EnttecUsbDmxPro.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,38 +6,50 @@
import sys
import serial
try:
import serial.tools
import serial.tools.list_ports
serial_tools_avail = True
import serial.tools
import serial.tools.list_ports
serial_tools_avail = True
except ImportError:
serial_tools_avail = False
serial_tools_avail = False
import struct
import threading
import time
import binascii
import traceback


class EnttecUsbDmxPro:
# Constructor, destructors and globals
# Constructor, destructors and globals
def __init__(self):
self.serial = serial.Serial()
self.debug = {'SerialBuffer':False, 'RXWarning':False}
self.widget = {'SerialNumber':0x0FFFFFFFF, 'UserParameters':{'FirmwareVersion':[0,0], 'DMXBreak':96, 'DMXMarkAfterBreak':10, 'DMXRate':40}} # Initialize the register. Note that DMXOutBreak and DMXMarkAfterBreak are in 10.67us units
self.widget_event = {'SerialNumber':threading.Event(), 'UserParameters':threading.Event(), 'ThreadExit':threading.Event()} # Initialize the data requests variable
self.serial = serial.Serial(stopbits=2)
self.debug = {'SerialBuffer': False, 'RXWarning': False}

# Initialize the register. Note that DMXOutBreak and DMXMarkAfterBreak are in 10.67us units
self.widget = {'SerialNumber': 0x0FFFFFFFF, 'UserParameters': {'FirmwareVersion': [0, 0], 'DMXBreak': 96, 'DMXMarkAfterBreak': 10, 'DMXRate': 40}}

# Initialize the data requests variable
self.widget_event = {'SerialNumber': threading.Event(), 'UserParameters': threading.Event(), 'ThreadExit': threading.Event()}
self.serial.port = ""
self.dmxRX = {"status":0,"frame":[]}
if sys.version_info > (3,0):
self.dmxRX = {"status": 0, "frame": []}

self.univSize = 512
self.dmxFrame = [0] * self.univSize

if sys.version_info > (3, 0):
self.py2 = False
else:
self.py2 = True
def setPort(self,port,baud=57600):

def setPort(self, port, baud=57600):
self.serial.port = port
self.serial.baudrate = baud

def getPort(self):
return self.serial.port
def setDebug(mode,value):

def setDebug(self, mode, value):
self.debug[mode] = value
def getDebug(mode="all"):

def getDebug(self, mode="all"):
if mode == "all":
return self.debug
else:
Expand All @@ -48,46 +60,53 @@ def connect(self):
# Open and connect to the serial port
if self.serial.isOpen():
print(serial)
disconnect()
print("Opening Enttec USB DMX Pro on",self.serial.port,"at",self.serial.baudrate,"baud")
self.disconnect()
print("Opening Enttec USB DMX Pro on", self.serial.port, "at", self.serial.baudrate, "baud")
self.serial.open()
self.widget_event['ThreadExit'].clear()
self.thread_read = threading.Thread(target=self.reader)
self.thread_read.setDaemon(True)
self.thread_read.setName("EnttecUsbDmxPro Reader on "+self.serial.port)
self.thread_read.setName("EnttecUsbDmxPro Reader on " + self.serial.port)
self.thread_read.start()
print("Open successful!")
def open(self, baud=57600): #

def open(self, baud=57600):
self.connect(baud)

def isOpen(self):
return self.serial.isOpen()

def list(self):
if serial_tools_avail:
print(serial.tools.list_ports.comports())
else:
raise RuntimeError("Serial Tools is not available")

def disconnect(self):
# Disconnects from the serial port and closes read thread
print('Stopping the read thread...')
self.widget_event['ThreadExit'].set() # Signal the thread to stop
self.widget_event['ThreadExit'].wait() # Wait for the signal to be cleared
self.thread_read.join() # Make sure the thread is stopped
print("Closing Enttec USB DMX Pro on",self.serial.port,"at",self.serial.baudrate,"baud")
self.serial.close() # Close the serial port
self.widget_event['ThreadExit'].set() # Signal the thread to stop
self.widget_event['ThreadExit'].wait() # Wait for the signal to be cleared
self.thread_read.join() # Make sure the thread is stopped
print("Closing Enttec USB DMX Pro on", self.serial.port, "at", self.serial.baudrate, "baud")
self.serial.close() # Close the serial port
print("Close successful!")
def close(self):

def close(self):
self.disconnect()

def sendmsg(self,label,message=[]):
def sendmsg(self, label, message=None):
if message is None:
message = []
l = len(message)
lm = l >> 8
ll = l-(lm << 8)
ll = l - (lm << 8)
if l <= 600:
if self.isOpen():
self.serial.write(bytearray([0x7E,label,ll,lm]+message+[0xE7]))
self.serial.write(bytearray([0x7E, label, ll, lm] + message + [0xE7]))
else:
sys.stderr.write('TX_ERROR: Malformed message! The message to be send is too long!\n')

# Serial reading thread (and related)
def reader(self):
# loop forever and copy the supported values to their appropriate registers
Expand All @@ -96,36 +115,36 @@ def reader(self):
while not self.widget_event['ThreadExit'].is_set():
try:
if self.serial.inWaiting() > 0:
rx += self.serial.read(self.serial.inWaiting()) # Read the buffer into a variable
for i in rx: # Convert the byte string into something a little more useful
rx += self.serial.read(self.serial.inWaiting()) # Read the buffer into a variable
for i in rx: # Convert the byte string into something a little more useful
if self.py2:
i =struct.unpack('B',i)[0]
i = struct.unpack('B', i)[0]
self.serialbuffer += [i]
rx = b''
si = 0
for i in self.serialbuffer: # Find the start byte
for i in self.serialbuffer: # Find the start byte
if i != 0x7E:
si += 1
else:
break
if si > 0: # Remove anything before the start byte
if si > 0: # Remove anything before the start byte
if self.debug['RXWarning']:
if self.debug['SerialBuffer']:
print("IVD:",self.serialbuffer)
print("IVD:", self.serialbuffer)
sys.stderr.write('RX_WARNING: Removing invalid data from buffer\n')
self.serialbuffer = self.serialbuffer[si:-1]
if len(self.serialbuffer) >= 4:
m_label = self.serialbuffer[1]
m_size = self.serialbuffer[2] + (self.serialbuffer[3] << 8)
m_cont = self.serialbuffer[4:4+m_size]
endbyte_loc=4+m_size
m_cont = self.serialbuffer[4:4 + m_size]
endbyte_loc = 4 + m_size
if endbyte_loc >= len(self.serialbuffer):
if self.debug['SerialBuffer']:
print(self.serialbuffer)
if len(m_cont) == m_size:
if self.debug['RXWarning']:
sys.stderr.write('RX_WARNING: No end byte was found, but the message appears to be complete. Message will be parsed.\n')
self.parse(m_label,m_cont)
self.parse(m_label, m_cont)
self.serialbuffer = []
else:
if self.debug['RXWarning']:
Expand All @@ -134,59 +153,61 @@ def reader(self):
if self.debug['SerialBuffer']:
print(self.serialbuffer)
if self.debug['RXWarning']:
sys.stderr.write('RX_WARNING: Malformed message! Expecting an end byte, but did not find one! Found byte {0} at location {2} in self.serialbuffer {1}\n'.format(self.serialbuffer[4+m_size],self.serialbuffer,endbyte_loc))
self.serialbuffer = self.serialbuffer[endbyte_loc+1:]
sys.stderr.write('RX_WARNING: Malformed message! Expecting an end byte, but did not find one! Found byte {0} at location {2} \
in self.serialbuffer {1}\n'.format(self.serialbuffer[4 + m_size], self.serialbuffer, endbyte_loc))
self.serialbuffer = self.serialbuffer[endbyte_loc + 1:]
else:
if self.debug['SerialBuffer']:
print(self.serialbuffer)
self.parse(m_label,m_cont)
self.parse(m_label, m_cont)
if len(self.serialbuffer) > endbyte_loc:
self.serialbuffer = self.serialbuffer[endbyte_loc+1:]
self.serialbuffer = self.serialbuffer[endbyte_loc + 1:]
except:
e = sys.exc_info()
sys.stderr.write('RX_FAIL: {0}: {1}\n'.format(e[0],e[1]))
sys.stderr.write('RX_FAIL: {0}: {1}\n'.format(e[0], e[1]))
traceback.print_tb(e[2])
sys.stderr.write('Data in queue: {0}\n'.format(self.serialbuffer))
time.sleep(0.01)
self.widget_event['ThreadExit'].clear()
def parse(self,label,message):

def parse(self, label, message):
# The message label and remaining data are parsed and values stored in the registers
if label == 10: # Get widget serial number reply
l = len(message)
if label == 10: # Get widget serial number reply
# l = len(message)
i = 0
sn = 0
for b in message:
sn += (b << i*8)
sn += (b << i * 8)
i += 1
self.widget['SerialNumber'] = sn
self.widget_event['SerialNumber'].set()
elif label == 5: # Get recieved DMX frame
elif label == 5: # Get recieved DMX frame
self.dmxRX["status"] = message[0]
self.dmxRX["frame"] = message[2:-1]
elif label == 3: # Get widget parameters reply
elif label == 3: # Get widget parameters reply
self.widget['UserParameters']['FirmwareVersion'][0] = message[0]
self.widget['UserParameters']['FirmwareVersion'][1] = message[1]
if message[2] >=9 and message[2] <= 127:
if message[2] >= 9 and message[2] <= 127:
self.widget['UserParameters']['DMXBreak'] = message[2]
else:
raise UsbDmxProException("ERROR: The DMX reak time recieved from the widget is invalid. Expected range: 9 to 127. Actual value: {0}".format(message[2]))
if message[3] >=1 and message[3] <= 127:
if message[3] >= 1 and message[3] <= 127:
self.widget['UserParameters']['DMXMarkAfterBreak'] = message[3]
else:
raise UsbDmxProException("ERROR: The DMX mark after break time recieved from the widget is invalid. Expected range: 1 to 127. Actual value: {0}".format(message[3]))
if message[4] >=1 and message[2] <= 40:
if message[4] >= 1 and message[2] <= 40:
self.widget['UserParameters']['DMXRate'] = message[4]
else:
raise UsbDmxProException("ERROR: The DMX Break time recieved from the widget is invalid. Expected range: 1 to 40. Actual value: {0}".format(message[4]))
self.widget_event['UserParameters'].set()


# Widget properties and parameters

def getWidgetParameters(self):
# Writes the message to get the options set in the widget hardware
# WARNING: Some third-party DMX Pro Compatible devices DO NOT support this operation
self.sendmsg(3,[1,0])
self.sendmsg(3, [1, 0])
if not self.widget_event['UserParameters'].wait(5):
raise UsbDmxProException("Widget parameters not recieved!")
else:
Expand All @@ -197,7 +218,7 @@ def setWidgetParameters(self, name, value):
# Sets the paramter `name` to `value`
# WARNING: Some third-party DMX Pro Compatible devices DO NOT support this operation
raise NotImplemented("The function setWidgetParameters in EnttecUsbDmxPro is not implemeted yet")

def getWidgetSerialNumber(self):
# Returns the serial number of the ENTTEC USB DMX Pro widget
# WARNING: Some third-party DMX Pro Compatible devices DO NOT support this operation
Expand All @@ -207,36 +228,57 @@ def getWidgetSerialNumber(self):
else:
self.widget_event['SerialNumber'].clear()
return self.widget['SerialNumber']

# DMX
def sendDMX(self, channels):
# Sends an array of up to 512 channels
data = [0] + channels
def setChannel(self, channel, value, autoRender=True):
self.dmxFrame[channel] = value
if autoRender:
self.render(upTo=channel)

def setMultipleChannels(self, valueList):
for channel, value in enumerate(valueList):
self.setChannel(channel, value)

def render(self, upTo=None):
# Sends an array of up to universe size by default or up to a a length to save time.
if upTo:
data = [0] + self.dmxFrame[0:upTo]
else:
data = [0] + self.dmxFrame
while len(data) < 25:
data += [0]
self.sendmsg(6,data)

self.sendmsg(6, data)

def blackOut(self):
# Set all channels to 0 and render
self.dmxFrame = [0] * self.univSize
self.render()

# RDM
def getRecievedFrame(self):
# Returns the last DMX frame recieved from the widget
return self.dmxRX

def requestRDM(self):
# Sends an RDM packet on the DMX and changes the direction to input to recieve it
raise NotImplemented("The function requestRDM in EnttecUsbDmxPro is not implemeted yet")

def requestDmxOnChange(self):
# Tells the widget to only send the DMX packet to the comptuer if the
# Tells the widget to only send the DMX packet to the comptuer if the
# values have changed on the input port
raise NotImplemented("The function requestDmxOnChange in EnttecUsbDmxPro is not implemeted yet")

def sendRdmDiscovery(self):
# Sends an RDM discovery packet
raise NotImplemented("The function sendRdmDiscovery in EnttecUsbDmxPro is not implemeted yet")


# Exceptions for handling DMX errors
class DMXException(Exception):
def __init__(self,message):
def __init__(self, message):
self.message = message


class UsbDmxProException(Exception):
def __init__(self,message):
def __init__(self, message):
self.message = message
Loading