inorbit-edge 0.2.0

InOrbit Python Edge SDK

InOrbit Python Edge SDK

The InOrbit Edge SDK allows Python programs to communicate with InOrbit platform on behalf of robots - providing robot data and handling robot actions. It's 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.
• Execute callbacks on Custom Action execution.

Quick Start

from inorbit_edge.robot import RobotSessionFactory, RobotSessionPool

def my_custom_command_handler(robot_session, message):
    """Callback for custom actions.

    Callback method executed for messages published on the ``custom_command``
    topic. It recieves the RobotSession object and the message that contains
    the ``cmd`` and ``ts`` fields.

    Args:
        robot_session (RobotSession): RobotSession object
        message (dict): Message with the ``cmd`` string as defined
            on InOrbit Custom Defined action and ``ts``.
    """

    print(
        "Robot '{}' received command '{}'".format(
            robot_session.robot_id, message["cmd"]
        )
    )


robot_session_factory = RobotSessionFactory(
    api_key="<YOUR_API_KEY>",
    custom_command_callback=my_custom_command_handler
)

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 both Python 3.7 and Python 3.8 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.