1. Getting Started - ryan-brazeal-ufl/OpenPyLivox GitHub Wiki

1.1 Read this Wiki, yes...all the pages!

1.2 Installing OpenPyLivox

OpenPyLivox is not published as a PyPI package. However, it can still be installed using pip install but the command requires a slightly different form, in order to use this GitHub repository.

pip install git+https://github.com/ryan-brazeal-ufl/openpylivox.git

1.3 Importing the OpenPyLivox library into your Python3 project code

import openpylivox as opl

1.4 Instantiate an OpenPyLivox sensor object

sensor = opl.openpylivox([showMessages])

The optional boolean [showMessages] argument, states if object information messages will be printed to the screen (default = False). It is recommended when starting out with OpenPyLivox, that a user sets this argument to True.
e.g., sensor = opl.openpylivox(True)

IMPORTANT NOTE: for the remainder of this documentation, the Python object name for the OpenPyLivox sensor object will be sensor. Therefore, if a user instantiates their OpenPyLivox sensor object and uses a different Python object name, that name will need to be used in replace of sensor

1.5 Upgrading OpenPyLivox to the latest version

Use the following command to upgrade your current installation of OpenPyLivox to the latest version.

pip install --upgrade git+https://github.com/ryan-brazeal-ufl/openpylivox.git

Previous Page | Next Page