Packages

xmavlink

0.14.2
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 dialect.ex
Raw

lib/mavlink/dialect.ex 

defmodule XMAVLink.Dialect do

  @moduledoc """

  Behaviour implemented by generated MAVLink dialect modules.



  The generator already emits these functions for each dialect. This behaviour

  makes the runtime contract explicit without changing generated module names

  or message structs.

  """



  @type target :: :broadcast | :system | :system_component | :component



  @callback mavlink_version() :: non_neg_integer

  @callback mavlink_dialect() :: non_neg_integer

  @callback describe(atom) :: String.t()

  @callback describe_params(atom) :: XMAVLink.Types.param_description_list()

  @callback encode(atom | integer, atom) :: integer

  @callback decode(integer, atom) :: atom | integer

  @callback msg_attributes(XMAVLink.Types.message_id()) ::

              {:ok, XMAVLink.Types.crc_extra(), pos_integer, target}

              | {:error, :unknown_message_id}

  @callback unpack(XMAVLink.Types.message_id(), XMAVLink.Types.version(), binary) ::

              {:ok, XMAVLink.Message.t()} | {:error, :unknown_message}

end