IVideoSensorName Property

Sensor name.

Definition

Namespace: ASCOM.Common.DeviceInterfaces
Assembly: ASCOM.Common (in ASCOM.Common.dll) Version: 3.0.0-rc.1+86c25ce733aebb4d8b1b8a62e84770ea5e972bea
C#
string SensorName { get; }

Return Value

String
The name of sensor used within the camera.

Remarks

Returns the name (data sheet part number) of the sensor, e.g. ICX285AL. The format is to be exactly as shown on manufacturer data sheet, subject to the following rules. All letter shall be upper case. Spaces shall not be included.

Any extra suffixes that define region codes, package types, temperature range, coatings, grading, color/monochrome, etc. shall not be included. For color sensors, if a suffix differentiates different Bayer matrix encodings, it shall be included.

Examples:

  • ICX285AL-F shall be reported as ICX285
  • KAF-8300-AXC-CD-AA shall be reported as KAF-8300

Note:

The most common usage of this property is to select approximate color balance parameters to be applied to the Bayer matrix of one-shot color sensors. Application authors should assume that an appropriate IR cut-off filter is in place for color sensors.

It is recommended that this function be called only after a connection is established with the camera hardware, to ensure that the driver is aware of the capabilities of the specific camera model.

Exceptions

NotImplementedExceptionMust throw exception if not implemented.
NotConnectedExceptionWhen Connected is False.
DriverExceptionAn error occurred that is not described by one of the more specific ASCOM exceptions. Include sufficient detail in the message text to enable the issue to be accurately diagnosed by someone other than yourself.

Version Information

.NET Standard

Supported in: 2.0

See Also