ArtNet.Packet.EnumTable.PortAddress (ArtNet v0.1.0)

Port-Address authority values used by ArtNet.Packet.BitField.Status1.

Values

Atom	Description	Value
`unknown`	Authority is unknown.	`0x0 / 0b00`
`front`	Address is set by front-panel controls.	`0x1 / 0b01`
`net`	Address is set by network programming.	`0x2 / 0b10`
`unused`	Reserved value.	`0x3 / 0b11`

type()

bit_size()

Returns the number of bits used to encode values in this enum table.

front()

Returns the integer code for :front.

net()

Returns the integer code for :net.

to_atom(code)

Converts an integer code into its enum atom.

to_code(value)

Converts an enum atom into its integer code.

unknown()

Returns the integer code for :unknown.

unused()

Returns the integer code for :unused.

@type type() :: :unknown | :front | :net | :unused

@spec bit_size() :: pos_integer()

Returns the number of bits used to encode values in this enum table.

@spec front() :: non_neg_integer()

Returns the integer code for :front.

The code is 0x1.

@spec net() :: non_neg_integer()

Returns the integer code for :net.

The code is 0x2.

@spec to_atom(term()) :: {:ok, type()} | :error

Converts an integer code into its enum atom.

Returns {:ok, atom} when the code is defined by this enum table, or :error otherwise.

@spec to_code(term()) :: {:ok, non_neg_integer()} | :error

Converts an enum atom into its integer code.

Returns {:ok, code} when the atom is defined by this enum table, or :error otherwise.

@spec unknown() :: non_neg_integer()

Returns the integer code for :unknown.

The code is 0x0.

@spec unused() :: non_neg_integer()

Returns the integer code for :unused.

The code is 0x3.