isar-robot

ISAR - Integration and Supervisory control of Autonomous Robots - is a tool for integrating robot applications into Equinor systems. Through the ISAR API you can send command to a robot to do missions and collect results from the missions.

Running the full ISAR system requires an installation of a robot which satisfies the required interface. isar-robot is a default implementation of such a robot.

Installation

For installation of isar-robot to use with ISAR, please follow the robot integration installation guide.

Run isar-robot

After installing isar-robot, it can be used through ISAR.

Development

Create a fork of the repository and clone the fork to your machine:

git clone https://github.com/<your-username>/isar-robot
cd isar-robot

Choose if you want to run via uv or manually creating venv

Local development with uv

An easy way to run isar-robot locally is with uv. The pyproject.toml includes a [tool.uv.sources] override that points the isar dependency to the local ../isar folder.

Note that this assumes the following folder structure between isar and isar-robot:

parent-folder/
├── isar/
└── isar-robot/

uv run isar-start

Configurable variables

Specific mission and task behaviours can be configured as environment variables. These are optional and do not have to be set. These allow for always failing specific mission types, failing specific task types, setting custom task durations, and setting custom mission durations. The following list shows all configurable environment variables. In this case "normal" means non-localization or return to home tasks.

The variable names and types are as follows:

TASK_DURATION_IN_SECONDS: float
MISSION_DURATION_IN_SECONDS: float
SHOULD_FAIL_NORMAL_TASK: bool
SHOULD_FAIL_RETURN_TO_HOME_TASK: bool

Every configuration variable is defined in settings.py, and they may all be overwritten by specifying the variables in your ".env" file in ISAR. Note that the configuration variable must be prefixed with ROBOT_ when specified in the ISAR environment file.

Dependencies

The dependencies used for this package are listed in pyproject.toml and pinned in uv.lock. This ensures our builds are predictable and deterministic. This project uses uv for dependency management:

Install local versions (editable):

uv sync

Install pinned versions:

uv sync --no-sources

Pin local version:

uv lock --no-sources

To update the dependencies to the latest versions, run:

uv lock --upgrade --no-sources

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 request.

Project links

Key dates

PyPI data
Data sourced directly from PyPI's database.
  • Released:
Newer release available (2.4.0)

3 maintainers

PyPI data
Data sourced directly from PyPI's database.
Avatar for Chjo from gravatar.com Chjo Avatar for steneae from gravatar.com steneae Avatar for tsundvoll from gravatar.com tsundvoll

Credits

Author: Equinor ASA

License

Eclipse Public License 2.0 (EPL-2.0) (Eclipse Public License - v 2.0)

Requires

Python >=3.14

Provides Extra

dev

Classifiers

Report project as malware

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

isar_robot-2.3.1.tar.gz (22.2 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

isar_robot-2.3.1-py3-none-any.whl (22.1 MB view details)

Uploaded Python 3

File details

Details for the file isar_robot-2.3.1.tar.gz.

File metadata

  • Download URL: isar_robot-2.3.1.tar.gz
  • Upload date:
  • Size: 22.2 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/7.0.0 CPython/3.14.7

File hashes

Hashes for isar_robot-2.3.1.tar.gz
Algorithm Hash digest
SHA256 98600dbacb025c9c12ee550c49cb2631ce03836791f1159a03e423c23d8a3d2a
MD5 1a4087f6a977a3bd6ee7044aae0fd007
BLAKE2b-256 e8633f24dad2cc5095efba58488b64bd1294ce252bdb1fb41295e8ea346681c3

See more details on using hashes here.

File details

Details for the file isar_robot-2.3.1-py3-none-any.whl.

File metadata

  • Download URL: isar_robot-2.3.1-py3-none-any.whl
  • Upload date:
  • Size: 22.1 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/7.0.0 CPython/3.14.7

File hashes

Hashes for isar_robot-2.3.1-py3-none-any.whl
Algorithm Hash digest
SHA256 6f91cf990b5a2077659fc5b4cafbc89df310d50c502fda6dd73a639de0fb5037
MD5 28a8306b610038ad34874945b3ee4f10
BLAKE2b-256 ab039e2f0e0c23a31c8c9d7c26698ff1f9a3c4d059c29edfeeeca2cc21a1bac1

See more details on using hashes here.

Release history Release notifications | RSS feed

2.4.0

2 files

2.3.2

2 files

This release

2.3.1 This release

2 files

2.3.0

2 files

2.2.1

2 files

2.2.0

2 files

2.1.3

2 files

2.0.3

2 files

2.0.2

2 files

2.0.1

2 files

2.0.0

2 files

1.5.24

2 files

1.5.23

2 files

1.5.22

2 files

1.5.21

2 files

1.5.20

2 files

1.5.19

2 files

1.5.18

2 files

1.5.17

2 files

1.5.16

2 files

1.5.15

2 files

1.5.14

2 files

1.5.13

2 files

1.5.12

2 files

1.5.11

2 files

1.5.10

2 files

1.5.9

2 files

1.5.8

2 files

1.5.7

2 files

1.5.6

2 files

1.5.5

2 files

1.5.4

2 files

1.5.3

2 files

1.5.2

2 files

1.5.1

2 files

1.5.0

2 files

1.4.8

2 files

1.4.7

2 files

1.4.6

2 files

1.4.5

2 files

1.4.4

2 files

1.4.3

2 files

1.4.2

2 files

1.4.1

2 files

1.4.0

2 files

1.3.16

2 files

1.3.15

2 files

1.3.13

2 files

1.1.0

2 files

1.0.7

2 files

1.0.6

2 files

1.0.5

2 files

1.0.2

2 files

1.0.1

2 files

1.0.0

2 files

0.0.0

2 files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page