ArtNet.Packet.ArtRdm (ArtNet v0.1.0)

Carries non-discovery RDM messages over Art-Net.

Use this packet for RDM traffic that is not part of the RDM discovery process.

Packet layout

Part	Field	Description	Default	Size	Format
Header	`id`		fixed	8 bytes	`"Art-Net\\0"`
Header	`op_code`		`0x8300`	2 bytes	little-endian OpCode
Header	`prot_ver`		`14`	2 bytes	protocol version
Payload	`rdm_version`	RDM protocol version.	`1`	1 byte	unsigned integer (8 bits)
Payload	`filler2`	Reserved byte, transmitted as zero.	`0`	1 byte	unsigned integer (8 bits)
Payload	`spare`	Reserved bytes, transmitted as zero.	`<<0, 0, 0, 0, 0>>`	5 bytes	binary (5 bytes)
Payload	`fifo_available`	Number of RDM messages available in the node FIFO.	`0`	1 byte	unsigned integer (8 bits)
Payload	`fifo_max`	Maximum RDM FIFO capacity.	`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	`command`	RDM command action.	`:ar_process`	1 byte	`ArtNet.Packet.EnumTable.RdmCommand` enum
Payload	`address`	Low byte of the target Port-Address.	required	1 byte	unsigned integer (8 bits)
Payload	`rdm_packet`	Embedded RDM packet bytes.	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.ArtRdm{
  address: :integer,
  command: ArtNet.Packet.EnumTable.RdmCommand.type(),
  fifo_available: :integer,
  fifo_max: :integer,
  filler2: :integer,
  net: :integer,
  rdm_packet: [:integer],
  rdm_version: :integer,
  spare: :binary
}

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

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.