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

View Source

TOD request command values used by ArtNet.Packet.ArtTodRequest.

Values

AtomDescriptionValue
tod_fullRequest the full Table of Devices.0x0 / 0b00000000

Summary

Functions

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

Converts an integer code into its enum atom.

Converts an enum atom into its integer code.

Returns the integer code for :tod_full.

Types

type()

@type type() :: :tod_full

Functions

bit_size()

@spec bit_size() :: pos_integer()

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

to_atom(code)

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

to_code(value)

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

tod_full()

@spec tod_full() :: non_neg_integer()

Returns the integer code for :tod_full.

The code is 0x0.