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.1.tar.gz (76.8 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.1-py3-none-any.whl (86.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: olo_client-1.0.1.tar.gz
  • Upload date:
  • Size: 76.8 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.1.tar.gz
Algorithm Hash digest
SHA256 dea9d83decbcaddd41ebf2bcd9566d68f81f9b638d20843efd4bf50d2e4f3df1
MD5 1189b96989f4107692bf9fe2e67fd77e
BLAKE2b-256 4ac79a87ea425451fec03bbced19d519f7ee628d4e5c6ea9a6fc8a73fe76c6eb

See more details on using hashes here.

Provenance

The following attestation bundles were made for olo_client-1.0.1.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.1-py3-none-any.whl.

File metadata

  • Download URL: olo_client-1.0.1-py3-none-any.whl
  • Upload date:
  • Size: 86.5 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.1-py3-none-any.whl
Algorithm Hash digest
SHA256 40284408dc5e2eaaf408d0c7e850df1912c0dba6f006ce2ecae27fe4e67b4c60
MD5 4849046c37d78c2b665b7c51f1616bc3
BLAKE2b-256 c634421786eac0508d7ac06addeb94f07f96b64f40e5a3a61b54522e292720a8

See more details on using hashes here.

Provenance

The following attestation bundles were made for olo_client-1.0.1-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