Getting Started

Installation

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

From PyPI

Install the package from PyPI:

pip install inorbit-connector

From Source

Clone the repository and install the dependencies:

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

Refer to the Github repository at github.com/inorbit-ai/inorbit-connector-python details.

Requirements

  • Python 3.10 or later

  • InOrbit account: Sign up for free

  • InOrbit API key: Export as INORBIT_API_KEY environment variable

export INORBIT_API_KEY="<your_api_key>"

Run the Examples

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

Simple Connector Example

The simplest example demonstrates basic connector functionality:

cd examples
source example.env
python simple-connector/connector.py

To stop the connector, press Ctrl+C in the terminal.

Robot Connector Example

A more comprehensive example with command-line interface:

cd examples
source example.env
python robot-connector/main.py --config example.yaml --robot_id my-example-robot

Fleet Connector Example

For managing multiple robots:

cd examples
source example.env
python fleet-connector/main.py --config example.fleet.yaml