Skip to main content

Python SDK for OLO robot control via ROS

Project description

OLO Python SDK

Python SDK for controlling robots via ROS (Robot Operating System) through WebSocket connections.

Installation

pip install olo-client

Optional Dependencies

For WebRTC video streaming support:

pip install olo-client[video]

For all optional features:

pip install olo-client[full]

Quick Start

import asyncio
from oloclient import OLOClient

async def main():
    # Connect to ROS bridge
    async with OLOClient(ros_url='ws://localhost:9090') as client:
        # List available topics
        topics = await client.core.list_topics()
        print(f"Found {len(topics)} topics")

asyncio.run(main())

Standalone Platform Auth

For standalone SDK usage, create a personal access token in the OLO web app and pass it to the client.

import asyncio
from oloclient import OLOClient

async def main():
    client = OLOClient(
        server_url='wss://app.olo-robotics.com',
        api_url='https://app.olo-robotics.com',
        auth_token='olo_pat_your_token_here'
    )

    robots = await client.get_user_robots()
    await client.connect(robot_id=robots[0]['id'])
    print(await client.core.list_topics())

asyncio.run(main())

Username/password login is still available for compatibility, but two-factor-enabled accounts should use a personal access token instead of putting credentials in code.

Documentation

For full API documentation, see the OLO Documentation.

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

olo_client-1.0.2.tar.gz (64.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

olo_client-1.0.2-py3-none-any.whl (73.9 kB view details)

Uploaded Python 3

File details

Details for the file olo_client-1.0.2.tar.gz.

File metadata

  • Download URL: olo_client-1.0.2.tar.gz
  • Upload date:
  • Size: 64.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for olo_client-1.0.2.tar.gz
Algorithm Hash digest
SHA256 b0522ae4df826cc63d887e98cae8358a1c5fcbff4b789d32dc50aa76aefa1469
MD5 69f6ed79c4d4df54ac704b75cba596f6
BLAKE2b-256 a74469b9cabc1124ec1179ab418d2044f27cf32ed41afd3eab96ca7a63e524b3

See more details on using hashes here.

Provenance

The following attestation bundles were made for olo_client-1.0.2.tar.gz:

Publisher: publish.yml on OLO-Robotics/olo-python-sdk

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file olo_client-1.0.2-py3-none-any.whl.

File metadata

  • Download URL: olo_client-1.0.2-py3-none-any.whl
  • Upload date:
  • Size: 73.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for olo_client-1.0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 d1e14453a6a46fe316f735552fcb2efb2357af621f2d02b37775eb23fcf45787
MD5 37eaf2ff620f5773f2d3c1ae15a518c0
BLAKE2b-256 9a8f7b50b8182fd528ce44f8ae3074a6392c9a6c413e2778e115f507f2435757

See more details on using hashes here.

Provenance

The following attestation bundles were made for olo_client-1.0.2-py3-none-any.whl:

Publisher: publish.yml on OLO-Robotics/olo-python-sdk

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

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