This project contains modules and functions written in Python to receive scan segments from SICK Lidar sensors. Furthermore utilities are included to process and decode scan segments in the MSGPACK format.

This project relies on Poetry for dependency management and execution of the virtual python environment. Detailed installation instructions for each platform can be found here.

cd <THIS_REPOSITORY>
poetry build
poetry run pytest
cd <OTHER_REPOSITORY>
poetry run pip install <THIS_REPOSITORY>/.

where <OTHER_REPOSITORY> is the directory where the package depending on the scansegmentdecoding module is located and <THIS_REPOSITORY> is the location where the scansegmentdecoding repository has been checked out.

After the package has been built with poetry it can be installed in the global environment.

cd <THIS_REPOSITORY>
pip install .

where <THIS_REPOSITORY> is the location where the scansegmentdecoding repository has been checked out.

After the package has been installed as described above, it can be included in your python project as follows, depending on which functionality is required:

from scansegmentdecoding import msgpackUtil
from scansegmentdecoding import connectionHandler
from scansegmentdecoding import decodeUtil

This module relies on the following dependencies which are downloaded during the build process