Shutter

_Stg_FiltersShutters, _Stg_RenameShutter, Stg_CloseFirstShutter, Stg_GetShutterAperture, Stg_GetShutterApertureSteps, Stg_GetShutterCount, Stg_GetShutterName, Stg_GetShutterSpeed, Stg_GetShutterSpeedSteps, Stg_GetShutterState, Stg_GetShutterStateEx, Stg_GetShutterStepAperture, Stg_GetShutterStepSpeed, Stg_IsShutterPresent, Stg_OpenFirstShutter, Stg_SetShutterAperture, Stg_SetShutterSpeed, Stg_SetShutterState, Stg_SetShutterStateEx, Stg_ToggleFirstShutter

Stg_CloseFirstShutter

Description 

 Stg_CloseFirstShutter();

This function closes the shutter in the system, which was found as first.

See Also 
Stg_OpenFirstShutter

Stg_GetShutterAperture

Description 

 Stg_GetShutterAperture(
   int  ShutterType
);

Returns a percentage value of the current aperture setting of the selected shutter type. A smart shutter that enables aperture size adjustment must be present.

Parameters

int ShutterType

Type of the shutter

0, SHUTTER_EPI

EPI shutter

1, SHUTTER_DIA

DIA shutter

2, SHUTTER_AUX1

Auxiliary shutter 1

3, SHUTTER_AUX2

Auxiliary shutter 2

Stg_GetShutterApertureSteps

Description 

 Stg_GetShutterApertureSteps(
   int  ShutterType
);

This functions returns the number of steps which the smart shutter can be set to (according to the hardware specification). A smart shutter that enables aperture size adjustment must be present.

Parameters

int ShutterType

Type of the shutter

0, SHUTTER_EPI

EPI shutter

1, SHUTTER_DIA

DIA shutter

2, SHUTTER_AUX1

Auxiliary shutter 1

3, SHUTTER_AUX2

Auxiliary shutter 2

Stg_GetShutterCount

Description 

 Stg_GetShutterCount();

Returns the number of shutters in the system.

Stg_GetShutterName

Description 

 Stg_GetShutterName(
   int  Index,
   char *ShutterName,
   int  ShutterNameMaxLength
);

Retrieves the set name of the shutter.

Index parameter is the index of the shutter in the order.

Parameters

int Index

Index number (zero-based).

char *ShutterName

Name of the shutter.

int ShutterNameMaxLength

Maximum length of name.

Stg_GetShutterSpeed

Description 

 Stg_GetShutterSpeed(
   int  type
);

Returns the current shutter speed [changes/s].

Parameters

int type

Type of shutter

SHUTTER_EPI

EPI shutter

SHUTTER_DIA

DIA shutter

SHUTTER_AUX1

Auxiliary shutter

SHUTTER_AUX2

Auxiliary shutter

Return Values

Value > 0.0

Shutter speed [changes/s]

DR_BADPARAMETER (-2)

Some parameter has invalid value

DR_NOTAVAILABLE (-4)

Device Shutter is not present

DR_NOTSUPPORTED (-3)

Shutter speed is not controllable

DR_UNKNOWNERROR (-1)

Retrieving the shutter speed failed

Note

This command should only be called if Stg_GetShutterSpeedSteps returns value > 0.

See Also 
Stg_IsShutterPresent, Stg_GetShutterSpeedSteps

Stg_GetShutterSpeedSteps

Description 

 Stg_GetShutterSpeedSteps(
   int  type
);

Returns the number of available shutter speed steps.

Parameters

int type

Type of shutter

SHUTTER_EPI

EPI shutter

SHUTTER_DIA

DIA shutter

SHUTTER_AUX1

Auxiliary shutter

SHUTTER_AUX2

Auxiliary shutter

Return Values

Value > 0

Number of shutter speed steps

DR_BADPARAMETER (-2)

Some parameter has invalid value

DR_NOTAVAILABLE (-4)

Device Shutter is not present

DR_NOTSUPPORTED (-3)

Shutter speed is not controllable

DR_UNKNOWNERROR (-1)

Retrieving the number of shutter speed steps failed

See Also 
Stg_IsShutterPresent, Stg_GetShutterStepSpeed, Stg_SetShutterSpeed, Stg_GetShutterSpeed

Stg_GetShutterState

Description 

 Stg_GetShutterState(
   int  type
);

Returns the current shutter state (open/close).

Parameters

int type

Type of shutter

SHUTTER_EPI

EPI shutter

SHUTTER_DIA

DIA shutter

SHUTTER_AUX1

Auxiliary shutter

SHUTTER_AUX2

Auxiliary shutter

Return Values

0

Shutter is closed

1

Shutter is opened

DR_BADPARAMETER (-2)

Some parameter has invalid value

DR_NOTAVAILABLE (-4)

Device Shutter is not present

DR_UNKNOWNERROR (-1)

Retrieving the shutter state failed

See Also 
Stg_IsShutterPresent

Stg_GetShutterStateEx

Description 

 Stg_GetShutterStateEx(
   char *ShutterName
);

Returns the current shutter state (open/close).

Parameters

char *ShutterName

Name of the shutter.

Return Values

This function returns TRUE (1) if the shutter is open, else FALSE (0).

Stg_GetShutterStepAperture

Description 

 Stg_GetShutterStepAperture(
   int  ShutterType,
   int  ShutterApertureStep
);

This function returns the aperture setting value [%] of the selected aperture step. A smart shutter that enables aperture size adjustment must be present.

Parameters

int ShutterType

Type of the shutter

0, SHUTTER_EPI

EPI shutter

1, SHUTTER_DIA

DIA shutter

2, SHUTTER_AUX1

Auxiliary shutter 1

3, SHUTTER_AUX2

Auxiliary shutter 2

int ShutterApertureStep

Index of the step for which you want to know the aperture value.

See Also 
Stg_GetShutterApertureSteps, Stg_GetShutterAperture

Stg_GetShutterStepSpeed

Description 

 Stg_GetShutterStepSpeed(
   int  type,
   int  step
);

Returns the shutter speed [changes/s] for a given shutter speed step. This command should only be called if Stg_GetShutterSpeedSteps returns value > 0.

Parameters

int type

Type of shutter

SHUTTER_EPI

EPI shutter

SHUTTER_DIA

DIA shutter

SHUTTER_AUX1

Auxiliary shutter

SHUTTER_AUX2

Auxiliary shutter

int step

The shutter speed step is number between 0 and steps-1, where steps is the number of shutter speed steps returned by

Return Values

Value > 0.0

Shutter step speed [changes/s]

DR_BADPARAMETER (-2)

Some parameter has invalid value

DR_NOTAVAILABLE (-4)

Device Shutter is not present

DR_NOTSUPPORTED (-3)

Shutter speed is not controllable

DR_UNKNOWNERROR (-1)

Retrieving the shutter step speed failed

See Also 
Stg_IsShutterPresent, Stg_GetShutterSpeedSteps

Stg_IsShutterPresent

Description 

 Stg_IsShutterPresent(
   int  type
);

Detects if the shutter of the specified type is available.

Parameters

int type

Type of shutter

SHUTTER_EPI

EPI shutter

SHUTTER_DIA

DIA shutter

SHUTTER_AUX1

Auxiliary shutter

SHUTTER_AUX2

Auxiliary shutter

Return Values

TRUE (1)

Shutter is present

FALSE (0)

Shutter is not present

DR_BADPARAMETER (-2)

Some parameter has invalid value

See Also 
Stg_SetShutterState, Stg_GetShutterState, Stg_GetShutterSpeedSteps

Stg_OpenFirstShutter

Description 

 Stg_OpenFirstShutter();

This function opens the shutter in the system, which was found as first.

See Also 
Stg_CloseFirstShutter

Stg_SetShutterAperture

Description 

 Stg_SetShutterAperture(
   int  ShutterType,
   double  ShutterAperture
);

This function sets how much the shutter shall be open [%]. A smart shutter that enables the aperture size adjustment must be present.

Parameters

int ShutterType

Type of the shutter

0, SHUTTER_EPI

EPI shutter

1, SHUTTER_DIA

DIA shutter

2, SHUTTER_AUX1

Auxiliary shutter 1

3, SHUTTER_AUX2

Auxiliary shutter 2

double ShutterAperture

Aperture value [%]

Note

This function only sets the aperture value. It does not open the shutter.

See Also 
Stg_GetShutterStepAperture, Stg_GetShutterApertureSteps

Stg_SetShutterSpeed

Description 

 Stg_SetShutterSpeed(
   int  type,
   double  speed
);

Sets the shutter speed [changes/s]. If the speed is not valid, the closest valid speed will be chosen. This command should only be called if Stg_GetShutterSpeedSteps returns value > 0.

Parameters

int type

Type of shutter

SHUTTER_EPI

EPI shutter

SHUTTER_DIA

DIA shutter

SHUTTER_AUX1

Auxiliary shutter

SHUTTER_AUX2

Auxiliary shutter

double speed

The shutter speed [changes/s] should be number returned by

Return Values

DR_OK (1)

Shutter speed was successfully set

DR_BADPARAMETER (-2)

Some parameter has invalid value

DR_NOTAVAILABLE (-4)

Device Shutter is not present

DR_NOTSUPPORTED (-3)

Shutter speed is not controllable

DR_UNKNOWNERROR (-1)

Setting shutter speed failed

See Also 
Stg_IsShutterPresent, Stg_GetShutterSpeedSteps, Stg_GetShutterStepSpeed

Stg_SetShutterState

Description 

 Stg_SetShutterState(
   int  type,
   int  state
);

Sets the shutter state (open/close).

Parameters

int type

Type of shutter

SHUTTER_EPI

EPI shutter

SHUTTER_DIA

DIA shutter

SHUTTER_AUX1

Auxiliary shutter

SHUTTER_AUX2

Auxiliary shutter

int state

State of shutter

0

Close shutter

1

Open shutter

Return Values

DR_OK (1)

Shutter state was set

DR_BADPARAMETER (-2)

Some parameter has invalid value

DR_NOTAVAILABLE (-4)

Device Shutter is not present

DR_UNKNOWNERROR (-1)

Setting shutter state failed

See Also 
Stg_IsShutterPresent

Stg_SetShutterStateEx

Description 

 Stg_SetShutterStateEx(
   char *ShutterName,
   int  ShutterState
);

Switches the shutter state (open/closed).

Parameters

char *ShutterName

Name of the shutter.

int ShutterState

State of shutter.

0

close shutter

1

open shutter

Stg_ToggleFirstShutter

Description 

 Stg_ToggleFirstShutter();

This function opens or closes the shutter in the system, which was found as first. It calls the Stg_OpenFirstShutter or Stg_CloseFirstShutter eventually.

See Also 
Stg_OpenFirstShutter, Stg_CloseFirstShutter

_Stg_FiltersShutters

This function runs the Devices > Filters and Shutters command.

Description 

 _Stg_FiltersShutters();

This function shows the dialog for the filter and shutter control.

_Stg_RenameShutter

Description 

 _Stg_RenameShutter(
   char *ShutterName
);

Renames the selected shutter. A dialog window with the text field appears. Enter the new name of the shutter.

Parameters

char *ShutterName

Name of the shutter.