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

View Source

Port protocol type values used by ArtNet.Packet.BitField.PortType.

Values

AtomDescriptionValue
dmx512DMX512.0x0 / 0b000000
midiMIDI.0x1 / 0b000001
avabAvab.0x2 / 0b000010
colortranColortran CMX.0x3 / 0b000011
adbADB 62.5.0x4 / 0b000100
art_netArt-Net.0x5 / 0b000101
daliDALI.0x6 / 0b000110

Summary

Functions

Returns the integer code for :adb.

Returns the integer code for :art_net.

Returns the integer code for :avab.

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

Returns the integer code for :colortran.

Returns the integer code for :dali.

Returns the integer code for :dmx512.

Returns the integer code for :midi.

Converts an integer code into its enum atom.

Converts an enum atom into its integer code.

Types

type()

@type type() :: :dmx512 | :midi | :avab | :colortran | :adb | :art_net | :dali

Functions

adb()

@spec adb() :: non_neg_integer()

Returns the integer code for :adb.

The code is 0x4.

art_net()

@spec art_net() :: non_neg_integer()

Returns the integer code for :art_net.

The code is 0x5.

avab()

@spec avab() :: non_neg_integer()

Returns the integer code for :avab.

The code is 0x2.

bit_size()

@spec bit_size() :: pos_integer()

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

colortran()

@spec colortran() :: non_neg_integer()

Returns the integer code for :colortran.

The code is 0x3.

dali()

@spec dali() :: non_neg_integer()

Returns the integer code for :dali.

The code is 0x6.

dmx512()

@spec dmx512() :: non_neg_integer()

Returns the integer code for :dmx512.

The code is 0x0.

midi()

@spec midi() :: non_neg_integer()

Returns the integer code for :midi.

The code is 0x1.

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.