godvenn / isar-exr

isar-exr

Integration and Supervisory control of Autonomous ground Robots - exr

exr is an abbrivation of ExRobotics, which has made the robot ExRobotics2(exr2) which this package is intended for.

Technically speaking, this package integrates toward EnergyRobotics' API, which again communicates with the exr2 robot.

Authentication

You need to have a user in the EXR portal, and create an api key.
These are the variables used for authentication.

Installation

Clone and install in the repository root folder.

git clone https://github.com/equinor/isar_exr
cd isar_exr
pip install -e ".[dev]"

Set the following environment variables (alternatively in a .env file like .env.example):

export EXR_ROBOT_API_USERNAME = "email-here"
export EXR_ROBOT_API_PASSWORD = "api-key-here"

For development, it is recommended to install the lastest version of ISAR from GitHub locally. To install ISAR in the same environment from a local folder:

pip install -e path/to/local/isar/folder

Note that this installation might require wheel.

Finally, verify that you can run the tests:

pytest .