Click or drag to resize

ICameraV3SensorName Property

Sensor name, Interface Version 2 and later

Namespace:  ASCOM.DeviceInterface
Assembly:  ASCOM.DeviceInterfaces (in ASCOM.DeviceInterfaces.dll) Version: 3351c4f3fa64146a7efd5b51ed4591e32a0a5484
Syntax
Copy
string SensorName { get; }

Return Value

Type: String
The name of the sensor used within the camera.
Exceptions
ExceptionCondition
PropertyNotImplementedExceptionMust throw an exception if not supported.
NotConnectedExceptionIf the device is not connected
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.
Remarks

Mandatory, must return an empty string if the sensor's name is not known.

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 letters shall be upper-case.
  • Spaces shall not be included.
  • Any extra suffixes that define region codes, package types, temperature range, coatings, grading, colour/monochrome, etc. shall not be included.
  • For colour 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 colour balance parameters to be applied to the Bayer matrix of one-shot colour sensors. Application authors should assume that an appropriate IR cut-off filter is in place for colour 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 and later.

See Also