isar-exr

Integration and Supervisory control of Autonomous ground Robots - exr

The abbreviation "exr" stands for ExRobotics, the maker of the ExR-2 robot, which this package is intended for.

Technically speaking, this package integrates to the API of Energy Robotics, the provider of a cloud-based platform to control fleets of robots from multiple vendors including ExRobotics.

Authentication

You need to have a user account on the Energy Robotics login portal which lets you create an API key. For authentication the email address of this user account is used as user name and the API key as password.

Contributing

We welcome all kinds of contributions, including code, bug reports, issues, feature requests, and documentation. The preferred way of submitting a contribution is to either make an issue on GitHub or by forking the project on GitHub and making a pull requests.

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"
export EXR_API_URL = "ADD URL 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 .

Building docker image on a Mac

When building docker image on Mac, one might have to include the following lines in the Dockerfile (between 'COPY . .' and 'RUN pip install .'):

COPY . .
RUN apt-get update
RUN apt-get install -y gcc python3-dev

RUN python -m pip install --upgrade pip
RUN pip install .