Hz |
This class will trigger BaseEvent event.
public sealed class Hz2BackLightLedSettings : IParentInformation
The Hz2KpBaseHz2BackLightLedSettings type exposes the following members.
| Name | Description | |
|---|---|---|
| AmbientLightLevelFeedback |
Property to report the current ambient light level scaled from 0% to 100% (0-65535).
This property is only enabled when ReportLightLevel value is set to true.
Use PercentToUshort(Single) to convert
the percentage to a ushort value or UshortToPercent(UInt16) to convert
the ushort value to percentage.
The BaseEvent event will trigger with AmbientLightLevelFeedbackEventId. | |
| ButtonAlternateFeedback | Button Alternate Feedbacks collection. The index in this collection corresponds to items of Feedbacks. Setting to 'true' enables the alternate color theme for the selected feedback. The alternate color theme is set using SetAlternateColorSelectPosition(UInt32, Hz2KpBaseeLedAlternateColorTheme). Setting to 'false' will cause the selected feedback to use the LocalColorThemeFeedback. | |
| ColorThemeSelectOverride |
Property to override the locally saved setting color theme. This setting is lost on power cycle of the device.
This property is not supported for Cresnet Keypads. | |
| CustomDayOffCct | Property to indicate the custom day off correlated color temperature. | |
| CustomDayOnCct | Property to indicate the custom day on Correlated Color Temperature. | |
| CustomNightOffCct | Property to indicate the night day off correlated color temperature. | |
| CustomNightOnCct | Property to indicate the custom night on correlated color temperature. | |
| EnableManualDayNightTime | Setting it to true disables the automatic backlight control and does not use the internal ambient light sensor. The backlight is in full manual control using EnableDayTime or EnableNightTime methods to switch between day and night modes and ManualDayOnBrightness, ManualDayOffBrightness, ManualNightOnBrightness or ManualNightOffBrightness properties to set the backlight intensity. When the property value is false, the unit will use the internal light sensor to automatically adjust the backlight intensity. true = Manual backlight adjustment; false = Auto backlight adjustment | |
| InDayTimeFeedback |
Property to indicate that the unit is operating in Day Time mode.
The BaseEvent event will trigger with InDayTimeEventId. true = Device day time mode is enabled; false = Device in an inconclusive or invalid state. | |
| InNightTimeFeedback |
Property to indicate that the unit is operating in Night Time mode.
The BaseEvent event will trigger with InNightTimeEventId. true = Device night time mode is enabled; false = Device in an inconclusive or invalid state. | |
| LedDayOffSettings | LED Day Off Settings present on this device | |
| LedDayOnSettings | LED Day On Settings present on this device | |
| LedNightOffSettings | LED Night Off Settings present on this device | |
| LedNightOnSettings | LED Night On Settings present on this device | |
| LightSensorCalibratedFeedback |
Property to report if the unit has been calibrated before.
The BaseEvent event will trigger with LightSensorCalibratedEventId. | |
| LocalColorThemeFeedback |
Property to report the locally set color theme.
The BaseEvent event will trigger with LocalColorThemeFeedbackEventId. | |
| ManualDayOffBrightness | Property to set the brightness of the DayOff LEDs. A value set to this property overrides any default brightness settings applied to the DayOff LEDs. | |
| ManualDayOnBrightness | Property to set the brightness of the DayOn LEDs. A set to this property overrides any default brightness settings applied to the DayOn LEDs. | |
| ManualNightOffBrightness | Property to set the brightness of the NightOff LEDs. A value set to this property overrides any default brightness settings applied to the NightOff LEDs. | |
| ManualNightOnBrightness | Property to set the brightness of the NightOn LEDs. A value set to this property overrides any default brightness settings applied to the NightOn LEDs. | |
| MaximumAlternateColorSelectionPositions | Property to indicate the maximum positions supported by method SetAlternateColorSelectPosition(UInt32, Hz2KpBaseeLedAlternateColorTheme) and property GetAlternateColorSelectPosition(UInt32). Returns '0' if the color selection positions are not applicable. | |
| Parent | The parent that a this load is added to. | |
| ReportDayNightTimeFeedbacks | Setting this property to true allows the device to send out the InDayTimeFeedback and InNightTimeFeedback properties upon changing states. Setting this property value to false prevents the InDayTimeFeedback and InNightTimeFeedback properties from updating. true = Enable day and night time reporting; false = Disable day and night time reporting. | |
| ReportLightLevel | Setting this property value to true allows the device to send out the current analog value of the ambient light sensor through the AmbientLightLevelFeedback property. Setting this property value to false prevents the AmbientLightLevelFeedback from updating. | |
| TunableWhiteThemeCct | Property to indicate tunable white theme correlated color temperature. | |
| UserSpecifiedObject | Object holder for any use by the programmer. |
| Name | Description | |
|---|---|---|
| CalibrateLightSensor | Method to start the 'auto' calibration of ambient light sensor and choose the proper day/night threshold 'default' setting. | |
| EnableDayTime | Method to enable Day Time mode as operating mode on the unit. | |
| EnableNightTime | Method to enable Night Time mode as operating mode on the unit. | |
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object) | |
| GetAlternateColorSelectPosition | Property to get the current alternate color theme for a specified postion on keypad, max index supported is MaximumAlternateColorSelectionPositions | |
| GetHashCode | Serves as the default hash function. (Inherited from Object) | |
| GetType | Gets the Type of the current instance. (Inherited from Object) | |
| SetAlternateColorSelectPosition | Method to set the alternate color for a specified postion on keypad, max index supported is MaximumAlternateColorSelectionPositions. | |
| ToString | Returns a string that represents the current object. (Inherited from Object) |