PyArtNet
pyartnet is a python implementation of the ArtNet protocol using asyncio. Supported protocols are ArtNet, sACN and KiNet.
Getting Started
import asyncio
from pyartnet import ArtNetNode
async def main():
# Run this code in your async function
node = ArtNetNode('IP', 6454)
# Create universe 0
universe = node.add_universe(0)
# Add a channel to the universe which consists of 3 values
# Default size of a value is 8Bit (0..255) so this would fill
# the DMX values 1..3 of the universe
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], 1000)
# this can be used to wait till the fade is complete
await channel
asyncio.run(main())
Channels
Accessing channels
Created channels can be requested from the universe through the [] syntax or through BaseUniverse.get_channel().
If no channel name is specified during creation the default name will be built with {START}/{WIDTH}.
# create node/universe
node = ArtNetNode('IP', 6454)
universe = node.add_universe(0)
# create the channel
channel = universe.add_channel(start=1, width=3)
# after creation this would also work (default name)
channel = universe['1/3']
channel = universe.get_channel('1/3')
# it's possible to name the channel during creation
universe.add_channel(start=4, width=3, channel_name='Dimmer1')
# access is then by name
channel = universe['Dimmer1']
channel = universe.get_channel('Dimmer1')
Wider channels
Currently there is support for 8Bit, 16Bit, 24Bit and 32Bit channels.
Channel properties can be set when creating the channel through BaseUniverse.add_channel().
# create node/universe
node = ArtNetNode('IP', 6454)
universe = node.add_universe(0)
# create a 16bit channel
channel = universe.add_channel(start=1, width=3, byte_size=2)
Output correction
Output correction
It is possible to use an output correction to create different brightness curves. Output correction can be set on the channel, the universe or the node. The universe output correction overrides the node output correction and the channel output correction overwrites the universe output correction.
The graph shows different output values 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.
Example
from pyartnet import ArtNetNode, output_correction
# create node/universe/channel
node = ArtNetNode('IP', 6454)
universe = node.add_universe(0)
channel = universe.add_channel(start=1, width=3)
# set quadratic correction for the whole universe to quadratic
universe.set_output_correction(output_correction.quadratic)
# Explicitly set output for this channel to linear
channel.set_output_correction(output_correction.linear)
# Remove output correction for the channel.
# The channel will now use the correction from the universe again
channel.set_output_correction(None)
Class Reference
Universe and Channel
- class pyartnet.BaseUniverse(node, universe=0)
- add_channel(start, width, channel_name='', byte_size=1, byte_order='little')
Add a new channel to the universe. This will automatically resize the universe accordingly.
- get_channel(channel_name)
Return a channel by name or raise an exception
- class pyartnet.Channel(universe, start, width, byte_size=1, byte_order='little')
- get_values()
Get the current (uncorrected) channel values
- set_fade(values, duration_ms, fade_class=<class 'pyartnet.fades.fade_linear.LinearFade'>)
Add and schedule a new fade for the channel
- Parameters
values (
Collection[Union[int,FadeBase]]) – Target values for the fadeduration_ms (
int) – Duration for the fade in msfade_class (
Type[FadeBase]) – What kind of fade
- set_output_correction(func)
Set the output correction function.
- set_values(values)
Set values for a channel without a fade
- Parameters
values (
Collection[Union[int,float]]) – Iterable of values with the same size as the channel width
Node implementations
- class pyartnet.ArtNetNode(ip, port, *, max_fps=25, refresh_every=2, start_refresh_task=True, source_address=None, sequence_counter=True)
- add_universe(nr=0)
Creates a new universe and adds it to the parent node
- get_universe(nr)
Get universe by number
- set_output_correction(func)
Set the output correction function.
- start_refresh()
Manually start the refresh task (if not already running)
- stop_refresh()
Manually stop the refresh task
- class pyartnet.KiNetNode(ip, port, *, max_fps=25, refresh_every=2, start_refresh_task=True, source_address=None)
- add_universe(nr=0)
Creates a new universe and adds it to the parent node
- get_universe(nr)
Get universe by number
- set_output_correction(func)
Set the output correction function.
- start_refresh()
Manually start the refresh task (if not already running)
- stop_refresh()
Manually stop the refresh task
- class pyartnet.SacnNode(ip, port, *, max_fps=25, refresh_every=2, start_refresh_task=True, source_address=None, cid=None, source_name=None)
- add_universe(nr=0)
Creates a new universe and adds it to the parent node
- get_universe(nr)
Get universe by number
- set_output_correction(func)
Set the output correction function.
- start_refresh()
Manually start the refresh task (if not already running)
- stop_refresh()
Manually stop the refresh task
Fades
Available output corrections
- pyartnet.output_correction.quadratic(val, max_val=255)
Quadratic output correction
- Return type