---
title: "DmxDevice"
description: "API documentation for DmxDevice"
url: https://developer.disguise.one/python-api/docs/dmxdevice/
---

# DmxDevice

See also: [Devices Guide](/plugins/guides/devices)

Base class (inherits properties and methods): _[Device](/python-api/docs/device#device)_

## Properties

#### **IP\_address** : _str_

IP address to send or receive DMX commands

#### **actualStatus** : _str_

_UserName: Status_

#### **configured** : _bool_ _(Read-Only)_

#### **directionality** : _int_

_Options: {0: ‘Input And Output’, 1: ‘Output’, 2: ‘Input’}  
UserName: Directionality_

#### **driver** : _int_

Defines the protocol the driver accepts

_Options: {0: ‘Art-Net’, 1: ‘Enttec’, 2: ‘SoundLight’, 3: ‘ezDMX’, 4: ‘KiNET v1’, 5: ‘KiNET v2’, 6: ‘sACN’}  
UserName: Driver_

#### **driverSpecificOptions** : _[DmxDriverSpecificOptions](/python-api/docs/dmxdriverspecificoptions#dmxdriverspecificoptions)_

#### **machine** : _[Machine](/python-api/docs/machine#machine)_

Machine designated to output DMX through this device. If (none), director outputs DMX

_UserName: Machine_

#### **mappingSynopsis** : _str_ _(Read-Only)_

#### **speed** : _int_

Limit send frequency, as a multiple of video output frames. Set to 44Hz if experiencing issues on receiving devices.  
At 60fps, 44Hz limit would output at 30Hz - every other frame, as 60Hz exceeds the limit.

_Options: {0: ‘44Hz limit’, 1: ‘Unlimited’}  
UserName: Maximum rate_

#### **start\_universe** : _int_

In conjunction with ‘number of universes’, defines the universe range of the device. ‘start universe’ is the 1-based number of the first universe handled by the device

_UserName: d3 universe start_

#### **universe\_mapping** : _List\[int\]_

#### **universes** : _int_

In conjunction with ‘start universe’, defines the universe range of the device. ‘number of universes’ is the number of universes in the range

_UserName: Number of universes_

## Variables

#### **ArtnetDevice** : _Final\[[DmxDriverType](/python-api/docs/dmxdrivertype#dmxdrivertype)\]_ = DmxDriverType.Artnet

#### **EnttecDevice** : _Final\[[DmxDriverType](/python-api/docs/dmxdrivertype#dmxdrivertype)\]_ = DmxDriverType.Enttec

#### **EzdmxDevice** : _Final\[[DmxDriverType](/python-api/docs/dmxdrivertype#dmxdrivertype)\]_ = DmxDriverType.Ezdmx

#### **KinetV1Device** : _Final\[[DmxDriverType](/python-api/docs/dmxdrivertype#dmxdrivertype)\]_ = DmxDriverType.KinetV1

#### **KinetV2Device** : _Final\[[DmxDriverType](/python-api/docs/dmxdrivertype#dmxdrivertype)\]_ = DmxDriverType.KinetV2

#### **Receive** : _Final\[[DmxDirectionality](/python-api/docs/dmxdirectionality#dmxdirectionality)\]_ = DmxDirectionality.RECEIVE

#### **SacnDevice** : _Final\[[DmxDriverType](/python-api/docs/dmxdrivertype#dmxdrivertype)\]_ = DmxDriverType.Sacn

#### **Send** : _Final\[[DmxDirectionality](/python-api/docs/dmxdirectionality#dmxdirectionality)\]_ = DmxDirectionality.SEND

#### **SendAndReceive** : _Final\[[DmxDirectionality](/python-api/docs/dmxdirectionality#dmxdirectionality)\]_ = DmxDirectionality.BOTH

#### **SoundlightDevice** : _Final\[[DmxDriverType](/python-api/docs/dmxdrivertype#dmxdrivertype)\]_ = DmxDriverType.Soundlight

#### **WendiUnsupportedDevice** : _Final\[[DmxDriverType](/python-api/docs/dmxdrivertype#dmxdrivertype)\]_ = DmxDriverType.WendiUnsupported

## Methods

#### **driverStatus**(self) -> _str_

#### **driverType**(self) -> _str_

#### **lastSent**(self) -> _float_

#### **lastValid**(self) -> _float_

#### **updateDriverOptions**(self)