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.1.0.tar.gz (64.9 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.1.0-py3-none-any.whl (74.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: olo_client-1.1.0.tar.gz
  • Upload date:
  • Size: 64.9 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.1.0.tar.gz
Algorithm Hash digest
SHA256 fb2751d35640011ccc0ed918b1ae00c506cc503e13a9773579e23b05e22c19c9
MD5 a290e2ca2ee198b1c9daba6c389c30a5
BLAKE2b-256 5c16fd52634ba8380c9937f93229a18943fa034e08a32909beb9ebf3968df966

See more details on using hashes here.

Provenance

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

File metadata

  • Download URL: olo_client-1.1.0-py3-none-any.whl
  • Upload date:
  • Size: 74.1 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.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 008a3b858a7ae1e5dc53eea363e3a11bde4b72acbc0e3931476d528a7f5eecbe
MD5 05522b4857e55848e575771e729e0418
BLAKE2b-256 d99d15036155fafc5eea3a6decd67b1b9cf91369d5f463b2c517176e7a7d4e62

See more details on using hashes here.

Provenance

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