A Python framework for developing connectors for the InOrbit RobOps ecosystem.Documentation Index
Fetch the complete documentation index at: https://inorbitinc.mintlify.app/llms.txt
Use this file to discover all available pages before exploring further.
Overview
This framework 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 supports both single-robot and fleet connectors:
- Single-robot connectors: Subclass
Connectorto manage one robot at a time - Fleet connectors: Subclass
FleetConnectorto manage multiple robots simultaneously, ideal for managing robots through a fleet manager
- Automatic InOrbit robot provisioning
- Built-in publishing methods for pose, odometry, key-values, and system stats
- Command handling infrastructure for receiving commands from InOrbit
- Map management with automatic updates
- Camera feed registration
- User scripts support for custom command execution
- Configurable logging
Requirements
- Python 3.10 or later
- InOrbit account (it’s free to sign up!)
Documentation Sections
- Getting Started: Installation, environment setup, and running a connector (Getting Started)
- Specification: Package-level specification of the connector API (Specification)
- Usage: Detailed guides for implementing single-robot and fleet connectors (Usage)
- Configuration: Connector configuration models and file formats (Configuration)
- Publishing: How to publish data to InOrbit (Publishing)