Stg_HeatStage_ContinueCooling, Stg_HeatStage_ContinueHeating, Stg_HeatStage_GetCount, Stg_HeatStage_GetCurrentTemperature, Stg_HeatStage_GetName, Stg_HeatStage_GetStatus, Stg_HeatStage_HoldCurrentTemperature, Stg_HeatStage_SetTemperature, Stg_HeatStage_SetTemperatureRate, Stg_HeatStage_StartHeatingCooling, Stg_HeatStage_StopHeatingCooling, Stg_HeatStageContinueCooling, Stg_HeatStageContinueHeating, Stg_HeatStageGetCurrentTemperature, Stg_HeatStageGetStatus, Stg_HeatStageHoldCurrentTemperature, Stg_HeatStageIsPresent, Stg_HeatStageSetTemperature, Stg_HeatStageSetTemperatureRate, Stg_HeatStageStartHeatingCooling, Stg_HeatStageStopHeatingCooling

Stg_HeatStageContinueCooling

Description 

 Stg_HeatStageContinueCooling();

When called, the heating/cooling device starts cooling.

Stg_HeatStageContinueHeating

Description 

 Stg_HeatStageContinueHeating();

When called, the heating stage starts heating.

Stg_HeatStageGetCurrentTemperature

Description 

 Stg_HeatStageGetCurrentTemperature();

This function returns the current temperature of the heating stage.

Stg_HeatStageGetStatus

Description 

int Stg_HeatStageGetStatus();

This function returns information about the heating stage status.

Return Values

int

Heating stage (temperature) status

0	None - the status is not defined
1	Cooling - the stage temperature is subsiding.
2	Heating - the stage temperature is rising to the defined limit.
3	Holding - the current temperature is being maintained on user request
4	At Limit - the defined temperature has been reached and is maintained

Note

Different incubators/heating stages start “Holding” after the target temperature is reached and the function returns 3. Other devices reach the target temperature and let it uncontrolled afterwards - the function returns 4.

Stg_HeatStageHoldCurrentTemperature

Description 

 Stg_HeatStageHoldCurrentTemperature();

When called, the heating stage interrupts heating/cooling and keeps the current temperature.

Stg_HeatStageIsPresent

Description 

 Stg_HeatStageIsPresent();

Checks if the heating stage is connected.

Return Values

This function returns TRUE (1) if the heating stage is connected, else FALSE (0).

Stg_HeatStageSetTemperature

Description 

 Stg_HeatStageSetTemperature(
   double  Temperature
);

This function sets the target temperature of a heating/cooling device in degrees Celsius.

Parameters

double Temperature

The temperature in degrees Celsius [°C].

Return Values

This function returns TRUE (1) if successful, otherwise FALSE (0).

Stg_HeatStageSetTemperatureRate

Description 

 Stg_HeatStageSetTemperatureRate(
   double  TemperatureRate
);

This function sets the heat stage heating/cooling temperature rate in °C/min.

Parameters

double TemperatureRate

Heating/cooling rate in °C/min.

Return Values

This function returns TRUE (1) if successful, otherwise FALSE (0).

Stg_HeatStageStartHeatingCooling

Description 

 Stg_HeatStageStartHeatingCooling();

When called the heating stage starts heating/cooling according to the target temperature that is set currently.

Stg_HeatStageStopHeatingCooling

Description 

 Stg_HeatStageStopHeatingCooling();

When called the heating/cooling device stops heating/cooling.

Stg_HeatStage_ContinueCooling

Description 

 Stg_HeatStage_ContinueCooling(
   char *HeatStageName
);

When called, the specified heating/cooling device starts cooling.

Parameters

char *HeatStageName

Identification name of the device as it is displayed within the Device Manager.

Stg_HeatStage_ContinueHeating

Description 

 Stg_HeatStage_ContinueHeating(
   char *HeatStageName
);

When called, the specified heating stage starts heating.

Parameters

char *HeatStageName

Identification name of the device as it is displayed within the Device Manager.

Stg_HeatStage_GetCount

Description 

 Stg_HeatStage_GetCount();

This function returns number of heating/cooling devices installed in the Device Manager.

Stg_HeatStage_GetCurrentTemperature

Description 

 Stg_HeatStage_GetCurrentTemperature(
   char *HeatStageName
);

Returns the current temperature of the heat stage.

Parameters

char *HeatStageName

Identification name of the device as it is displayed within the Device Manager.

Stg_HeatStage_GetName

Description 

 Stg_HeatStage_GetName(
   int  HeatStageIndex,
   char *HeatStageName
);

This function retrieves the user name of a heating/cooling device.

Parameters

int HeatStageIndex

Index number of the device.

0	If a single device of this type is installed.

char *HeatStageName

Identification name of the device as it is displayed within the Device Manager.

See Also 
Stg_HeatStage_GetCount

Stg_HeatStage_GetStatus

Description 

int Stg_HeatStage_GetStatus(
   char *HeatStageName
);

This function returns information about the heating stage status.

Parameters

char *HeatStageName

Identification name of the device as it is displayed within the Device Manager.

Return Values

int

Heating stage (temperature) status

0	None - the status is not defined
1	Cooling - the stage temperature is subsiding
2	Heating - the stage temperature is rising to the defined limit
3	Holding - the current temperature is being maintained on user request
4	At Limit - the defined temperature has been reached and is maintained

Note

Different incubators/heating stages start “Holding” after the target temperature is reached and the function returns 3. Other devices reach the target temperature and let it uncontrolled afterwards - the function returns 4.

Stg_HeatStage_HoldCurrentTemperature

Description 

 Stg_HeatStage_HoldCurrentTemperature(
   char *HeatStageName
);

When called, the heating/cooling device will hold the current temperature.

Parameters

char *HeatStageName

Identification name of the device as it is displayed within the Device Manager.

Stg_HeatStage_SetTemperature

Description 

 Stg_HeatStage_SetTemperature(
   char *HeatStageName,
   double  Temperature
);

Sets the target temperature of the specified heating/cooling device in degrees Celsius.

Parameters

char *HeatStageName

Identification name of the device as it is displayed within the Device Manager.

double Temperature

The temperature in degrees Celsius [°C].

Stg_HeatStage_SetTemperatureRate

Description 

 Stg_HeatStage_SetTemperatureRate(
   char *HeatStageName,
   double  TemperatureRate
);

This function sets the heat stage heating/cooling temperature range in °C/min.

Parameters

char *HeatStageName

Identification name of the device as it is displayed within the Device Manager.

double TemperatureRate

Heating/cooling rate in °C/min.

Return Values

This function returns TRUE (1) if successful, otherwise FALSE (0).

Stg_HeatStage_StartHeatingCooling

Description 

 Stg_HeatStage_StartHeatingCooling(
   char *HeatStageName
);

When called the heating/cooling device starts heating/cooling according to the target temperature that is set currently.

Parameters

char *HeatStageName

Identification name of the device as it is displayed within the Device Manager.

Stg_HeatStage_StopHeatingCooling

Description 

 Stg_HeatStage_StopHeatingCooling(
   char *HeatStageName
);

When called the specified heating/cooling device stops heating/cooling.

Parameters

char *HeatStageName

Identification name of the device as it is displayed within the Device Manager.