ArtNet.Packet.ArtDirectoryReply (ArtNet v0.1.0)

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

The payload describes a file entry, including name, description, length, and data metadata.

Packet layout

Part	Field	Description	Default	Size	Format
Header	`id`		fixed	8 bytes	`"Art-Net\\0"`
Header	`op_code`		`0x9B00`	2 bytes	little-endian OpCode
Header	`prot_ver`		`14`	2 bytes	protocol version
Payload	`filler`	Reserved bytes, transmitted as zero.	`<<0, 0>>`	2 bytes	binary (2 bytes)
Payload	`flags`	Directory entry status flags.	required	1 byte	unsigned integer (8 bits)
Payload	`file`	Directory file index for this entry.	required	2 bytes	unsigned integer (16 bits)
Payload	`name`	Directory entry file name.	required	16 bytes	null-padded string (16 bytes)
Payload	`description`	Human-readable directory entry description.	required	64 bytes	null-padded string (64 bytes)
Payload	`length`	Length of the directory entry data in bytes.	required	8 bytes	unsigned integer (64 bits)
Payload	`data`	Directory entry data block.	required	64 bytes	binary (64 bytes)

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.ArtDirectoryReply{
  data: :binary,
  description: String.t(),
  file: :integer,
  filler: :binary,
  flags: :integer,
  length: :integer,
  name: String.t()
}

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 0x9B00.

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.