Metadata-Version: 2.1
Name: mavsniff
Version: 0.0.3
Summary: Mavsniff enables you to capture and replay MAVLink communication over serial line or network
Author-email: Tomas Peterka <prestizni@gmail.com>
Project-URL: Homepage, https://github.com/katomaso/mavsniff
Project-URL: Issues, https://github.com/katomaso/mavsniff/issues
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.8
Description-Content-Type: text/markdown
Provides-Extra: dev
License-File: LICENSE

# mavsniff

Capture and replay MAVLink packets from your drone or GCS.

You can read from a serial line (_ttyS0/COMx_) or from network (_TCP_). Mavsniff stores packets in pcapng format
so you can analyse them with Wireshark.

## Instalation

```$ pip install mavsniff```

Mavsniff is distributed via PYPI and an entrypoint `mavsniff` should be available in your `$PATH` after installation.

## Usage

```bash
$ mavsniff capture --device /dev/ttyS0 --file recording.pcapng
$ mavsniff replay --file recording.pcapng --device socket://localhost:5467 
```

Available device urls:
 * `-d /dev/ttyS0` - standard serial port on UNIX systems
 * `-d COMx` - e.g. COM1 or COM4 - standard serial ports on Windows systems
 * `-d socket://<host>:<port>` - receive packets via TCP (only for `capture` command)
 * currently, there is no option how to **send** MAVLink packets over the network.
 
_Consult more device urls on [pyserial documenation page](https://pyserial.readthedocs.io/en/latest/url_handlers.html)._


## Caviats

When using a `loop://` device please note that there is a finite buffer size (usually 4096 bytes). Do not
send larger files there withou reading from the buffer in parallel.
