Skip to main content

InOrbit Edge SDK for Python

Project description

InOrbit Python Edge SDK

OS Python 3.8 Python 3.9 Python 3.10 Python 3.11 Python 3.12
Linux TeamCity TeamCity TeamCity TeamCity TeamCity
Mac TeamCity TeamCity TeamCity TeamCity TeamCity
Windows TeamCity TeamCity TeamCity TeamCity TeamCity
Qodana -- -- TeamCity --

The InOrbit Edge SDK allows Python programs to communicate with InOrbit platform on behalf of robots - providing robot data and handling robot actions. Its goal is to ease the integration between InOrbit and any other software that handles robot data.


  • Robot session handling through a RobotSessionPool.
  • Publish key-values.
  • Publish robot poses.
  • Publish robot odometry.
  • Publish robot path.
  • Publish robot laser.
  • Execute callbacks on Custom Action execution.
  • Execute scripts (or any program) in response to Custom Action execution.

Quick Start

from inorbit_edge.robot import RobotSessionFactory, RobotSessionPool

def my_command_handler(robot_id, command_name, args, options):
    """Callback for processing custom command calls.

        robot_id (str): InOrbit robot ID
        command_name (str): InOrbit command e.g. 'customCommand'
        args (list): Command arguments
        options (dict): object that includes
            - `result_function` can be called to report command execution
            result with the following signature: `result_function(return_code)`
            - `progress_function` can be used to report command output with
            the following signature: `progress_function(output, error)`
            - `metadata` is reserved for the future and will contain additional
            information about the received command request.
    if command_name == "customCommand":
        print(f"Received '{command_name}' for robot '{robot_id}'!. {args}")
        # Return '0' for success

robot_session_factory = RobotSessionFactory(

# Register commands handlers. Note that all handlers are invoked.
robot_session_factory.register_commands_path("./user_scripts", r".*\.sh")

robot_session_pool = RobotSessionPool(robot_session_factory)

robot_session = robot_session_pool.get_session(
    robot_id="my_robot_id_123", robot_name="Python SDK Quick Start Robot"

robot_session.publish_pose(x=0.0, y=0.0, yaw=0.0)


Stable Release: pip install inorbit-edge
**Development Head: ** pip install git+


For full package documentation please visit InOrbit Developer Portal.


See for information related to developing the code.

The Three Commands You Need To Know

  1. pip install -e .[dev]

    This will install your package in editable mode with all the required development dependencies (i.e. tox).

  2. make build

    This will run tox which will run all your tests in Python 3.8 - 3.11 as well as linting your code.

  3. make clean

    This will clean up various Python and build generated files so that you can ensure that you are working in a clean environment.

Project details

Download files

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

Source Distribution

inorbit-edge-1.15.1.tar.gz (39.7 kB view hashes)

Uploaded Source

Built Distribution

inorbit_edge-1.15.1-py3-none-any.whl (37.6 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page