ASCOM Platform Developer Help
ICamera
Defines the ICameraV3 Interface
Definition
Namespace: ASCOM.DeviceInterface
Assembly: ASCOM.DeviceInterfaces (in ASCOM.DeviceInterfaces.dll) Version: 7.1.3+4851.c5da65c2b
Assembly: ASCOM.DeviceInterfaces (in ASCOM.DeviceInterfaces.dll) Version: 7.1.3+4851.c5da65c2b
C#
public interface ICameraV4VB
Public Interface ICameraV4C++
public interface class ICameraV4Remarks
See this link for the canonical definition, which may include further information and implementation requirements: Canonical Definition
Properties
| BayerOffsetX | Returns the X offset of the Bayer matrix, as defined in SensorType. |
| BayerOffsetY | Returns the Y offset of the Bayer matrix, as defined in SensorType. |
| BinX | Sets the binning factor for the X axis, also returns the current value. |
| BinY | Sets the binning factor for the Y axis, also returns the current value. |
| CameraState | Returns the current camera operational state |
| CameraXSize | Returns the width of the CCD camera chip in unbinned pixels. |
| CameraYSize | Returns the height of the CCD camera chip in unbinned pixels. |
| CanAbortExposure | Returns true if the camera can abort exposures; false if not. |
| CanAsymmetricBin | Returns a flag showing whether this camera supports asymmetric binning |
| CanFastReadout | Camera has a fast readout mode |
| CanGetCoolerPower | If true, the camera's cooler power setting can be read. |
| CanPulseGuide | Returns a flag indicating whether this camera supports pulse guiding |
| CanSetCCDTemperature | Returns a flag indicating whether this camera supports setting the CCD temperature |
| CanStopExposure | Returns a flag indicating whether this camera can stop an exposure that is in progress |
| CCDTemperature | Returns the current CCD temperature in degrees Celsius. |
| Connected | 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. |
| Connecting | Returns True while the device is undertaking an asynchronous connect or disconnect operation. |
| CoolerOn | Turns on and off the camera cooler, and returns the current on/off state. |
| CoolerPower | Returns the present cooler power level, in percent. |
| Description | Returns a description of the device, such as manufacturer and model number. Any ASCII characters may be used. |
| DeviceState | Returns the device's operational state in a single call. |
| DriverInfo | Descriptive and version information about this ASCOM driver. |
| DriverVersion | A string containing only the major and minor version of the driver. |
| ElectronsPerADU | Returns the gain of the camera in photoelectrons per A/D unit. |
| ExposureMax | Returns the maximum exposure time supported by StartExposure. |
| ExposureMin | Minimum exposure time |
| ExposureResolution | Exposure resolution |
| FastReadout | Gets or sets Fast Readout Mode |
| FullWellCapacity | Reports the full well capacity of the camera in electrons, at the current camera settings (binning, SetupDialog settings, etc.) |
| Gain | The camera's gain (GAIN VALUE MODE) OR the index of the selected camera gain description in the Gains array (GAINS INDEX MODE) |
| GainMax | Maximum Gain value of that this camera supports |
| GainMin | Minimum Gain value of that this camera supports |
| Gains | List of Gain names supported by the camera |
| HasShutter | Returns a flag indicating whether this camera has a mechanical shutter |
| HeatSinkTemperature | Returns the current heat sink temperature (called "ambient temperature" by some manufacturers) in degrees Celsius. |
| ImageArray | Returns an array of int of size NumX * NumY containing the pixel values from the last exposure. |
| ImageArrayVariant | Returns an array of COM-Variant of size NumX * NumY containing the pixel values from the last exposure. |
| ImageReady | Returns a flag indicating whether the image is ready to be downloaded from the camera |
| InterfaceVersion | The interface version number that this device supports. Should return 4 for this interface version. |
| IsPulseGuiding | Returns a flag indicating whether the camera is currently in a PulseGuide operation. |
| LastExposureDuration | Reports the actual exposure duration in seconds (i.e. shutter open time). |
| LastExposureStartTime | Reports the actual exposure start in the FITS-standard CCYY-MM-DDThh:mm:ss[.sss...] format. The start time must be UTC. |
| MaxADU | Reports the maximum ADU value the camera can produce. |
| MaxBinX | Returns the maximum allowed binning for the X camera axis |
| MaxBinY | Returns the maximum allowed binning for the Y camera axis |
| Name | The short name of the driver, for display purposes |
| NumX | Sets the subframe width. Also returns the current value. |
| NumY | Sets the subframe height. Also returns the current value. |
| Offset | The camera's offset (OFFSET VALUE MODE) OR the index of the selected camera offset description in the Offsets array (OFFSETS INDEX MODE) |
| OffsetMax | Maximum Offset value that this camera supports |
| OffsetMin | Minimum Offset value that this camera supports |
| Offsets | List of Offset names supported by the camera |
| PercentCompleted | Percent completed, Interface Version 2 and later |
| PixelSizeX | Returns the width of the CCD chip pixels in microns. |
| PixelSizeY | Returns the height of the CCD chip pixels in microns. |
| ReadoutMode | Readout mode, Interface Version 2 only |
| ReadoutModes | List of available readout modes, Interface Version 2 only |
| SensorName | Sensor name, Interface Version 2 and later |
| SensorType | Type of colour information returned by the camera sensor, Interface Version 2 and later |
| SetCCDTemperature | Sets the camera cooler set-point in degrees Celsius, and returns the current set-point. |
| StartX | Sets the subframe start position for the X axis (0 based) and returns the current value. |
| StartY | Sets the subframe start position for the Y axis (0 based). Also returns the current value. |
| SubExposureDuration | Camera's sub-exposure interval |
| SupportedActions | Returns the list of custom action names supported by this driver. |
Methods
| AbortExposure | Aborts the current exposure, if any, and returns the camera to Idle state. |
| Action | Invokes the specified device-specific custom action. |
| CommandBlind | 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. |
| CommandBool | 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. |
| CommandString | 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. |
| Connect | Connect to the device asynchronously |
| Disconnect | Disconnect from the device asynchronously |
| Dispose | This method is a "clean-up" method that is primarily of use to drivers that are written in languages such as C# and VB.NET where resource clean-up is initially managed by the language's runtime garbage collection mechanic. Driver authors should take care to ensure that a client or runtime calling Dispose() does not adversely affect other connected clients. Applications should not call this method. |
| PulseGuide | Activates the Camera's mount control system to instruct the mount to move in a particular direction for a given period of time |
| SetupDialog | Launches a configuration dialogue box for the driver. The call will not return until the user clicks OK or cancel manually. |
| StartExposure | Starts an exposure. Use ImageReady to check when the exposure is complete. |
| StopExposure | Stops the current exposure, if any. |