Zum |
public class ZumJBoxDimLoadBase : BasicDimmingLoad, ILightLoadOverrideControl
The ZumJBoxDimLoadBase type exposes the following members.
| Name | Description | |
|---|---|---|
| CycleDim |
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) | |
| DayLevelValue | Property to set the day level value. This property is not currently supported by ZUMLINK-DIN-16A-LV, ZUMNET-DIN-16A-LV, ZUMLINK-DIN-DIMU and ZUMLINK-DIN-DLI-GROUPS devices. | |
| DayLevelValueFeedback |
Property to report day level value.
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 LoadStateChange event with DayLevelValueFeedbackEventId. | |
| DaylightingGainAdjust | Property to set the day lighting gain adjust. This property is not currently supported by ZUMLINK-DIN-16A-LV, ZUMNET-DIN-16A-LV, ZUMLINK-DIN-DIMU and ZUMLINK-DIN-DLI-GROUPS devices. | |
| DaylightingGainAdjustFeedback |
Property to report day lighting gain adjust.
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 LoadStateChange event with DaylightingGainAdjustFeedbackEventId. | |
| DaylightingIsBusyFeedback |
This property indicates that daylighting is in busy state.
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 LoadStateChange event with DaylightingIsBusyFeedbackEventId. | |
| DaylightingLevelIsChangingFeedback |
This property indicates that daylighting level is changing state.
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 LoadStateChange event with DaylightingLevelIsChangingFeedbackEventId. | |
| DaylightingMinimumLevel | Property to set the day lighting minimum level. This property is not currently supported by ZUMLINK-DIN-16A-LV, ZUMNET-DIN-16A-LV, ZUMLINK-DIN-DIMU and ZUMLINK-DIN-DLI-GROUPS devices. | |
| DaylightingMinimumLevelFeedback |
Property to report day lighting minimum level.
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 LoadStateChange event with DaylightingMinimumLevelFeedbackEventId. | |
| DaylightingOperatingMode | 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. | |
| DaylightingOperatingModeFeedback |
Property to report 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 LoadStateChange event with DaylightingOperatingModeFeedbackEventId. | |
| DaylightingResponseTime | Property to set the day lighting response time. This property is not currently supported by ZUMLINK-DIN-16A-LV, ZUMNET-DIN-16A-LV, ZUMLINK-DIN-DIMU and ZUMLINK-DIN-DLI-GROUPS devices. | |
| DaylightingResponseTimeFeedback |
Property to report day lighting response time.
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 LoadStateChange event with DaylightingResponseTimeFeedbackEventId. | |
| DaylightingSceneIsSavingFeedback |
This property indicates that daylighting scene is in saving state.
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 LoadStateChange event with DaylightingSceneIsSavingFeedbackEventId. | |
| DaylightingSensitivityAdjust | Property to set day lighting sensitivity adjust value. This property is not currently supported by ZUMLINK-DIN-16A-LV, ZUMNET-DIN-16A-LV, ZUMLINK-DIN-DIMU and ZUMLINK-DIN-DLI-GROUPS devices. | |
| DaylightingSensitivityAdjustFeedback |
Property to report day lighting sensitivity adjust.
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 LoadStateChange event with DaylightingSensitivityAdjustFeedbackEventId. | |
| DaylightingSuspend | Property to suspend daylighting. This property is not currently supported by ZUMLINK-DIN-16A-LV, ZUMNET-DIN-16A-LV, ZUMLINK-DIN-DIMU and ZUMLINK-DIN-DLI-GROUPS devices. | |
| DaylightingSyncToPhotoSensor | Property to synchronize the daylighting with the photo sensor. This property is not currently supported by ZUMLINK-DIN-16A-LV, ZUMNET-DIN-16A-LV, ZUMLINK-DIN-DIMU and ZUMLINK-DIN-DLI-GROUPS devices. | |
| DaylightIntercept | Property to set the day light intercept value. | |
| DaylightInterceptFeedback |
Property to report day light intercept values.
This property will trigger LoadStateChange event with DaylightInterceptFeedbackEventId. | |
| DaylightPhotoSensorIn | This property is used to inject the current photo sensor level to perform daylighting. | |
| DaylightSlope | This property is to set the slope of daylighting curve. This value is referenced as a floating point value but entered as a decimal number divided by 1,000. Example: 1.234 is input as 1234. The theoretical limit to this join ranges from 0.0 to 25.000. Valid values range from 0000 to 25000. | |
| DaylightSlopeFeedback |
This property is to return the current slope of daylighting curve.
This property will trigger LoadStateChange event with DaylightSlopeFeedbackEventId. | |
| DayligthIntercept | This property is to set the y-intercept of the daylighting curve. This value is referenced internally as a floating point value but entered as a decimal number divided by 100. Example: 123,400 is input as 1234. The theoretical limit to this join ranges from 100 to 6,553,500. Valid values range from 0d to 65535. | |
| DayligthInterceptFeedback |
This property is to return the current Daylight Intercept.
This property will trigger LoadStateChange event with DayligthInterceptFeedbackEventId. | |
| DayPhotoValue | Property to set the day photo value. This property is not currently supported by ZUMLINK-DIN-16A-LV, ZUMNET-DIN-16A-LV, ZUMLINK-DIN-DIMU and ZUMLINK-DIN-DLI-GROUPS devices. | |
| DayPhotoValueFeedback |
Property to report day photo value.
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 LoadStateChange event with DayPhotoValueFeedbackEventId. | |
| DelayedOffFeedback |
Indicates that a local or slave button press has triggered a delayed fade of the lights to full off.
This property is not supported by ZumNetJBoxDaliGroups and ZumLinkExp16ADimu.
(Inherited from BasicDimmingLoad) | |
| DeviceLoadIsOn |
Property to Get the lighting device this load is on.
(Inherited from DimmingLoad) | |
| DimmerFaultFeedback |
Property to return the load status and errors.
This property will trigger LoadStateChange event with DimmerFaultFeedbackEventId. This property is supported by ZumLinkExp16ADimu class only. | |
| DimmerPhaseMode | This property is to set the dimmer phase mode. This property is supported by ZumLinkExp16ADimu class only. | |
| DimmerPhaseModeFeedback |
Property to return the current dimmer phase mode.
This property will trigger LoadStateChange event with DimmerPhaseModeFeedbackEventId. This property is supported by ZumLinkExp16ADimu class only. | |
| FastFullOnFeedback |
Indicates that a local or slave button press has triggered a fast fade of the lights to full on.
This property is not supported by ZumNetJBoxDaliGroups and ZumLinkExp16ADimu.
(Inherited from BasicDimmingLoad) | |
| InDaylightingCalibrationFeedback |
This property indicates that daylight calibration process started.
This property will trigger LoadStateChange event with InDaylightingCalibrationFeedbackEventId. | |
| InExternalOverrideFeedback |
Indicates if the device is in external override mode.
The OverrideEventHandler event will trigger with External. | |
| InManualOverrideFeedback |
Indicates if the device is in manual override mode.
The OverrideEventHandler event will trigger with Manual. | |
| IsFullOnFeedback |
Indicates that the load is currently at the max level defined by the DimmerMaxLevel parameter.
(Inherited from BasicDimmingLoad) | |
| IsOn |
Indicates that the load is on at any level.
(Inherited from LDimmingLoad) | |
| Level |
Property to set the level of the load.
(Inherited from DimmingLoad) | |
| LevelFeedback |
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) | |
| LoadShedEnable | This property is to enter load into the loadshed state and set the light level to defined value. true: to enter the load into loadshed state; false: to bring the load out of loadshed state. | |
| LoadShedEnabledFeedback |
This property is to indicate that dimmer is in loadshed state.
true: dimmer is in loadshed state: false: dimmer is not in loadshed state.
This property will trigger LoadStateChange event with LoadShedEnabledFeedbackEventId. | |
| LoadShedLevel | This propety is to set the loadshed target level. Minimum is 0 and maximum is 65535. | |
| LoadShedLevelFeedback |
This property reports the load shed target level which is between 0-65535.
This property will trigger LoadStateChange event with LoadShedLevelFeedbackEventId. | |
| Lower |
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) | |
| LowerFeedback |
Indicates that the light level is being lowered due to a local or slave button press.
This property is not supported by ZumLinkJBox16ALv, ZumNetJBox16ALv, ZumLinkExp16ADimu
and ZumNetJBoxDaliGroups.
(Inherited from BasicDimmingLoad) | |
| MaximumLevel | This property is to set maximum range level 55% to 100%. That is 36044-65535. Use PercentToUshort(Single) to convert the percentage to a ushort value or UshortToPercent(UInt16) to convert the ushort value to percentage. | |
| MaximumLevelFeedback |
This property reports the maximum level of the dimmer which is between 36044-65535.
This property will trigger LoadStateChange event with MaximumLevelFeedbackEventId. | |
| MinimumLevel | This property is to set minimum range level 0% to 45%. That is 0-29491. Use PercentToUshort(Single) to convert the percentage to a ushort value or UshortToPercent(UInt16) to convert the ushort value to percentage. | |
| MinimumLevelFeedback |
This property reports the minimum level of the dimmer which is between 0-29491.
This property will trigger LoadStateChange event with MinimumLevelFeedbackEventId. | |
| NightLevelValue | Property to set night level value. This property is not currently supported by ZUMLINK-DIN-16A-LV, ZUMNET-DIN-16A-LV, ZUMLINK-DIN-DIMU and ZUMLINK-DIN-DLI-GROUPS devices. | |
| NightLevelValueFeedback |
Property to report night level value.
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 LoadStateChange event with NightLevelValueFeedbackEventId. | |
| NightPhotoValue | Property to set the night photo value. This property is not currently supported by ZUMLINK-DIN-16A-LV, ZUMNET-DIN-16A-LV, ZUMLINK-DIN-DIMU and ZUMLINK-DIN-DLI-GROUPS devices. | |
| NightPhotoValueFeedback |
Property to report night photo value.
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 LoadStateChange event with NightPhotoValueFeedbackEventId. | |
| Number |
Number of this load.
(Inherited from DimmingLoad) | |
| OffFadeTime | This property is to set the off fade time. Minimum is 0.25 seconds and maximum is 10 seconds. E.g To set to 0.25 seconds the value should be 25. Use the SecondsToUshort(Single) to convert the seconds to a ushort value or the UshortToSeconds(UInt16) to convert the ushort value to seconds. | |
| OffFadeTimeFeedback |
This property reports the off fade time of the dimmer which is between 0.25 seconds to 10 seconds.
E.g Value is 25 to represent the 0.25 seconds.
Use the SecondsToUshort(Single) to convert
the seconds to a ushort value or the UshortToSeconds(UInt16) to convert
the ushort value to seconds.
This property will trigger LoadStateChange event with OffFadeTimeFeedbackEventId. | |
| OffFeedback |
Indicates that the lights have faded to full off (0%) due to a local or slave button press.
This property is not supported by ZumNetJBoxDaliGroups and ZumLinkExp16ADimu.
(Inherited from BasicDimmingLoad) | |
| OnFadeTime | This property is to set the on fade time. Minimum is 0.25 seconds and maximum is 10 seconds. E.g To set to 0.25 seconds the value should be 25. Use the SecondsToUshort(Single) to convert the seconds to a ushort value or the UshortToSeconds(UInt16) to convert the ushort value to seconds. | |
| OnFadeTimeFeedback |
This property reports the on fade time of the dimmer which is between 0.25 seconds to 10 seconds.
E.g Value is 25 to represent the 0.25 seconds.
Use the SecondsToUshort(Single) to convert
the seconds to a ushort value or the UshortToSeconds(UInt16) to convert
the ushort value to seconds.
This property will trigger LoadStateChange event with OnFadeTimeFeedbackEventId. | |
| OverrideLevel | This propety is to set the override target level. Minimum is 0 and maximum is 65535. | |
| OverrideLevelFeedback |
This property reports the override target level which is between 0-65535.
This property will trigger LoadStateChange event with OverrideLevelFeedbackEventId. | |
| Parent |
The parent that a this load is added to.
(Inherited from LightLoad) | |
| PresetFadeTime | This property is to set the preset fade time. Minimum is 0.25 seconds and maximum is 10 seconds. E.g To set to 0.25 seconds the value should be 25. Use the SecondsToUshort(Single) to convert the seconds to a ushort value or the UshortToSeconds(UInt16) to convert the ushort value to seconds. | |
| PresetFadeTimeFeedback |
This property reports the preset fade time of the dimmer which is between 0.25 seconds to 10 seconds.
E.g Value is 25 to represent the 0.25 seconds.
Use the SecondsToUshort(Single) to convert
the seconds to a ushort value or the UshortToSeconds(UInt16) to convert
the ushort value to seconds.
This property will trigger LoadStateChange event with PresetFadeTimeFeedbackEventId. | |
| Presets |
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) | |
| Raise |
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) | |
| RaiseFeedback |
Indicates that the light level is being raised due to a local or slave button press.
This property is not supported by ZumLinkJBox16ALv, ZumNetJBox16ALv,
ZumLinkExp16ADimu and ZumNetJBoxDaliGroups.
(Inherited from BasicDimmingLoad) | |
| RaiseLowerRate | This property is to set the raise lower rate. Minimum is 0.25 seconds and maximum is 10 seconds. E.g To set to 0.25 seconds the value should be 25. Use the SecondsToUshort(Single) to convert the seconds to a ushort value or the UshortToSeconds(UInt16) to convert the ushort value to seconds. | |
| RaiseLowerRateFeedback |
This property reports the raise lower rate of the dimmer which is between 0.25 seconds to 10 seconds.
E.g Value is 25 to represent the 0.25 Seconds
Use the SecondsToUshort(Single) to convert
the seconds to a ushort value or the UshortToSeconds(UInt16) to convert
the ushort value to seconds.
This property will trigger LoadStateChange event with RaiseLowerRateFeedbackEventId. | |
| SceneActiveFeedback |
This property is to indicate that the desired saved scene level. (This will be for scene X = 1 to 17)
This property will trigger LoadStateChange event with SceneActiveFeedbackEventId. | |
| SceneLevel | This property sets the custom scene level from 0 to 100 percentage. Scene is from 1 to 17. Use PercentToUshort(Single) to convert the percentage to a ushort value or UshortToPercent(UInt16) to convert the ushort value to percentage | |
| SceneLevelFeedback |
This property reports the scene level setting during device update request. Scene is from 1 to 17.
Use PercentToUshort(Single) to convert
the percentage to a ushort value or UshortToPercent(UInt16) to convert
the ushort value to percentage
This property will trigger LoadStateChange event with SceneLevelFeedbackEventId. | |
| SceneSetUnaffected | This property is to set bitmask of scenes that are not affected when scene recall is triggered. | |
| SceneUnaffectedFeedback |
This property reports the bitmask of scenes that are not affected when scene recall is triggered.
This property will trigger LoadStateChange event with SceneUnaffectedFeedbackEventId. | |
| Type |
Type of load this object represents.
(Inherited from DimmingLoad) | |
| UserSpecifiedObject |
Object holder for any use by the programmer.
(Inherited from LightLoad) | |
| ZeroCrossMode | This property is to set the dimmer zero cross mode. This property is supported by ZumLinkExp16ADimu class only. | |
| ZeroCrossModeFeedback |
Property to report the dimmer's Zero Cross mode.
This property will trigger LoadStateChange event with ZeroCrossModeFeedbackEventId. This property is supported by ZumLinkExp16ADimu class only. |
| Name | Description | |
|---|---|---|
| ActivateScene | This method triggers the load to ramp to the desired saved scene levels. (This will be for scene X = 1 to 17) | |
| CurrentPresetRecalled |
Indicates that the specified preset has been recalled due to a local or slave button press.
(Inherited from BasicDimmingLoad) | |
| DaylightingSaveCurveData | This method saves daylighting curve data. This method is not currently supported by ZUMLINK-DIN-16A-LV, ZUMNET-DIN-16A-LV, ZUMLINK-DIN-DIMU and ZUMLINK-DIN-DLI-GROUPS devices. | |
| DaylightingSaveScene | This method saves the day lighting scene. This method is not currently supported by ZUMLINK-DIN-16A-LV, ZUMNET-DIN-16A-LV, ZUMLINK-DIN-DIMU and ZUMLINK-DIN-DLI-GROUPS devices. | |
| DaylightingStartCalibration | This method starts the daylighting calibration process. | |
| DelayedOff |
Trigger a delayed fade of the lights to full off.
This property is not supported by ZumNetJBoxDaliGroups and ZumLinkExp16ADimu.
(Inherited from BasicDimmingLoad) | |
| EnterManualOverride | Enter manual override mode | |
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object) | |
| ExitManualOverride | Exit manual override mode | |
| FastFullOff |
The light level will ramp from its current level to 0% in 0.25s.
(Inherited from BasicDimmingLoad) | |
| FastFullOn |
The light level will ramp from its current level to the max level in 0.25s.
(Inherited from BasicDimmingLoad) | |
| Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object) | |
| FullOff |
Method to set the level to zero.
This method is not supported by "ClsC6" and "ClsC6M" devices.
(Inherited from DimmingLoad) | |
| FullOn |
Method to set the level to maximum.
This method is not supported by "ClsC6" and "ClsC6M" devices.
(Inherited from DimmingLoad) | |
| GetHashCode | Serves as the default hash function. (Inherited from Object) | |
| GetType | Gets the Type of the current instance. (Inherited from Object) | |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object) | |
| PresetLoadIsAt |
Indicates that the load is at the corresponding preset level.
(Inherited from BasicDimmingLoad) | |
| ToString |
String representation of this light load.
(Inherited from LightLoad) |
| Name | Description | |
|---|---|---|
| OverrideEventHandler |
Event triggered when the ZumJBoxDimLoad reports Override sig information to the Control System.
Valid event IDs are available in eOverrideEvents. | |
| PresetChange |
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) |
| Name | Description | |
|---|---|---|
| _DeviceForThisLoad |
Internal reference to the actual device this load is on.
(Inherited from BasicDimmingLoad) |