ArtNet.Packet.ArtSync (ArtNet v0.1.0)

Synchronizes output of previously received DMX packets.

Controllers send this packet to force nodes to transfer buffered ArtDmx packets to their outputs at the same time.

Packet layout

Part	Field	Description	Default	Size	Format
Header	`id`		fixed	8 bytes	`"Art-Net\\0"`
Header	`op_code`		`0x5200`	2 bytes	little-endian OpCode
Header	`prot_ver`		`14`	2 bytes	protocol version
Payload	`aux1`	Reserved auxiliary byte, transmitted as zero.	`0`	1 byte	unsigned integer (8 bits)
Payload	`aux2`	Reserved auxiliary byte, transmitted as zero.	`0`	1 byte	unsigned integer (8 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.ArtSync{aux1: :integer, aux2: :integer}

@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 0x5200.

@spec require_version_header?() :: boolean()

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

Returns the packet payload schema in declaration order.