Environment Settings Documentation

Leica logo

Microscope Control Software version 2.2.1.6

Field Type/Value Description Required Default
Environment control
ApplicationSettings
DriverCO2SensorstringDriver for CO2 sensor, must be "GasSensorDriverSNC1".Yes
RequestCO2stringString to send to sensor to request CO2 concentration. Empty string means no concentration requests will be sent.Yes
RegExCO2stringRegular expression including capturing group names "CO2Conc" to extract CO2 concentration from sensor response.Yes
FactorCO2intFactor to divide extracted "CO2Conc" to get CO2 concentration.Yes
COMCO2stringIf not null override COM port automatic detection and use specified COM port for CO2 sensor.Nonull
DriverO2SensorstringDriver for O2 sensor, must be "GasSensorDriverSNO1".Yes
RequestO2stringString to send to sensor to request O2 concentration. Empty string means no concentration requests will be sent.Yes
RegExO2stringRegular expression including capturing group names "O2Conc" to extract O2 concentration from sensor response.Yes
FactorO2intFactor to divide extracted "O2Conc" to get O2 concentration.Yes
COMO2stringIf not null override COM port automatic detection and use specified COM port for O2 sensor.Nonull
DriverGasValveBlockstringDriver for gas valve block, must be "GasValveBlockDriverGVB1"Yes
COMGasValveBlockstringIf not null override COM port automatic detection and use specified COM port for gas valve block.Nonull
VersionstringThe version of the settings.Yes
GasSettingsSettings of the gas.
SetCO2doubleThe CO2 target concentration in percent.Yes
SetO2doubleThe O2 target concentration in percent.Yes
ControlCO2boolWhether CO2 control is enabled.Yes
ControlO2boolWhether O2 control is enabled.Yes
VersionstringThe version of the settings.Yes
PID_EIntegrals<CO2/O2>Settings to store the learned PID error integrals.
EIntegralsdict (string => double)Dictionary of learned PID error integrals. Key is a combination of CO2 and O2 set value.Yes
FlowExcessThresholddoubleThe value in ml/min above which the flow is considered excessive.No2
VersionstringThe version of the settings.Yes
PID_Settings<CO2/O2>Settings for the PID controller.
FlowFulldoubleFlow of gas in ml/min at 100% valve command.Yes
KpdoubleProportional gain (Kp) of the PID controller.Yes
KidoubleIntegral gain (Ki) of the PID controller.Yes
KddoubleDerivative gain (Kd) of the PID controller.Yes
IntegrationThresholdMindoubleMinimum current gas concentration to start counting down integration delay.Yes
IntegrationThresholdMaxdoubleMaximum current gas concentration to start counting down integration delay.Yes
IntegrationDependentGasErrorThresholddoubleMaximum error of dependent gas concentration (CO2 is dependent on O2) before integration delay starts counting down.Yes
IntegrationDelayintDelay of error integration in seconds, starts counting down if thresholds in this settings file are met.Yes