ArtNet.Packet.ArtIpProgReply (ArtNet v0.1.0)

Acknowledges receipt of an ArtNet.Packet.ArtIpProg packet.

Nodes use this packet to report their programmed IP address, subnet mask, gateway, and DHCP status.

Packet layout

Part	Field	Description	Default	Size	Format
Header	`id`		fixed	8 bytes	`"Art-Net\\0"`
Header	`op_code`		`0xF900`	2 bytes	little-endian OpCode
Header	`prot_ver`		`14`	2 bytes	protocol version
Payload	`filler1`	Reserved byte, transmitted as zero.	`0`	1 byte	unsigned integer (8 bits)
Payload	`filler2`	Reserved byte, transmitted as zero.	`0`	1 byte	unsigned integer (8 bits)
Payload	`filler3`	Reserved byte, transmitted as zero.	`0`	1 byte	unsigned integer (8 bits)
Payload	`filler4`	Reserved byte, transmitted as zero.	`0`	1 byte	unsigned integer (8 bits)
Payload	`program_ip`	Current or programmed IPv4 address.	required	4 bytes	binary (4 bytes)
Payload	`program_subnet_mask`	Current or programmed subnet mask.	required	4 bytes	binary (4 bytes)
Payload	`program_port`	Current or programmed UDP port.	required	2 bytes	unsigned integer (16 bits)
Payload	`status`	IP programming status flags.	required	1 byte	`ArtNet.Packet.BitField.IpProgStatus` bit field
Payload	`spare2`	Reserved byte, transmitted as zero.	`0`	1 byte	unsigned integer (8 bits)
Payload	`program_default_gateway`	Current or programmed default gateway.	required	4 bytes	binary (4 bytes)
Payload	`spare`	Reserved bytes, transmitted as zero.	`<<0, 0>>`	2 bytes	binary (2 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.ArtIpProgReply{
  filler1: :integer,
  filler2: :integer,
  filler3: :integer,
  filler4: :integer,
  program_default_gateway: :binary,
  program_ip: :binary,
  program_port: :integer,
  program_subnet_mask: :binary,
  spare: :binary,
  spare2: :integer,
  status: ArtNet.Packet.BitField.IpProgStatus.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 0xF900.

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.