pyartnet 0.7.0

Python wrappers for the Art-Net protocol to send DMX over Ethernet

pyartnet

pyartnet is a python implementation of the ArtNet protocol using asyncio.

Usage

Fades

from pyartnet import ArtNetNode

node = ArtNetNode('IP')
await node.start()

universe = node.add_universe(0)
channel  = universe.add_channel(start=1, width=3)

# Fade channel to 255,0,0 in 5s
# The fade will automatically run in the background
channel.add_fade([255,0,0], 5000)   

# this can be used to wait till the fade is complete
await channel.wait_till_fade_complete()

Channel handling

Created channels can be requested from the universe through the dict syntax or through universe.get_channel(). If no channel name is specified during creation the default name will be {START}/{WIDTH}.

channel = universe['1/3']  
channel = universe.get_channel('1/3')  

Callbacks

There are two possible callbacks on the channel which make it easy to implement additional logic. The callback takes the channel as an argument. This example shows how to automatically fade the channel up and down.

from pyartnet import ArtNetNode, DmxChannel

node = ArtNetNode('IP')
universe = node.add_universe(0)

channel = universe.add_channel(start=1, width=3)

def cb(ch: DmxChannel):
    ch.add_fade([0] if ch.get_channel_values() == [255] else [255], 1000)

channel.callback_fade_finished = cb
channel.callback_value_changed = my_func2

Output correction

It is possible to use an output correction to create different fade curves. Output correction can be set on the universe or on the individual channel.

from pyartnet import ArtNetNode, output_correction

node = ArtNetNode('IP')

universe = node.add_universe(0)
universe.output_correction = output_correction.quadratic  # quadratic will be used for all channels

channel = universe.add_channel(start=1, width=3)
channel.output_correction = output_correction.cubic       # this channel will use cubic

The graph shows different output depending on the output correction.

From left to right: linear (default when nothing is set), quadratic, cubic then quadruple

Quadratic or cubic results in much smoother and more pleasant fades when using LED Strips.

Changelog

0.7.0 (28.10.2020)

• renamed logger to pyartnet to make it consistent with the module name
• callbacks on the channel now get the channel passed in as an argument
• Adding the same channel multiple times or adding overlapping channels raises an exception
• Added pyartnet.errors
• optimized logging of sent frames

0.6.0 (27.10.2020)

• ArtnetNode.start is now an async function
• ArtnetNode.step_time_ms renamed to ArtnetNode.step_time (shouldn't be used manually anyway)
• removed support for python 3.6
• added more and better type hints
• switched to pytest
• small fixes