Getting Started¶

Quick Start¶

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

To generate a new connector project:

Create a new repository and cd into it.
Run pipx run cookiecutter gh:inorbit-ai/inorbit-connector-cookiecutter. This will install the cookiecutter package if you don’t have it already and download the InOrbit connector cookiecutter.
Follow the prompts to create a new connector.
Once all questions are answered, the cookiecutter will generate a bunch of files and directories for you to start working on your connector.
Read the notice at the top of the generated README.md file and follow the instructions to complete the setup.

Continue reading for a complete usage guide and examples.

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

Install the package from PyPI:

pip install inorbit-connector

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 .

export INORBIT_API_KEY="<your_api_key>"

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

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.

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

For managing multiple robots:

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