inorbit-connector 3.0.0

A Python library for connectors in the InOrbit RobOps ecosystem.

inorbit-connector

A Python framework for developing connectors for the InOrbit RobOps ecosystem.

Overview

This repository contains a Python framework that provides a base structure for developing InOrbit robot connectors. Making use of InOrbit's Edge SDK, inorbit-connector provides a starting point for the integration of a fleet of robots in InOrbit, unlocking interoperability.

The framework includes:

• Single-robot (Connector) and fleet (FleetConnector) base classes
• Built-in publishing helpers, command handling, and map management
• Optional Prometheus-exported metrics for connector health monitoring

Documentation

For detailed documentation, including installation guides, usage examples, configuration reference, and API details, see the Documentation.

To build the documentation locally:

make -C docs/sphinx html

The documentation will be available in docs/sphinx/_build/html/index.html and can be served locally with make -C docs/sphinx serve.

Requirements

• Python 3.10 or later
• InOrbit account (it's free to sign up!)

Setup

There are two ways of installing the inorbit-connector Python package.

1. From PyPi: pip install inorbit-connector

2. From source: clone the repository and install the dependencies:

git clone https://github.com/inorbit-ai/inorbit-connector-python.git
virtualenv venv
. venv/bin/activate
pip install .

See the CONTRIBUTING.md file for information on how to develop the project.

Quick Start

The examples directory contains usage examples of the connector. See examples/README for more information.

A cookiecutter template is available for quickly generating a new connector project. See inorbit-connector-cookiecutter for more information.

Contributing

Any contribution that you make to this repository will be under the MIT license, as dictated by that license.

Please refer to the CONTRIBUTING.md file for information on how to contribute to this project.