Sensor name, Interface Version 2 only ## Mandatory must return an empty string if the sensor is unknown

Namespace: ASCOM.DeviceInterface
Assembly: ASCOM.DeviceInterfaces (in ASCOM.DeviceInterfaces.dll) Version: 6.0.0.0 (6.1.1.2619)

Syntax

C#
string SensorName { get; }
Visual Basic
ReadOnly Property SensorName As String
	Get
Visual C++
property String^ SensorName {
	String^ get ();
}

Return Value

The name of the sensor used within the camera.

Remarks

May throw a PropertyNotImplementedException if the sensor's name is not known.

Returns the name (datasheet 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 letters shall be uppercase.
  • 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.
  • The call shall return an empty string if the sensor name is not known.

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 cutoff 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.

This is only available for the Camera Interface Version 2

Exceptions

ExceptionCondition
NotConnectedExceptionMust throw an exception if the information is not available. (Some drivers may require an active connection in order to retrieve necessary information from the camera.)

See Also