Python guide and API reference#
- isaacsim.ovsim.api.make_client(name, configuration=None)#
make_client(name: str, configuration: collections.abc.Mapping[str, str] | None = None) -> isaacsim.ovsim.api.bindings._bindings.Implementation
Create an OV SIM client implementation.
The returned object owns the callable state used by its nested interfaces. Calls execute synchronously and retain the Python GIL except during simulation initialization.
- Parameters:
name – Client implementation name. Use
"in-process"or"local"for an in-process client, or"grpc"for a remote session.configuration – Optional implementation-specific configuration values. A gRPC client requires an
"endpoint"entry containing a channel target such as"127.0.0.1:50051".
- Returns:
Client control and data interfaces.
- Raises:
RuntimeError – If the name does not identify a supported client implementation.
ValueError – If the selected implementation rejects its configuration.
Example
from isaacsim.ovsim.api import make_client client = make_client("local") remote = make_client("grpc", {"endpoint": "127.0.0.1:50051"})
make_client returns an Implementation object exposing control.authoring,
control.simulation, and data, each with the same methods as the corresponding module in
isaacsim.foundation.ovsim /
isaacsim.physics.ovsim.
from isaacsim.ovsim.api import make_client
# name is "in-process" / "local", or "grpc".
client = make_client("in-process")
# gRPC clients require an explicit standard channel target.
remote = make_client("grpc", {"endpoint": "127.0.0.1:50051"})
client.control.authoring.create_stage()
values = client.data.read(paths, "attributeName")