ArtNet.Packet.BitField.GoodInput (ArtNet v0.1.0)

View Source

GoodInput bit field used by ArtNet.Packet.ArtPollReply.

The packet contains one GoodInput value for each of the four reported ports. Each boolean describes the input state of that port.

Bit size

This bit field is encoded in 8 bits.

Bit layout

FieldDescriptionBitsDefaultValue
convert_sacnInput is converting sACN to Art-Net.0requiredboolean flag
receive_errorsReceive errors have been detected.2requiredboolean flag
input_disabledInput is disabled.3requiredboolean flag
dmx_textDMX text packets have been received.4requiredboolean flag
dmx_sipDMX SIP packets have been received.5requiredboolean flag
dmx_test_packetDMX test packets have been received.6requiredboolean flag
data_receivedData has been received.7requiredboolean flag

Summary

Types

t()

Functions

bit_field_schema()

Returns the bit-field schema in declaration order.

bit_size()

Returns the total number of bits encoded by this bit field.

decode(value)

Decodes an unsigned integer into this bit-field struct.

encode(struct)

Encodes this bit-field struct into an unsigned integer.

Types

t()

@type t() :: %ArtNet.Packet.BitField.GoodInput{
  convert_sacn: :boolean,
  data_received: :boolean,
  dmx_sip: :boolean,
  dmx_test_packet: :boolean,
  dmx_text: :boolean,
  input_disabled: :boolean,
  receive_errors: :boolean
}

Functions

bit_field_schema()

@spec bit_field_schema() :: [
  {key :: atom(),
   {ArtNet.Packet.BitField.schema_type(),
    {start_bit :: non_neg_integer(), length :: pos_integer()}}}
]

Returns the bit-field schema in declaration order.

bit_size()

@spec bit_size() :: pos_integer()

Returns the total number of bits encoded by this bit field.

This bit field is encoded in 8 bits.

decode(value)

@spec decode(non_neg_integer()) :: {:ok, t()} | :error

Decodes an unsigned integer into this bit-field struct.

encode(struct)

@spec encode(t()) :: {:ok, non_neg_integer()} | :error

Encodes this bit-field struct into an unsigned integer.