ArtNet.Packet.ArtNzs (ArtNet v0.1.0)

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

This packet carries DMX-style payloads identified by start_code, except RDM. VLC payloads use start code 0x91 and can be decoded with ArtNet.Packet.ArtVlc.decode/1.

Packet layout

Part	Field	Description	Default	Size	Format
Header	`id`		fixed	8 bytes	`"Art-Net\\0"`
Header	`op_code`		`0x5100`	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	`start_code`	Non-zero DMX start code for the payload.	required	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 payload data bytes.	required	2 bytes	unsigned integer (16 bits)
Payload	`data`	Non-zero-start-code payload data.	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.ArtNzs{
  data: [:integer],
  length: :integer,
  net: :integer,
  sequence: :integer,
  start_code: :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 0x5100.

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.