simulator unmanaged connect

Syntax and usage

bonsai simulator unmanaged connect
  -b BRAIN_NAME             | --brain-name BRAIN_NAME
  -a ACTION_TOKEN           | --action ACTION_TOKEN
  -c CONCEPT_NAME           | --concept-name CONCEPT_NAME
  [ --brain-version VERSION ]
  [ -d SIMULATOR_SESSION_ID | --session-id SIMULATOR_SESSION_ID ]
  [ --simulator-name SIMULATOR_NAME ]
  [ -o OUTPUT_FORMAT        | --output OUTPUT_FORMAT ]
  [ --debug ]

bonsai simulator unmanaged connect -h |--help

Connect an unmanaged (local) simulator, or group of simulators, to a brain version.

Important

You must have registered local (unmanaged) simulators with Bonsai through the Simulator API before connecting them to a brain. Unmanaged simulators are run manually during training and assessment.

Options


-b BRAIN_NAME

--brain-name BRAIN_NAME

Required, string.

Indicates the unique system name for the target brain. System names are case-insensitive and can contain letters, numbers, and dashes.

Example: --brain-name 'HiveMind'


-a ACTION_TOKEN

--action ACTION_TOKEN

Required, enumerated string.

Indicates the assigned action for the associated brain and simulator. Supported actions are noted below.

Token Action
Train Use the brain and simulator combo for training
Assess Use the brain and simulator combo for assessment

Example: --action Train


-c CONCEPT_NAME

--concept-name CONCEPT_NAME

Required, string.

Indicates the target concept as defined in the Inkling for the target brain version.

Example: --concept-name 'OptimizeHoney'


--brain-version BRAIN_VERSION

Optional, integer.

Indicates the desired version for the target brain. Defaults to the latest version.

Example: --brain-version 2


-d SIMULATOR_SESSION_ID

--session-id SIMULATOR_SESSION_ID

Optional, string.

Indicates the unique identifier for a local (unmanaged) simulator registered with your Bonsai workspace.

Example: --session-id 000000000_00.192.168.0.1


--simulator-name SIMULATOR_NAME

Optional, string.

Indicates the unique system name for a grouping of unassigned simulators. System names are case-insensitive and can contain letters, numbers, and dashes.

The group name should match a simulator name provided during a previous registration request.

Example: --simulator-name 'Apiary-HVAC'


-w WORKSPACE_ID

--workspace-id WORKSPACE_ID

Optional, hex string.

Indicates the Bonsai workspace that should be used when the CLI communicates with the Bonsai server.

Example: --workspace-id 00000000-0000-0000-0000-000000000000


-o OUTPUT_FORMAT

--output OUTPUT_FORMAT

Optional, enumerated string.

Sets the display format for responses received from the Bonsai server. The default format is tabular. Other supported options are noted below.

Token Output format
json JSON

Example: --output json


--debug

Optional.

Display verbose logging information in JSON. Includes request details from the CLI and response details from the Bonsai server.

Example: --debug


-h

--help

Optional.

Displays in-line help for the command and exit. Required options are not needed when using the help flag.

Example: --help

Examples

Connect the local sim registered with session ID 000000000_00.192.168.0.1 to the HiveMind brain:

$ bonsai simulator unmanaged connect        \
    --session-id '000000000_00.192.168.0.1' \
    --brain-name 'HiveMind'                 \
    --action Assess
Apiary-HVAC-43 set to assess on HiveMind.

Connect the local sim registered with session ID 000000000_00.192.168.0.1 to the HiveMind brain under the simulator name *Apiary-HVAC:

$ bonsai simulator unmanaged connect        \
    --session-id '000000000_00.192.168.0.1' \
    --brain-name 'HiveMind'                 \
    --action Assess                         \
    --simulator-name 'Apiary-HVAC'
Apiary-HVAC-43 set to assess on HiveMind.