Packages

xmavlink

0.15.0
0.15.0 0.14.3 0.14.2 0.14.1 0.14.0 0.13.1 0.13.0 0.12.2 0.12.1 0.12.0 0.11.1 0.10.1 0.10.0 0.9.1 0.9.0 0.8.0 0.7.0 0.6.3 0.6.2 0.6.1 0.6.0 0.5.0 0.4.3 0.4.1 0.4.0 0.3.0 0.2.0 0.1.0

An elixir library for MAVLink, an application that enables communication with other systems using the MAVLink protocol over serial, UDP and TCP connections, and utility modules for performing common MAVLink commands and tasks with one or more remote vehicles.

HexDocs

Current section

Files

Jump to
Readme
28 Versions
2 Dependencies
Dependants
Files
Activity
xmavlink lib mavlink types.ex
Raw

lib/mavlink/types.ex 

defmodule XMAVLink.Types do

  @moduledoc """

  Core types that remain the same across dialects.

  """



  @typedoc "Internal connection state structs owned by `XMAVLink.Router`"

  @type connection :: struct()



  @typedoc "A system/component id tuple"

  @type mavlink_address :: {0..255, 0..255}



  @typedoc "MAVLink protocol version"

  @type version :: 1 | 2



  @typedoc "MAVLink message sequence number"

  @type sequence_number :: 0..255



  @typedoc "An IPv4 or IPv6 network address tuple"

  @type net_address :: :inet.ip_address()



  @typedoc "A non-reserved network port"

  @type net_port :: 1024..65535



  @typedoc "A parameter description"

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



  @typedoc "A list of parameter descriptions"

  @type param_description_list :: [param_description]



  @typedoc "Type used for field in encoded message"

  @type field_type ::

          int8_t

          | int16_t

          | int32_t

          | int64_t

          | uint8_t

          | uint16_t

          | uint32_t

          | uint64_t

          | char

          | float

          | double



  @typedoc "8-bit signed integer"

  @type int8_t :: -128..127



  @typedoc "16-bit signed integer"

  @type int16_t :: -32_768..32_767



  @typedoc "32-bit signed integer"

  @type int32_t :: -2_147_483_648..2_147_483_647



  @typedoc "64-bit signed integer"

  @type int64_t :: integer



  @typedoc "8-bit unsigned integer"

  @type uint8_t :: 0..255



  @typedoc "16-bit unsigned integer"

  @type uint16_t :: 0..65_535



  @typedoc "32-bit unsigned integer"

  @type uint32_t :: 0..4_294_967_295



  @typedoc "64-bit unsigned integer"

  @type uint64_t :: 0..18_446_744_073_709_551_615



  @typedoc "64-bit MAVLink double represented as an Elixir float"

  @type double :: float()



  @typedoc "1 -> not an array 2..255 -> an array"

  @type field_ordinality :: 1..255



  @typedoc "A MAVLink message id"

  @type message_id :: non_neg_integer



  @typedoc "A CRC_EXTRA checksum"

  @type crc_extra :: 0..255

end