Skip to main content

Python bindings for Swift Binary Protocol

Project description

Python client for Swift Binary Protocol (SBP).

Since v2.5 libsbp is compatible with Python 2.7, 3.5 to 3.9. For new projects, Python 3.7 or newer is recommended.

Setup

You must have python and pip installed.

Install dependencies only:

$ pip install -r requirements.txt

Install from source:

$ pip install ./python

Install package from PyPI (use sudo ... to install globally):

$ pip install sbp

Setup using a virtual environment

Setup and activate the virtualenv:

$ virtualenv .env && source .env/bin/activate

Install py.test in the virtualenv:

$ pip install pytest-virtualenv

Install the pt.test coverage tools:

$ pip install pytest-cov

Finally, proceed to the standard setup instructions.

Usage Examples

Simple example

Receives SBP messages over a serial port, decodes MSG_BASELINE messages and prints them out. See simple.py .

Run this example with:

$ python -m sbp.client.examples.simple -p /path/to/serial/port

Sending SBP messages over UDP

Receives SBP messages over a serial port and sends all incoming messages to a UDP socket. See udp.py .

Run this example with:

$ python -m sbp.client.examples.udp -s /path/to/serial/port

Testing

To run the tests and check for coverage:

$  py.test -v --cov sbp tests/

To run the tests without suppressing stdout output:

$ py.test -v -s –cov sbp tests/

License

Copyright © 2015-2021 Swift Navigation

Distributed under MIT.

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

sbp-5.0.8.tar.gz (119.3 kB view hashes)

Uploaded Source

Built Distribution

sbp-5.0.8-py2.py3-none-any.whl (161.6 kB view hashes)

Uploaded Python 2 Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page