Skip to main content

Interface with ublox chipsets using Python.

Project description

Python package to communicate with ublox receivers

Python package to communicate with ublox chipsets

To install the package:

pip3 install pyublox

Basic usage

This section includes some basic sections on how to use the package

# Help
pyublox -h

# Autodetect ublox receiver connected via a serial port, including some
# basic receiver configuration (rates, tracked signals, ...)
pyublox detect

Testing the package

This package uses the pytest suite, to execute the tests, issue the following command

pytest -v -r s /path/to/source

The -r s option is used to show the reason of skipped tests or modules

Development within a Docker container

The best way to develop the package is by using a controlled environement. To do this, run a Python 3.7 container like so

docker run -v `pwd`:/pyublox -ti rokubun/gcc:debian-python3.7 bash

If deveoping within the Raspberry Pi

docker run -v `pwd`:/pyublox --device=/dev/ttyACM0  -ti python:3.7  bash

# Develop using jupyter (mounting a folder to store the Notebooks)
cd amic/pyublox/
docker run -v `pwd`:/pyublox -v "${PWD}/notebooks":/notebooks -p 8888:8888 --device=/dev/ttyACM0  -ti andresvidal/jupyter-armv7l

Once within the container type the following commands:

# The package requires git to work properly
pip install -e /pyublox

More information on the image available in jupyter-armv7l repository

We can also use docker compose

# Build the image
cd amic/pyublox/
docker-compose build

# Or directly run the container for development, this is equivalent to the
# docker run call shown above, but we do not need to launch pip install
docker-compose up

Submission to PyPi

In order to deploy to PyPi

# Update setuptools
python3 -m pip install --user --upgrade setuptools wheel

# Create the distribution wheel
python3 sdist bdist_wheel

# Upload the distribution wheels to the PyPi repo
python3 -m twine upload dist/*

More details on deployment can be found here.

Project details

Download files

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

Files for pyublox, version 3.1.4
Filename, size File type Python version Upload date Hashes
Filename, size pyublox-3.1.4-py3-none-any.whl (23.7 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size pyublox-3.1.4.tar.gz (16.6 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page