Click or drag to resize
ICameraV2 Interface
Defines the ICamera Interface

Namespace: ASCOM.DeviceInterface
Assembly: ASCOM.DeviceInterfaces (in ASCOM.DeviceInterfaces.dll) Version: 6.0.0.0 (6.2.0.2774)
Syntax
public interface ICameraV2

The ICameraV2 type exposes the following members.

Properties
  NameDescription
Public propertyBayerOffsetX
Returns the X offset of the Bayer matrix, as defined in SensorType.
Public propertyBayerOffsetY
Returns the Y offset of the Bayer matrix, as defined in SensorType.
Public propertyBinX
Sets the binning factor for the X axis, also returns the current value.
Public propertyBinY
Sets the binning factor for the Y axis, also returns the current value.
Public propertyCameraState
Returns the current camera operational state
Public propertyCameraXSize
Returns the width of the CCD camera chip in unbinned pixels.
Public propertyCameraYSize
Returns the height of the CCD camera chip in unbinned pixels.
Public propertyCanAbortExposure
Returns true if the camera can abort exposures; false if not.
Public propertyCanAsymmetricBin
Returns a flag showing whether this camera supports asymmetric binning
Public propertyCanFastReadout
Camera has a fast readout mode
Public propertyCanGetCoolerPower
If true, the camera's cooler power setting can be read.
Public propertyCanPulseGuide
Returns a flag indicating whether this camera supports pulse guiding
Public propertyCanSetCCDTemperature
Returns a flag indicatig whether this camera supports setting the CCD temperature
Public propertyCanStopExposure
Returns a flag indicating whether this camera can stop an exposure that is in progress
Public propertyCCDTemperature
Returns the current CCD temperature in degrees Celsius.
Public propertyConnected
Set True to connect to the device hardware. Set False to disconnect from the device hardware. You can also read the property to check whether it is connected. This reports the current hardware state.
Public propertyCoolerOn
Turns on and off the camera cooler, and returns the current on/off state.
Public propertyCoolerPower
Returns the present cooler power level, in percent.
Public propertyDescription
Returns a description of the device, such as manufacturer and modelnumber. Any ASCII characters may be used.
Public propertyDriverInfo
Descriptive and version information about this ASCOM driver.
Public propertyDriverVersion
A string containing only the major and minor version of the driver.
Public propertyElectronsPerADU
Returns the gain of the camera in photoelectrons per A/D unit.
Public propertyExposureMax
Returns the maximum exposure time supported by StartExposure.
Public propertyExposureMin
Minimium exposure time
Public propertyExposureResolution
Exposure resolution
Public propertyFastReadout
Gets or sets Fast Readout Mode
Public propertyFullWellCapacity
Reports the full well capacity of the camera in electrons, at the current camera settings (binning, SetupDialog settings, etc.)
Public propertyGain
Index into the Gains array for the selected camera gain
Public propertyGainMax
Maximum value of Gain
Public propertyGainMin
Minimum value of Gain
Public propertyGains
Gains supported by the camera
Public propertyHasShutter
Returns a flag indicating whether this camera has a mechanical shutter
Public propertyHeatSinkTemperature
Returns the current heat sink temperature (called "ambient temperature" by some manufacturers) in degrees Celsius.
Public propertyImageArray
Returns a safearray of int of size NumX * NumY containing the pixel values from the last exposure.
Public propertyImageArrayVariant
Returns a safearray of Variant of size NumX * NumY containing the pixel values from the last exposure.
Public propertyImageReady
Returns a flag indicating whether the image is ready to be downloaded fom the camera
Public propertyInterfaceVersion
The interface version number that this device supports. Should return 2 for this interface version.
Public propertyIsPulseGuiding
Returns a flag indicating whether the camera is currrently in a PulseGuide operation.
Public propertyLastExposureDuration
Reports the actual exposure duration in seconds (i.e. shutter open time).
Public propertyLastExposureStartTime
Reports the actual exposure start in the FITS-standard CCYY-MM-DDThh:mm:ss[.sss...] format.
Public propertyMaxADU
Reports the maximum ADU value the camera can produce.
Public propertyMaxBinX
Returns the maximum allowed binning for the X camera axis
Public propertyMaxBinY
Returns the maximum allowed binning for the Y camera axis
Public propertyName
The short name of the driver, for display purposes
Public propertyNumX
Sets the subframe width. Also returns the current value.
Public propertyNumY
Sets the subframe height. Also returns the current value.
Public propertyPercentCompleted
Percent conpleted, Interface Version 2 only
Public propertyPixelSizeX
Returns the width of the CCD chip pixels in microns.
Public propertyPixelSizeY
Returns the height of the CCD chip pixels in microns.
Public propertyReadoutMode
Readout mode, Interface Version 2 only
Public propertyReadoutModes
List of available readout modes, Interface Version 2 only
Public propertySensorName
Sensor name, Interface Version 2 only ## Mandatory must return an empty string if the sensor is unknown
Public propertySensorType
Type of colour information returned by the the camera sensor, Interface Version 2 only
Public propertySetCCDTemperature
Sets the camera cooler setpoint in degrees Celsius, and returns the current setpoint.
Public propertyStartX
Sets the subframe start position for the X axis (0 based) and returns the current value.
Public propertyStartY
Sets the subframe start position for the Y axis (0 based). Also returns the current value.
Public propertySupportedActions
Returns the list of action names supported by this driver.
Top
Methods
  NameDescription
Public methodAbortExposure
Aborts the current exposure, if any, and returns the camera to Idle state.
Public methodCode exampleAction
Invokes the specified device-specific action.
Public methodCommandBlind
Transmits an arbitrary string to the device and does not wait for a response. Optionally, protocol framing characters may be added to the string before transmission.
Public methodCommandBool
Transmits an arbitrary string to the device and waits for a boolean response. Optionally, protocol framing characters may be added to the string before transmission.
Public methodCommandString
Transmits an arbitrary string to the device and waits for a string response. Optionally, protocol framing characters may be added to the string before transmission.
Public methodDispose
Dispose the late-bound interface, if needed. Will release it via COM if it is a COM object, else if native .NET will just dereference it for GC.
Public methodPulseGuide
Activates the Camera's mount control sytem to instruct the mount to move in a particular direction for a given period of time
Public methodSetupDialog
Launches a configuration dialog box for the driver. The call will not return until the user clicks OK or cancel manually.
Public methodStartExposure
Starts an exposure. Use ImageReady to check when the exposure is complete.
Public methodStopExposure
Stops the current exposure, if any.
Top
Remarks
The camera state diagram is shown here:
See Also