Skip to content

Latest commit

 

History

History
237 lines (162 loc) · 8.23 KB

README.md

File metadata and controls

237 lines (162 loc) · 8.23 KB
Raw

mavp2p

Test Lint CodeCov Release Docker Hub

mavp2p is a flexible and efficient Mavlink proxy / bridge / router, implemented in the form of a command-line utility. It is used primarily to link UAV flight controllers, connected through a serial port, with ground stations on a network, but can be used to build any kind of routing involving serial, TCP and UDP, allowing communication across different physical layers or transport layers.

This project makes use of the gomavlib library, a full-featured Mavlink library.

Features:

  • Link together an arbitrary number of different kinds of endpoints:
    • serial
    • UDP (client, server or broadcast mode)
    • TCP (client or server mode)
  • Support Mavlink 2.0 and 1.0, support any dialect
  • Emit heartbeats
  • Automatically request streams to Ardupilot devices and block stream requests from ground stations
  • Route messages by target system ID / component ID
  • Support domain names in place of IPs
  • Reconnect to TCP/UDP servers when disconnected, remove inactive TCP/UDP clients
  • Multiplatform, available for multiple operating systems (Linux, Windows) and architectures (arm6, arm7, arm64, amd64), does not depend on libc and therefore is compatible with lightweight distros (Alpine Linux)

Table of contents

Installation

There are several installation methods available: standalone binary, Docker image and OpenWRT binary.

Standalone binary

Download and extract a standalone binary from the release page that corresponds to your operating system and architecture.

Docker image

There's a image available at bluenviron/mavp2p:

docker run --rm -it --network=host bluenviron/mavp2p

OpenWrt binary

If the architecture of the OpenWrt device is amd64, armv6, armv7 or arm64, use the standalone binary method and download a Linux binary that corresponds to your architecture.

Otherwise, compile the software from source.

Usage

Link a serial port with a UDP endpoint in client mode:

./mavp2p serial:/dev/ttyAMA0:57600 udpc:1.2.3.4:5600

Link a serial port with a UDP endpoint in server mode:

./mavp2p serial:/dev/ttyAMA0:57600 udps:0.0.0.0:5600

Link a UDP endpoint in broadcast mode with a TCP endpoint in client mode:

./mavp2p udpb:192.168.7.255:5601 tcpc:exampleendpoint.com:5600

Create a server that links together all UDP endpoints that connect to it:

./mavp2p udps:0.0.0.0:5600

Comparison with similar software

mavp2p vs mavproxy

  • Does not require python nor any interpreter
  • Much lower CPU and memory usage
  • Supports an arbitrary number of inputs and outputs
  • Logs can be disabled, resulting in no disk I/O
  • UDP clients are removed when inactive

mavp2p vs mavlink-router

  • Supports domain names
  • Supports multiple TCP servers
  • UDP clients are removed when inactive
  • Supports automatic stream requests to Ardupilot devices

Full command-line usage

Usage: mavp2p [<endpoints> ...]

mavp2p v0.0.0

Arguments:
  [<endpoints> ...]    Space-separated list of endpoints. At least one endpoint is required. Possible endpoints types are:

                       udpc:dest_ip:port (udp, client mode)

                       udpb:broadcast_ip:port (udp, broadcast mode)

                       tcps:listen_ip:port (tcp, server mode)

                       tcpc:dest_ip:port (tcp, client mode)

                       serial:port:baudrate (serial)

                       udps:listen_ip:port (udp, server mode)

Flags:
  -h, --help                     Show context-sensitive help.
      --version                  print version.
  -q, --quiet                    suppress info messages.
      --print                    print routed frames.
      --print-errors             print parse errors singularly, instead of printing only their quantity every 5 seconds.
      --read-timeout=10s         timeout of read operations.
      --write-timeout=10s        timeout of write operations.
      --idle-timeout=60s         disconnect idle connections after a timeout.
      --hb-disable               disable heartbeats.
      --hb-version=1             set mavlink version of heartbeats.
      --hb-systemid=125          set system ID of heartbeats. it is recommended to set a different system id for each router in the network.
      --hb-componentid=191       set component ID of heartbeats.
      --hb-period=5              set period of heartbeats.
      --streamreq-disable        do not request streams to Ardupilot devices, that need an explicit request
                                 in order to emit telemetry streams. this task is usually delegated to the router,
                                 in order to avoid conflicts when multiple ground stations are active.
      --streamreq-frequency=4    set the stream frequency to request.

Compile from source

Standard

Install git and Go ≥ 1.21. Clone the repository, enter into the folder and start the building process:

git clone https://github.com/bluenviron/mavp2p
cd mavp2p
CGO_ENABLED=0 go build .

The command will produce the mavp2p binary.

OpenWrt

The compilation procedure is the same as the standard one. On the OpenWrt device, install git and Go:

opkg update
opkg install golang git git-http

Clone the repository, enter into the folder and start the building process:

git clone https://github.com/bluenviron/mavp2p
cd mavp2p
CGO_ENABLED=0 go build .

The command will produce the mavp2p binary.

If the OpenWrt device doesn't have enough resources to compile, you can cross compile from another machine.

Cross compile

Cross compilation allows to build an executable for a target machine from another machine with different operating system or architecture. This is useful in case the target machine doesn't have enough resources for compilation or if you don't want to install the compilation dependencies on it.

On the machine you want to use to compile, install git and Go ≥ 1.21. Clone the repository, enter into the folder and start the building process:

git clone https://github.com/bluenviron/mavp2p
cd mavp2p
CGO_ENABLED=0 GOOS=my_os GOARCH=my_arch go build .

Replace my_os and my_arch with the operating system and architecture of your target machine. A list of all supported combinations can be obtained with:

go tool dist list

For instance:

CGO_ENABLED=0 GOOS=linux GOARCH=arm64 go build .

In case of the arm architecture, there's an additional flag available, GOARM, that allows to set the ARM version:

CGO_ENABLED=0 GOOS=linux GOARCH=arm64 GOARM=7 go build .

In case of the mips architecture, there's an additional flag available, GOMIPS, that allows to set additional parameters:

CGO_ENABLED=0 GOOS=linux GOARCH=mips GOMIPS=softfloat go build .

The command will produce the mavp2p binary.

Specifications

Links

Related projects

Similar software