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 setup.py 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.

Source Distribution

pyublox-3.0.0.tar.gz (16.5 kB view details)

Uploaded Source

Built Distribution

pyublox-3.0.0-py3-none-any.whl (23.6 kB view details)

Uploaded Python 3

File details

Details for the file pyublox-3.0.0.tar.gz.

File metadata

  • Download URL: pyublox-3.0.0.tar.gz
  • Upload date:
  • Size: 16.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.7.0 requests/2.25.1 setuptools/53.0.0 requests-toolbelt/0.9.1 tqdm/4.57.0 CPython/3.7.10

File hashes

Hashes for pyublox-3.0.0.tar.gz
Algorithm Hash digest
SHA256 14b8a20350a5899e2a1712c26bdd6e6df79ea4a989533a7e631d68d6f2e79cd5
MD5 5906900e3fc5b3ff5212a4e212745794
BLAKE2b-256 155de4d48732bac0e8feab775f90541a3b9ec49e7d3f3c41e69c47792cdf99ba

See more details on using hashes here.

File details

Details for the file pyublox-3.0.0-py3-none-any.whl.

File metadata

  • Download URL: pyublox-3.0.0-py3-none-any.whl
  • Upload date:
  • Size: 23.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.7.0 requests/2.25.1 setuptools/53.0.0 requests-toolbelt/0.9.1 tqdm/4.57.0 CPython/3.7.10

File hashes

Hashes for pyublox-3.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 b5e26a6cb9a733bd724223df4ce43e072c2e2816d0d25cb32a23eee91c11c24d
MD5 bf0b353bb1694662f9be4d3e13df9d7b
BLAKE2b-256 a9e20e110e7aeac8c2412ed329fb3db3d0c443189c4a3ddc83f9286c58700b1d

See more details on using hashes here.

Supported by

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