Client

Both SDKs expose a Client entry point for the appliance gRPC control plane. Python owns its channel directly; TypeScript accepts a Connect transport from the runtime-specific entry points.

OLO Python SDK — appliance gRPC control plane + platform Connect catalogs.

class olo.Client[source]

Bases: object

Entry point for the sync OLO Python SDK.

__init__(target=None, *, platform_url=None, platform_token=None)[source]

Connect to the appliance gRPC target; optionally configure platform.

Parameters:

  • target (str | None)

  • platform_url (str | None)

  • platform_token (str | None)

property ai: Ai

Return the AI API wrapper.

property archive: Archive

Return the local archive API wrapper.

close()[source]

Close the underlying gRPC channel.

Return type:

None

property core: Core

Return the Core API wrapper.

property kinematics: Kinematics

Return the Kinematics API wrapper.

property locomotion: Locomotion

Return the local locomotion API wrapper.

property navigation: Navigation

Return the Navigation API wrapper.

property platform: Platform

Return the platform catalog API (server-direct, PAT-authenticated).

robot(namespace=None)[source]

Return a namespace-scoped robot handle.

Return type:

Robot

Parameters:

namespace (str | None)

property spatial: Spatial

Return the Spatial API wrapper.

class olo.Robot[source]

Bases: object

Namespace-scoped robot handle over supported robot capabilities.

__init__(client, namespace)[source]

Bind service handles for a resolved robot namespace.

Parameters:
Return type:

None

olo.DEFAULT_TARGET = '127.0.0.1:50151'

Default gRPC target when Client() is called without one and OLO_SDK_GRPC_TARGET is unset.

olo.ENV_TARGET = 'OLO_SDK_GRPC_TARGET'

Environment variable that overrides olo.DEFAULT_TARGET.

olo exports a runtime-neutral Client and channel helpers.

  • Client — entry point for the TypeScript SDK; exposes the core, spatial, kinematics, locomotion, navigation, vision, and ai module wrappers plus robot().

  • Robot — namespace-scoped robot handle with always-present capability handles; operations validate their own runtime dependencies.

  • DEFAULT_TARGET — default appliance gRPC target.

  • ENV_TARGET — environment variable that overrides DEFAULT_TARGET for target resolution in Node.

Construct Client with a Connect transport for your runtime:

import { Client } from "olo";

const client = new Client(myTransport);