Skip to main content

InOrbit Edge SDK for Python

Project description

InOrbit Python Edge SDK

Build License PyPI - Package Version PyPI - Python Version

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.


Features

  • 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.

    Args:
        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
        options["result_function"]("0")


robot_session_factory = RobotSessionFactory(
    api_key="<YOUR_API_KEY>"
)

# Register commands handlers. Note that all handlers are invoked.
robot_session_factory.register_command_callback(my_command_handler)
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)

Installation

Stable Release: pip install inorbit-edge
**Development Head: ** pip install git+https://github.com/inorbit-ai/edge-sdk-python.git

Documentation

For full package documentation please visit InOrbit Developer Portal.

Development

See CONTRIBUTING.md 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.12 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.20.1.tar.gz (41.0 kB view details)

Uploaded Source

Built Distribution

inorbit_edge-1.20.1-py3-none-any.whl (39.6 kB view details)

Uploaded Python 3

File details

Details for the file inorbit-edge-1.20.1.tar.gz.

File metadata

  • Download URL: inorbit-edge-1.20.1.tar.gz
  • Upload date:
  • Size: 41.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.9.23

File hashes

Hashes for inorbit-edge-1.20.1.tar.gz
Algorithm Hash digest
SHA256 1ec0757c447ec6819b26800e386944579ba6ac27f5ec08db887dead0478dde17
MD5 2df4317ecee1b58ac47cd7cc1af3872d
BLAKE2b-256 2458ad030c2ccf318f5303816ec643ec4c7dbcec27778e8332a0b44ead778b67

See more details on using hashes here.

File details

Details for the file inorbit_edge-1.20.1-py3-none-any.whl.

File metadata

  • Download URL: inorbit_edge-1.20.1-py3-none-any.whl
  • Upload date:
  • Size: 39.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.9.23

File hashes

Hashes for inorbit_edge-1.20.1-py3-none-any.whl
Algorithm Hash digest
SHA256 dd4e4ce07a91a2cb72f61cbbe33a84d4b528f7fe1f18327d2387253f57c5862c
MD5 aea60d18017b2e09fca4b1b1d09ff9b5
BLAKE2b-256 cadd46a37127ba52cec3205247ab5c1d48cfd292c7d93a382ff8f15cbb8cfadd

See more details on using hashes here.

Supported by

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