A json file can be used to initialize a hardware simulator. How to create and use such a file is described in this read me.
The file is made up of the following keys:values which are all optional.
{
"machine": "OT-2 Standard" # or "OT-3 Standard"; OT-2 is the default
"attached_instruments": {
"right": {
# Definition of right pipette
...
},
"left": {
# Definition of left pipette
...
},
"gripper": {
# Definition of gripper, if machine is OT-3 Standard
}
},
}
For available fields, see:
{
"attached_modules": {
# A mapping of module type to an optional list of setup
# function calls which will be called in order.
"thermocycler": [
{
"function_name": "set_temperature",
"kwargs": {
"temperature": 3,
"hold_time_seconds": 1,
"hold_time_minutes": 2,
"ramp_rate": 4,
"volume": 5
}
},
{
"function_name": "set_lid_temperature",
"kwargs": {
"temperature": 4
}
},
{
"function_name": "close"
}
],
"tempdeck": [
{
"function_name": "set_temperature",
"kwargs": {
"celsius": 3
}
}
],
"magdeck": [
{
"function_name": "engage",
"kwargs": {
"height": 4
}
}
]
}
}
This is the same format as robot_settings.json as defined in robot_configs if this is an OT-2. If this is an OT-3, it is the OT-3 variant.
{
configs: {
"name": ...,
"version": ....,
.....
}
}
Use OT_ROBOT_SERVER_simulator_configuration_file_path environment variable to point to a custom simulator configuration file.