Click or drag to resize

IVideoSensorName Property

Sensor name.

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

Return Value

Type: String
The name of sensor used within the camera.
Exceptions
ExceptionCondition
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.
PropertyNotImplementedExceptionMust throw exception if not implemented.
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
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 letter 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.

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.

See Also