API Reference ArtNet v#0.1.0

Main API for encoding and decoding Art-Net packets.

Exception returned or raised when packet decoding fails.

Low-level field decoders used by packet schemas.

Exception returned or raised when packet encoding fails.

Low-level field encoders used by packet schemas.

OpCode registry for supported Art-Net packet modules.

Encodes and decodes complete Art-Net packets.

Sends remote programming information to a node.

Sends text-based parameter commands to Art-Net devices.

Replies to ArtNet.Packet.ArtDataRequest with manufacturer-specific data.

Requests manufacturer-specific data from a device.

Carries diagnostic and data logging text from a node.

Requests a node's file list.

Replies to ArtNet.Packet.ArtDirectory with file list information.

Transmits zero-start-code DMX512 data for a single universe.

Requests a user file download from a node.

Acknowledges file download packets.

Uploads a user file to a node.

Uploads firmware or firmware extensions to a node.

Acknowledges receipt of firmware transfer packets.

Enables or disables DMX inputs on a node.

Reprograms a node's IP addressing configuration.

Acknowledges receipt of an ArtNet.Packet.ArtIpProg packet.

Represents the deprecated ArtMacMaster packet.

Represents the deprecated ArtMacSlave packet.

Sends media-server data to a controller.

Sends media control commands to a media server.

Reports media control state from a media server.

Sends media patch information to a media server.

Transmits non-zero-start-code DMX512 data for a single universe.

Discovers Art-Net nodes on the network.

Reports node identity, addressing, port status, and capability information.

Carries non-discovery RDM messages over Art-Net.

Carries compressed RDM sub-device data.

Synchronizes output of previously received DMX packets.

Transports time code over Art-Net.

Synchronizes real-time date and clock information.

Sends RDM discovery control commands to a node.

Sends a Table of Devices for RDM discovery.

Requests a Table of Devices for RDM discovery.

Sends trigger macro commands.

Sends display data for extended video features.

Sends color palette setup information for extended video features.

Sends video screen setup information for extended video features.

Decoder for VLC payloads carried by ArtNet.Packet.ArtNzs.

Decoded VLC flag bits from an ArtVlc payload.

DSL for defining packed bit-field structs.

GoodInput bit field used by ArtNet.Packet.ArtPollReply.

GoodOutput bit field used by ArtNet.Packet.ArtPollReply.

GoodOutputB bit field used by ArtNet.Packet.ArtPollReply.

Command bit field used by ArtNet.Packet.ArtIpProg.

Status bit field used by ArtNet.Packet.ArtIpProgReply.

PortType bit field used by ArtNet.Packet.ArtPollReply.

Status1 bit field used by ArtNet.Packet.ArtPollReply.

Status2 bit field used by ArtNet.Packet.ArtPollReply.

Status3 bit field used by ArtNet.Packet.ArtPollReply.

TalkToMe bit field used by ArtNet.Packet.ArtPoll.

DSL for defining integer-backed enum tables.

Address command values used by ArtNet.Packet.ArtAddress.

Failsafe state values used by ArtNet.Packet.BitField.Status3.

Firmware transfer block types used by ArtNet.Packet.ArtFirmwareMaster.

Firmware transfer reply values used by ArtNet.Packet.ArtFirmwareReply.

Indicator state values used by ArtNet.Packet.BitField.Status1.

Port-Address authority values used by ArtNet.Packet.BitField.Status1.

Port protocol type values used by ArtNet.Packet.BitField.PortType.

Diagnostic priority values used by ArtNet.Packet.ArtPoll and ArtNet.Packet.ArtDiagData.

ArtRdm command values used by ArtNet.Packet.ArtRdm.

RDM command class values used by ArtNet.Packet.ArtRdmSub.

Time code type values used by ArtNet.Packet.ArtTimeCode.

TOD control command values used by ArtNet.Packet.ArtTodControl.

TOD data command response values used by ArtNet.Packet.ArtTodData.

TOD request command values used by ArtNet.Packet.ArtTodRequest.

DSL for defining Art-Net packet structs.