Skip to main content

Python bindings for Swift Binary Protocol

Project description

SBP Bindings for Python
=======================

Python client for Swift Binary Protocol (SBP).

Setup
-----

You must have `python` and `pip` installed.

Install dependencies only::

$ sudo pip install -r requirements.txt

Install from repo::

$ sudo python setup.py install

Install package from pypi::

$ sudo 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 Swift Navigation

Distributed under LGPLv3.0.

.. _simple.py: https://github.com/swift-nav/libsbp/blob/master/python/sbp/client/examples/simple.py
.. _udp.py: https://github.com/swift-nav/libsbp/blob/master/python/sbp/client/examples/udp.py


Release history Release notifications | RSS feed

This version

2.5.0

Download files

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

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

sbp-2.5.0-py2.py3-none-any.whl (113.0 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