ArtNet.Packet.ArtDmx (ArtNet v0.1.0)

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

This packet is also known as ArtOutput. The length field must match the number of DMX slots carried in data.

Packet layout

Part	Field	Description	Default	Size	Format
Header	`id`		fixed	8 bytes	`"Art-Net\\0"`
Header	`op_code`		`0x5000`	2 bytes	little-endian OpCode
Header	`prot_ver`		`14`	2 bytes	protocol version
Payload	`sequence`	Packet sequence number, or 0 to disable sequence checking.	`0`	1 byte	unsigned integer (8 bits)
Payload	`physical`	Physical input port that generated the DMX data.	`0`	1 byte	unsigned integer (8 bits)
Payload	`sub_universe`	Low byte of the 15-bit Port-Address.	`0`	1 byte	unsigned integer (8 bits)
Payload	`net`	Bits 8-14 of the 15-bit Port-Address.	`0`	1 byte	unsigned integer (8 bits)
Payload	`length`	Number of DMX512 slots included in the data field.	required	2 bytes	unsigned integer (16 bits)
Payload	`data`	DMX512 level data, one byte per slot.	required	variable (1 byte each)	list of unsigned integer (8 bits)

Summary

Types

t()

Functions

decode(data)

Decodes a complete Art-Net binary as this packet type.

encode(packet)

Encodes this packet struct into a complete Art-Net binary.

new(attrs)

Builds a validated packet struct from a map or keyword list.

new!(attrs)

Builds a validated packet struct from a map or keyword list.

op_code()

Returns the Art-Net OpCode value for this packet module.

require_version_header?()

Returns whether this packet includes the Art-Net protocol version header.

schema()

Returns the packet payload schema in declaration order.

Types

t()

@type t() :: %ArtNet.Packet.ArtDmx{
  data: [:integer],
  length: :integer,
  net: :integer,
  physical: :integer,
  sequence: :integer,
  sub_universe: :integer
}

Functions

decode(data)

@spec decode(binary()) :: {:ok, t()} | :error

Decodes a complete Art-Net binary as this packet type.

encode(packet)

@spec encode(t()) :: {:ok, binary()} | :error

Encodes this packet struct into a complete Art-Net binary.

new(attrs)

@spec new(map() | Keyword.t()) :: {:ok, t()} | {:error, ArtNet.EncodeError.t()}

Builds a validated packet struct from a map or keyword list.

new!(attrs)

@spec new!(map() | Keyword.t()) :: t()

Builds a validated packet struct from a map or keyword list.

Raises ArtNet.EncodeError when validation fails.

op_code()

@spec op_code() :: pos_integer()

Returns the Art-Net OpCode value for this packet module.

The OpCode is 0x5000.

require_version_header?()

@spec require_version_header?() :: boolean()

Returns whether this packet includes the Art-Net protocol version header.

schema()

Returns the packet payload schema in declaration order.