ArtNet.Packet.ArtIpProg (ArtNet v0.1.0)

Reprograms a node's IP addressing configuration.

This packet can request changes to IP address, subnet mask, default gateway, DHCP state, and related programming flags.

Packet layout

Part	Field	Description	Default	Size	Format
Header	`id`		fixed	8 bytes	`"Art-Net\\0"`
Header	`op_code`		`0xF800`	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	`command`	IP programming command flags.	required	1 byte	`ArtNet.Packet.BitField.IpProgCommand` bit field
Payload	`filler4`	Reserved byte, transmitted as zero.	`0`	1 byte	unsigned integer (8 bits)
Payload	`program_ip`	IPv4 address to program into the node.	required	4 bytes	binary (4 bytes)
Payload	`program_subnet_mask`	Subnet mask to program into the node.	required	4 bytes	binary (4 bytes)
Payload	`program_port`	UDP port to program into the node.	required	2 bytes	unsigned integer (16 bits)
Payload	`program_default_gateway`	Default gateway IPv4 address to program.	required	4 bytes	binary (4 bytes)
Payload	`spare`	Reserved bytes, transmitted as zero.	`<<0, 0, 0, 0>>`	4 bytes	binary (4 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.ArtIpProg{
  command: ArtNet.Packet.BitField.IpProgCommand.t(),
  filler1: :integer,
  filler2: :integer,
  filler4: :integer,
  program_default_gateway: :binary,
  program_ip: :binary,
  program_port: :integer,
  program_subnet_mask: :binary,
  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 0xF800.

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.