SimulatorInterface Class
It contains all the registration/creation time properties of a simulator session.
All required parameters must be populated in order to send to Azure.
Constructor
SimulatorInterface(*, name: str, timeout: typing.Union[float, NoneType] = None, capabilities: object = None, simulator_context: typing.Union[str, NoneType] = None, description: object = None, **kwargs)Parameters
| Name | Description |
|---|---|
|
name
|
Required. Name of the simulator session. |
|
timeout
|
This is the max time in seconds, within which simulator need to send advance request, else it will be timed out and unregistered from Bonsai platform. Set it to (SimulatorComputeTime + RTT network latency + few seconds) Default is 60s. |
|
capabilities
|
Additional Capabilities for the session. |
|
simulator_context
|
Opaque string to the sim authors. It's used to connect simulator
sessions to right brain.false
For hosted sims, we automatically take care of setting the right environment variable for
this.
For Local sims, set it to empty string, and use Bonsai CLI's, |
|
description
|
Schema descriptions of the simulator. Contains State, Action and Config schemas. |