ASCOM Library
ICamera
Defines the ICamera Interface
Definition
Namespace: ASCOM.Common.DeviceInterfaces
Assembly: ASCOM.Common (in ASCOM.Common.dll) Version: 2.2.1+77356f79b05b579f6d860a4edd5934fda9fe29e4
Assembly: ASCOM.Common (in ASCOM.Common.dll) Version: 2.2.1+77356f79b05b579f6d860a4edd5934fda9fe29e4
C#
public interface ICameraV3 : IAscomDeviceVB
Public Interface ICameraV3
Inherits IAscomDevice- Implements
- IAscomDevice
Remarks
The camera state diagram is shown here: 
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 enable the link. Set False to disable the link.
You can also read the property to check whether it is connected.
(Inherited from IAscomDevice) |
| 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 driver, such as manufacturer and model number.
(Inherited from IAscomDevice) |
| DriverInfo |
Descriptive and version information about this ASCOM driver.
(Inherited from IAscomDevice) |
| DriverVersion |
A string in the form "n.n" containing only the major and minor version of the driver.
(Inherited from IAscomDevice) |
| 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 a safearray of int of size NumX * NumY containing the pixel values from the last exposure. |
| ImageArrayVariant | Returns a safearray of 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 implements.
(Inherited from IAscomDevice) |
| 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
(Inherited from IAscomDevice) |
| 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 of that this camera supports |
| OffsetMin | Minimum Offset value of that this camera supports |
| Offsets | List of Offset names supported by the camera |
| PercentCompleted | Percent completed, Interface Version 2 only |
| 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 only ## Mandatory must return an empty string if the sensor is unknown |
| SensorType | Type of colour information returned by the camera sensor, Interface Version 2 only |
| SetCCDTemperature | Sets the camera cooler setpoint in degrees Celsius, and returns the current setpoint. |
| 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 action names supported by this driver.
(Inherited from IAscomDevice) |
Methods
| AbortExposure | Aborts the current exposure, if any, and returns the camera to Idle state. |
| Action |
Invokes the specified device-specific action.
(Inherited from IAscomDevice) |
| 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.
(Inherited from IAscomDevice) |
| 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.
(Inherited from IAscomDevice) |
| 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.
(Inherited from IAscomDevice) |
| 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.
(Inherited from IAscomDevice) |
| PulseGuide | Activates the Camera's mount control system to instruct the mount to move in a particular direction for a given period of time |
| StartExposure | Starts an exposure. Use ImageReady to check when the exposure is complete. |
| StopExposure | Stops the current exposure, if any. |
Extension Methods
| StartExposureAsync |
Returns an awaitable, running, Task that takes a camera image
(Defined by ClientExtensions) |
| StopExposureAsync |
Returns an awaitable, running, Task that stops the current camera exposure
(Defined by ClientExtensions) |