ASCOM Library
ICamera
Camera interface version 4, which incorporates the new members in IAscomDeviceV2 and the members present in ICameraV3
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 ICameraV4 : IAscomDeviceV2,
IAscomDevice, ICameraV3VB
Public Interface ICameraV4
Inherits IAscomDeviceV2, IAscomDevice, ICameraV3- Implements
- IAscomDevice, IAscomDeviceV2, ICameraV3
Properties
| BayerOffsetX |
Returns the X offset of the Bayer matrix, as defined in SensorType.
(Inherited from ICameraV3) |
| BayerOffsetY |
Returns the Y offset of the Bayer matrix, as defined in SensorType.
(Inherited from ICameraV3) |
| BinX |
Sets the binning factor for the X axis, also returns the current value.
(Inherited from ICameraV3) |
| BinY |
Sets the binning factor for the Y axis, also returns the current value.
(Inherited from ICameraV3) |
| CameraState |
Returns the current camera operational state
(Inherited from ICameraV3) |
| CameraXSize |
Returns the width of the CCD camera chip in unbinned pixels.
(Inherited from ICameraV3) |
| CameraYSize |
Returns the height of the CCD camera chip in unbinned pixels.
(Inherited from ICameraV3) |
| CanAbortExposure |
Returns true if the camera can abort exposures; false if not.
(Inherited from ICameraV3) |
| CanAsymmetricBin |
Returns a flag showing whether this camera supports asymmetric binning
(Inherited from ICameraV3) |
| CanFastReadout |
Camera has a fast readout mode
(Inherited from ICameraV3) |
| CanGetCoolerPower |
If true, the camera's cooler power setting can be read.
(Inherited from ICameraV3) |
| CanPulseGuide |
Returns a flag indicating whether this camera supports pulse guiding
(Inherited from ICameraV3) |
| CanSetCCDTemperature |
Returns a flag indicating whether this camera supports setting the CCD temperature
(Inherited from ICameraV3) |
| CanStopExposure |
Returns a flag indicating whether this camera can stop an exposure that is in progress
(Inherited from ICameraV3) |
| CCDTemperature |
Returns the current CCD temperature in degrees Celsius.
(Inherited from ICameraV3) |
| 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) |
| Connecting |
Completion variable for asynchronous connect and disconnect operations
(Inherited from IAscomDeviceV2) |
| CoolerOn |
Turns on and off the camera cooler, and returns the current on/off state.
(Inherited from ICameraV3) |
| CoolerPower |
Returns the present cooler power level, in percent.
(Inherited from ICameraV3) |
| Description |
Returns a description of the driver, such as manufacturer and model number.
(Inherited from IAscomDevice) |
| DeviceState |
Returns the device's operational state in a single call
(Inherited from IAscomDeviceV2) |
| 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.
(Inherited from ICameraV3) |
| ExposureMax |
Returns the maximum exposure time supported by StartExposure.
(Inherited from ICameraV3) |
| ExposureMin |
Minimum exposure time
(Inherited from ICameraV3) |
| ExposureResolution |
Exposure resolution
(Inherited from ICameraV3) |
| FastReadout |
Gets or sets Fast Readout Mode
(Inherited from ICameraV3) |
| FullWellCapacity |
Reports the full well capacity of the camera in electrons, at the current camera settings (binning, SetupDialog settings, etc.)
(Inherited from ICameraV3) |
| Gain |
The camera's gain (GAIN VALUE MODE) OR the index of the selected camera gain description in the Gains array (GAINS INDEX MODE)
(Inherited from ICameraV3) |
| GainMax |
Maximum Gain value of that this camera supports
(Inherited from ICameraV3) |
| GainMin |
Minimum Gain value of that this camera supports
(Inherited from ICameraV3) |
| Gains |
List of Gain names supported by the camera
(Inherited from ICameraV3) |
| HasShutter |
Returns a flag indicating whether this camera has a mechanical shutter
(Inherited from ICameraV3) |
| HeatSinkTemperature |
Returns the current heat sink temperature (called "ambient temperature" by some manufacturers) in degrees Celsius.
(Inherited from ICameraV3) |
| ImageArray |
Returns a safearray of int of size NumX * NumY containing the pixel values from the last exposure.
(Inherited from ICameraV3) |
| ImageArrayVariant |
Returns a safearray of Variant of size NumX * NumY containing the pixel values from the last exposure.
(Inherited from ICameraV3) |
| ImageReady |
Returns a flag indicating whether the image is ready to be downloaded from the camera
(Inherited from ICameraV3) |
| 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.
(Inherited from ICameraV3) |
| LastExposureDuration |
Reports the actual exposure duration in seconds (i.e. shutter open time).
(Inherited from ICameraV3) |
| LastExposureStartTime |
Reports the actual exposure start in the FITS-standard CCYY-MM-DDThh:mm:ss[.sss...] format.
The start time must be UTC.
(Inherited from ICameraV3) |
| MaxADU |
Reports the maximum ADU value the camera can produce.
(Inherited from ICameraV3) |
| MaxBinX |
Returns the maximum allowed binning for the X camera axis
(Inherited from ICameraV3) |
| MaxBinY |
Returns the maximum allowed binning for the Y camera axis
(Inherited from ICameraV3) |
| Name |
The short name of the driver, for display purposes
(Inherited from IAscomDevice) |
| NumX |
Sets the subframe width. Also returns the current value.
(Inherited from ICameraV3) |
| NumY |
Sets the subframe height. Also returns the current value.
(Inherited from ICameraV3) |
| Offset |
The camera's offset (OFFSET VALUE MODE) OR the index of the selected camera offset description in the Offsets array (OFFSETS INDEX MODE)
(Inherited from ICameraV3) |
| OffsetMax |
Maximum Offset value of that this camera supports
(Inherited from ICameraV3) |
| OffsetMin |
Minimum Offset value of that this camera supports
(Inherited from ICameraV3) |
| Offsets |
List of Offset names supported by the camera
(Inherited from ICameraV3) |
| PercentCompleted |
Percent completed, Interface Version 2 only
(Inherited from ICameraV3) |
| PixelSizeX |
Returns the width of the CCD chip pixels in microns.
(Inherited from ICameraV3) |
| PixelSizeY |
Returns the height of the CCD chip pixels in microns.
(Inherited from ICameraV3) |
| ReadoutMode |
Readout mode, Interface Version 2 only
(Inherited from ICameraV3) |
| ReadoutModes |
List of available readout modes, Interface Version 2 only
(Inherited from ICameraV3) |
| SensorName |
Sensor name, Interface Version 2 only
## Mandatory must return an empty string if the sensor is unknown
(Inherited from ICameraV3) |
| SensorType |
Type of colour information returned by the camera sensor, Interface Version 2 only
(Inherited from ICameraV3) |
| SetCCDTemperature |
Sets the camera cooler setpoint in degrees Celsius, and returns the current setpoint.
(Inherited from ICameraV3) |
| StartX |
Sets the subframe start position for the X axis (0 based) and returns the current value.
(Inherited from ICameraV3) |
| StartY |
Sets the subframe start position for the Y axis (0 based). Also returns the current value.
(Inherited from ICameraV3) |
| SubExposureDuration |
Camera's sub-exposure interval
(Inherited from ICameraV3) |
| 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.
(Inherited from ICameraV3) |
| 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) |
| Connect |
Connect to device asynchronously
(Inherited from IAscomDeviceV2) |
| Disconnect |
Disconnect from device asynchronously
(Inherited from IAscomDeviceV2) |
| 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
(Inherited from ICameraV3) |
| StartExposure |
Starts an exposure. Use ImageReady to check when the exposure is complete.
(Inherited from ICameraV3) |
| StopExposure |
Stops the current exposure, if any.
(Inherited from ICameraV3) |
Extension Methods
| ConnectAsync |
Returns an awaitable, running, Task that connects to the device. (Polls IAscomDeviceV2.Connecting)
(Defined by ClientExtensions) |
| DisconnectAsync |
Returns an awaitable, running, Task that disconnects from the device. (Polls IAscomDeviceV2.Connecting)
(Defined by ClientExtensions) |
| 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) |