ArtNet.Packet.ArtDirectory (ArtNet v0.1.0)

Requests a node's file list.

The command and file fields select which directory information the node should return.

Packet layout

Part	Field	Description	Default	Size	Format
Header	`id`		fixed	8 bytes	`"Art-Net\\0"`
Header	`op_code`		`0x9A00`	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	`command`	Directory command to execute.	required	1 byte	unsigned integer (8 bits)
Payload	`file`	Directory file index referenced by the command.	required	2 bytes	unsigned integer (16 bits)

t()

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.

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

schema()

Returns the packet payload schema in declaration order.

@type t() :: %ArtNet.Packet.ArtDirectory{
  command: :integer,
  file: :integer,
  filler: :binary
}

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

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

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

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

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

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

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

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

Raises ArtNet.EncodeError when validation fails.

@spec op_code() :: pos_integer()

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

The OpCode is 0x9A00.

@spec require_version_header?() :: boolean()

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

Returns the packet payload schema in declaration order.