ArtNet.Packet.ArtRdmSub (ArtNet v0.1.0)

Carries compressed RDM sub-device data.

This packet is used for RDM sub-device communication with command class and parameter metadata included in the payload.

Packet layout

Part	Field	Description	Default	Size	Format
Header	`id`		fixed	8 bytes	`"Art-Net\\0"`
Header	`op_code`		`0x8400`	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	`uid`	RDM responder UID.	required	6 bytes	binary (6 bytes)
Payload	`spare1`	Reserved byte, transmitted as zero.	`0`	1 byte	unsigned integer (8 bits)
Payload	`command_class`	RDM command class.	required	1 byte	`ArtNet.Packet.EnumTable.RdmCommandClass` enum
Payload	`parameter_id`	RDM parameter identifier.	required	2 bytes	unsigned integer (16 bits)
Payload	`sub_device`	RDM sub-device identifier.	required	2 bytes	unsigned integer (16 bits)
Payload	`sub_count`	Number of sub-device data entries.	required	2 bytes	unsigned integer (16 bits)
Payload	`spare`	Reserved bytes, transmitted as zero.	`<<0, 0, 0, 0>>`	4 bytes	binary (4 bytes)
Payload	`data`	RDM sub-device data values.	required	variable (2 bytes each)	list of unsigned integer (16 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.ArtRdmSub{
  command_class: ArtNet.Packet.EnumTable.RdmCommandClass.type(),
  data: [:integer],
  filler2: :integer,
  parameter_id: :integer,
  rdm_version: :integer,
  spare: :binary,
  spare1: :integer,
  sub_count: :integer,
  sub_device: :integer,
  uid: :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 0x8400.

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.