Click or drag to resize

ZumPhotoSensor Class

This is Photo Sensor Class for Zum Wired JBox devices.

This class will trigger PhotoSensorChange event.

Inheritance Hierarchy
SystemObject
  Crestron.SimplSharpPro.Lighting.ZumWiredZumPhotoSensor

Namespace: Crestron.SimplSharpPro.Lighting.ZumWired
Assembly: Crestron.SimplSharpPro.Lighting (in Crestron.SimplSharpPro.Lighting.dll) Version: 2.21.121
Syntax
C#
public sealed class ZumPhotoSensor : IParentInformation

The ZumPhotoSensor type exposes the following members.

Properties
 NameDescription
Public propertyCalibrationModeEnable This property will trigger the device to calibrate the sun/room photo thresholds.

True = Calibration Mode is enabled ; False = Calibration Mode is disabled

This property is not supported by ZUMLINK-JBOX-IO.
Public propertyCalibrationReportPeriod Property to set the interval between reported levels when the CalibrationModeEnable property value is set to true.

Value is defined to be units of 10 milliseconds.

Valid input range is from 10 to 1000 (100 milliseconds to 10.0 seconds), default = 50 (0.5 seconds).

This property is not supported by ZUMLINK-JBOX-IO and ZUMLINK-DIN-IO.
Public propertyCalibrationReportPeriodFeedback Property to report the maximum rate that photo sensor reading values will be reported when the CalibrationModeEnable property value is set to true.

Value is defined to be units of 10 milliseconds.

Valid input range is from 10 to 1000 (100 milliseconds to 10.0 seconds), default = 50 (0.5 seconds).

This property will trigger PhotoSensorChange event with CalibrationReportPeriodFeedbackEventId.

This property is not supported by ZUMLINK-JBOX-IO and ZUMLINK-DIN-IO.
Public propertyCustomReportPeriod Property to set the custom reporting period, sensor reports it state after this period.
Public propertyCustomReportPeriodEnabledFeedback Property to indicate if the custom report is enabled or not. This property is not currently supported by ZUMLINK-DIN-16A-LV, ZUMNET-DIN-16A-LV, ZUMLINK-DIN-DIMU and ZUMLINK-DIN-DLI-GROUPS devices.

This property will trigger PhotoSensorChange event with CustomReportPeriodEnabledFeedbackEventId.

Public propertyCustomReportPeriodFeedback Property to reprot the current custom reporting period. This property is not currently supported by ZUMLINK-DIN-16A-LV, ZUMNET-DIN-16A-LV, ZUMLINK-DIN-DIMU and ZUMLINK-DIN-DLI-GROUPS devices.

This property will trigger PhotoSensorChange event with CustomReportPeriodFeedbackEventId.

Public propertyDaylightingOperatingMode Property to set the day lighting operating mode. This property is not currently supported by ZUMLINK-DIN-16A-LV, ZUMNET-DIN-16A-LV, ZUMLINK-DIN-DIMU and ZUMLINK-DIN-DLI-GROUPS devices.
Public propertyDaylightingOperatingModeFeedback Property to set the day lighting operating mode. This property is not currently supported by ZUMLINK-DIN-16A-LV, ZUMNET-DIN-16A-LV, ZUMLINK-DIN-DIMU and ZUMLINK-DIN-DLI-GROUPS devices.

This property will trigger PhotoSensorChange event with DaylightingOperatingModeFeedbackEventId.

Public propertyInCalibarationModeFeedback Property to report that photo sensor is in calibaration mode or not. This property is not supported by ZumNetJBoxDaliGroups.

True = Photo sensor in Calibration Mode; False = Photo sensor not in Calibration Mode.

This property will trigger PhotoSensorChange event with InCalibarationModeFeedbackEventId.

This property is not supported by ZUMLINK-JBOX-IO and ZUMLINK-DIN-IO.
Public propertyParent The parent that a ZumPhotoSensor object was added to.
Public propertyPhotoSensorLevelFeedback Property to report the internal photo sensor value. The valid range is from 0 to 100 percent.

Use "SimplSharpDeviceHelper.PercentToUshort" to convert the percentage to a ushort value or "SimplSharpDeviceHelper.UshortToPercent" to convert

the ushort value to percentage.

This property will trigger PhotoSensorChange event with PhotoSensorLevelFeedbackEventId.

This property is not supported by ZUMLINK-JBOX-IO and ZUMLINK-DIN-IO.
Public propertyPhotoSensorMinChange Property to set the minimum change that the photo sensor must sense before quickly reporting a new value. A value of 0 or not connected will use the default.

The mininimum change of the device is 500 (1% of the full scale). For any value less than 500, the value 500 will be used. Valid values range from 0 to 65535.

This property is not supported by ZUMLINK-JBOX-IO and ZUMLINK-DIN-IO.
Public propertyPhotoSensorMinimumChangeObsolete.
Property to set the minimum change that the photo sensor must sense before quickly reporting a new value. A value of 0 or not connected will use the default. The mininimum change of the device is 635(1% of the full scale). For any value less than 635, the value 635 will be used. Valid values range from 0 to 65535. This property is not supported by ZUMLINK-JBOX-IO and ZUMLINK-DIN-IO.
Public propertyPhotoSensorMinimumChangeFeedback Property to report the minimum change that the photo sensor must sense before quickly reporting a new value.A value of 0 or not connected will use the default.

The default mininimum change of the device is 500 (1% of the full scale). Valid values range from 0 to 65535.

This property will trigger PhotoSensorChange event with PhotoSensorMinimumChangeFeedbackEventId.

This property is not supported by ZUMLINK-JBOX-IO and ZUMLINK-DIN-IO.
Public propertyUserSpecifiedObject Can be assigned anything that user wants.
Top
Methods
 NameDescription
Public methodDisableCustomReportPeriod Method to disable custom report period. This method is not currently supported by ZUMLINK-DIN-16A-LV, ZUMNET-DIN-16A-LV, ZUMLINK-DIN-DIMU and ZUMLINK-DIN-DLI-GROUPS devices.
Public methodEnableCalibrationModeObsolete.
This method will trigger the device to calibrate the sun/room photo thresholds. This property is not supported by ZUMLINK-JBOX-IO and ZUMLINK-DIN-IO.
Public methodEnableCustomReportPeriod Method to enable the custom report period. This method is not currently supported by ZUMLINK-DIN-16A-LV, ZUMNET-DIN-16A-LV, ZUMLINK-DIN-DIMU and ZUMLINK-DIN-DLI-GROUPS devices.
Public methodEqualsDetermines whether the specified object is equal to the current object.
(Inherited from Object)
Public methodGetHashCodeServes as the default hash function.
(Inherited from Object)
Public methodGetTypeGets the Type of the current instance.
(Inherited from Object)
Public methodToStringReturns a string that represents the current object.
(Inherited from Object)
Top
Events
 NameDescription
Public eventPhotoSensorChange Event triggered when a feedback has changed for this ZumPhotoSensor.
Top

Version Information

.NET

Supported in: 6.0

.NET Compact Framework

Supported in: 3.5
See Also