Click or drag to resize

HzDimLVLoad Class

Low Voltage Horizon Dimming Load
Inheritance Hierarchy

Namespace: Crestron.SimplSharpPro.Lighting.Horizon
Assembly: Crestron.SimplSharpPro.Lighting (in Crestron.SimplSharpPro.Lighting.dll) Version: 2.21.121
Syntax
C#
public class HzDimLVLoad : HzBaseDimmingLoad

The HzDimLVLoad type exposes the following members.

Constructors
 NameDescription
Public methodHzDimLVLoadInitializes a new instance of the HzDimLVLoad class
Top
Properties
 NameDescription
Public propertyCycleDim Toggles between a raise and lower operation as follows: If load is Off or at the Min level, the load will raise. If load is at the Max level, the load will lower. At any other level, the load will change in the opposite direction of the last ramp (see raise/lower descriptions).
(Inherited from LDimmingLoad)
Public propertyDeviceLoadIsOn Property to Get the lighting device this load is on.
(Inherited from DimmingLoad)
Public propertyDimmingCurve Property to set the custom dimming curve. This is a serial string formatted to represent a custom dimming curve with a max of 32 points.
(Inherited from HzBaseDimmingLoad)
Public propertyDimmingCurveFeedback Property to return the current dimming curve for the load.

GetLoadDimmingCurve method is used to query the device for the latest dimming curve for the load.

The LoadStateChange event will trigger with CurrentDimmingCurveFeedbackEventId.


(Inherited from HzBaseDimmingLoad)
Public propertyErrorFeedback Load error information.

The LoadStateChange event will trigger with ErrorEventId.


(Inherited from HzBaseDimmingLoad)
Public propertyFastFullOnFeedback Property to return the current load fast full button press state.

True: The load fast full on button is pressed.

False: The load fast full on button is not pressed.

This property is supported by the HZ2-DIMEX, HZ2-DIMLVEX, and HZ2-DIMUEX.

This property is supported by the HZ-DIMEX, HZ-DIMLVEX, and HZ-DIMUEX running firmware v2.000.0050 and later.

The LoadStateChange event will trigger with FastFullOnPressEventId and FastFullOnReleaseEventId.


(Inherited from HzBaseDimmingLoad)
Public propertyFastOffFeedback Property to return the current load fast off button press state.

True: The load fast off button is pressed.

False: The load fast off button is not pressed.

This property is supported by the HZ2-DIMEX, HZ2-DIMLVEX, and HZ2-DIMUEX.

This property is supported by the HZ-DIMEX, HZ-DIMLVEX, and HZ-DIMUEX running firmware v2.000.0050 and later.

The LoadStateChange event will trigger with FastOffPressEventId and FastOffReleaseEventId.


(Inherited from HzBaseDimmingLoad)
Public propertyFullOnFeedback Property to return the current load full on button press state.

True: The load full on button is pressed.

False: The load full on button is not pressed.

This property is supported by the HZ2-DIMEX, HZ2-DIMLVEX, and HZ2-DIMUEX.

This property is supported by the HZ-DIMEX, HZ-DIMLVEX, and HZ-DIMUEX running firmware v2.000.0050 and later.

The LoadStateChange event will trigger with FullOnPressEventId and FullOnReleaseEventId.


(Inherited from HzBaseDimmingLoad)
Public propertyIsFullOnFeedback Indicates that the load is currently at the max level defined by the ParameterMaxLevel parameter.

The LoadStateChange event will trigger with IsFullOnEventId.


(Inherited from HzBaseDimmingLoad)
Public propertyIsOn Indicates that the load is on at any level.
(Inherited from LDimmingLoad)
Public propertyLevel Property to set the level of the load.
(Inherited from DimmingLoad)
Public propertyLevelFeedback Property to get the level of the load when it changes due to a local buttons press, or a input such as Raise or Lower. This will not change in response to a value being set by the Level property.
(Inherited from DimmingLoad)
Public propertyLoadIsAttached Indicates that a physical load is attached. This property is not supported by the Horizon Dimmers HzBaseDimmingLoad and will always return true.
(Inherited from ClwLDimLoad)
Public propertyLower Smoothly lowers the light level from its current level to the min level for as long as the property is set 'true'. The ramping operation continues until the light reaches the min level or until the property is set 'false'.
(Inherited from LDimmingLoad)
Public propertyLowerFeedback Property to return the current load lower button state.

True: The load lower button is pressed.

False: The load lower button is not pressed.

There is a pause for 1 sec at the 1% point before load full turns off.

This property is supported by the HZ2-DIMEX, HZ2-DIMLVEX, and HZ2-DIMUEX.

This property is supported by the HZ-DIMEX, HZ-DIMLVEX, and HZ-DIMUEX running firmware v2.000.0050 and later.

The LoadStateChange event will trigger with LowerPressEventId and LowerReleaseEventId.


(Inherited from HzBaseDimmingLoad)
Public propertyNonDimmingModeFeedback Indicates that the unit has been set to non-dim mode.
(Inherited from ClwLDimLoad)
Public propertyNumber Number of this load.
(Inherited from DimmingLoad)
Public propertyOffFeedback Property to return the current off button press state.

True: The load off button is pressed.

False: The load off button is not pressed.

This property is supported by the HZ2-DIMEX, HZ2-DIMLVEX, and HZ2-DIMUEX.

This property is supported by the HZ-DIMEX, HZ-DIMLVEX, and HZ-DIMUEX running firmware v2.000.0050 and later.

The LoadStateChange event will trigger with OffPressEventId and OffReleaseEventId.


(Inherited from HzBaseDimmingLoad)
Public propertyParameterDimmerCurvePreset Parameter to select a preset dimming curve or a custom curve. Default value is Linear.
(Inherited from HzBaseDimmingLoad)
Public propertyParameterDimmerOperatingMode Parameter to select the load's operating mode.

There is no default value this parameter needs to be set.

Public propertyParameterMaxLevel Set the maximum dim level for full on and raise operations.

Valid values range from 55% to 100%. Default of 100%.

Use PercentToUshort(Single) to convert the percentage to a ushort value or UshortToPercent(UInt16) to convert the ushort value to percentage.


(Inherited from ClwLDimLoad)
Public propertyParameterMinLevel Set the minimum dim level for the lower operations.

Valid values range from 0% to 45%. Default of 0%.

Use PercentToUshort(Single) to convert the percentage to a ushort value or UshortToPercent(UInt16) to convert the ushort value to percentage.


(Inherited from ClwLDimLoad)
Public propertyParent The parent that a this load is added to.
(Inherited from LightLoad)
Public propertyPresets Collection of the presets available on this load. This property is not supported by "ClsC6", "ClsC6M", Horizon dimmers, "ZumNetJBoxDaliGroups" and all ZUM devices with loads.
(Inherited from DimmingLoad)
Public propertyRaise Smoothly raises the light level from its current level to 100% (max level) for as long as the property is set 'true'. The ramping operation continues until the light reaches 100% (max level) or until the property is set 'false'.
(Inherited from LDimmingLoad)
Public propertyRaiseFeedback Property to return the current load raise button state.

True: The load raise button is pressed.

False: The load raised button is not pressed.

This property is supported by the HZ2-DIMEX, HZ2-DIMLVEX, and HZ2-DIMUEX.

This property is supported by the HZ-DIMEX, HZ-DIMLVEX, and HZ-DIMUEX running firmware v2.000.0050 and later.

The LoadStateChange event will trigger with RaisePressEventId and RaiseReleaseEventId.


(Inherited from HzBaseDimmingLoad)
Public propertyType Type of load this object represents.
(Inherited from DimmingLoad)
Public propertyUserSpecifiedObject Object holder for any use by the programmer.
(Inherited from LightLoad)
Top
Methods
 NameDescription
Public methodEqualsDetermines whether the specified object is equal to the current object.
(Inherited from Object)
Public methodFastFullOff The light level will ramp from its current level to 0% in 0.25s.
(Inherited from HzBaseDimmingLoad)
Public methodFastFullOn The light level will ramp from its current level to the max level in 0.25s.
(Inherited from HzBaseDimmingLoad)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object)
Public methodFullOff Method to set the level to zero. This method is not supported by "ClsC6" and "ClsC6M" devices.
(Inherited from DimmingLoad)
Public methodFullOn Method to set the level to maximum. This method is not supported by "ClsC6" and "ClsC6M" devices.
(Inherited from DimmingLoad)
Public methodGetHashCodeServes as the default hash function.
(Inherited from Object)
Public methodGetLoadDimmingCurve Method to get the dimming curve for the load.

This method is used to query the device for the latest dimming curve for the load.


(Inherited from HzBaseDimmingLoad)
Public methodGetTypeGets the Type of the current instance.
(Inherited from Object)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object.
(Inherited from Object)
Public methodToString String representation of this light load.
(Inherited from LightLoad)
Top
Events
 NameDescription
Public eventPresetChange Event to indicate when preset information is received from the load. This event is not supported by "ClsC6" and "ClsC6M", Horizon dimmers, "ZumNetJBoxDaliGroups" all ZUM devices with loads.
(Inherited from DimmingLoad)
Top

Version Information

.NET

Supported in: 6.0

.NET Compact Framework

Supported in: 3.5
See Also