View Source XMAVLink.Types (xmavlink v0.3.0)

Core types that remain the same across dialects.

Link to this section Summary

Types

Connection delegate modules for XMAVLink.Router

A CRC_EXTRA checksum

64-bit signed float

1 -> not an array 2..255 -> an array

Type used for field in encoded message

8-bit signed integer

16-bit signed integer

32-bit signed integer

64-bit signed integer

A system/component id tuple

A MAVLink message id

A 4-tuple network address

A non-reserved network port

A parameter description

A list of parameter descriptions

MAVLink message sequence number

8-bit unsigned integer

16-bit unsigned integer

32-bit unsigned integer

64-bit unsigned integer

MAVLink protocol version

Link to this section Types

@type connection() ::
  XMAVLink.SerialConnection
  | XMAVLink.TCPConnection
  | XMAVLink.UDPInConnection
  | XMAVLink.UDPOutConnection

Connection delegate modules for XMAVLink.Router

@type crc_extra() :: 0..255

A CRC_EXTRA checksum

@type double() :: Float64

64-bit signed float

@type field_ordinality() :: 1..255

1 -> not an array 2..255 -> an array

@type field_type() ::
  int8_t()
  | int16_t()
  | int32_t()
  | int64_t()
  | uint8_t()
  | uint16_t()
  | uint32_t()
  | uint64_t()
  | char()
  | float()
  | double()

Type used for field in encoded message

@type int8_t() :: -128..127

8-bit signed integer

@type int16_t() :: -32768..32767

16-bit signed integer

@type int32_t() :: -2_147_483_647..2_147_483_647

32-bit signed integer

@type int64_t() :: integer()

64-bit signed integer

@type message_id() :: non_neg_integer()

A MAVLink message id

@type net_address() :: {0..255, 0..255, 0..255, 0..255}

A 4-tuple network address

@type net_port() :: 1024..65535

A non-reserved network port

@type param_description() :: {pos_integer(), String.t()}

A parameter description

Link to this type

param_description_list()

View Source
@type param_description_list() :: [param_description()]

A list of parameter descriptions

@type sequence_number() :: 0..255

MAVLink message sequence number

@type uint8_t() :: 0..255

8-bit unsigned integer

@type uint16_t() :: 0..65535

16-bit unsigned integer

@type uint32_t() :: 0..4_294_967_295

32-bit unsigned integer

@type uint64_t() :: pos_integer()

64-bit unsigned integer

@type version() :: 1 | 2

MAVLink protocol version