Click or drag to resize

ZumJBoxSwitchLoadBase Class

This is base class for ZumJBoxPlugLoad and ZumJBoxSwitchLoad.

This class will trigger BaseEvent, OverrideEventHandler events, whenever there is a External or Manual override feedback.

Inheritance Hierarchy

Namespace: Crestron.SimplSharpPro.Lighting.ZumWired
Assembly: Crestron.SimplSharpPro.Lighting (in Crestron.SimplSharpPro.Lighting.dll) Version: 2.21.121
Syntax
C#
public class ZumJBoxSwitchLoadBase : SwitchedLoad, 
	ILightLoadOverrideControl

The ZumJBoxSwitchLoadBase type exposes the following members.

Properties
 NameDescription
Public propertyDebugFeedback Property to display debug messages related to fault conditions. This property is supported by GL-EXP-SW-CN device only.

The LoadStateChange event will trigger with SerialDebugFeedbackEventId.


(Inherited from SwitchedLoad)
Public propertyDeviceLoadIsOn Property to Get the lighting device this load is on.
(Inherited from SwitchedLoad)
Public propertyErrorFeedback Property to display Load status and errors: Valid values: 0x0000 = Normal This property is supported by GL-EXP-SW-CN device and Horizon EX Swtiches.

The LoadStateChange event will trigger with ErrorEventId.


(Inherited from SwitchedLoad)
Public propertyInExternalOverrideFeedback Indicates if the device is in external override mode. True = In external override; False = External override released This property is not supported by ZumLinkDtQuattroDlsRly, ZumLinkIrQuattroDlsRly, ZumLinkIrQuattroHdDlsRly, ZumLinkUsHallwayDlsRly, ZumLinkUsOnewayDlsRly and ZumLinkUsQuattroDlsRly devices.

The OverrideEventHandler event will trigger with External.

Public propertyInManualOverrideFeedback Indicates if the device is in manual override mode. True = In manual override; False = Manual override released This property is not supported by ZumLinkDtQuattroDlsRly, ZumLinkIrQuattroDlsRly, ZumLinkIrQuattroHdDlsRly, ZumLinkUsHallwayDlsRly, ZumLinkUsOnewayDlsRly, ZumLinkUsQuattroDlsRly, ZumLinkJbox20APlug and "ZumNetJBoxDaliGroups" and "ZumNetDinDaliGroups" devices.

The OverrideEventHandler event will trigger with Manual.

Public propertyIsOn Property to determine if the load is on.

The LoadStateChange event will trigger with IsOnEventId.


(Inherited from SwitchedLoad)
Public propertyLoadShedEnable 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.
Public propertyLoadShedEnabledFeedback 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.

Public propertyLoadshedLevel This property sets the loadshed level to defined value.
Public propertyLoadshedLevelFeedback This property reports Load shed level feedback.

This property will trigger LoadStateChange with LoadShedLevelFeedbackEventId.

Public propertyNumber Number of this load.
(Inherited from SwitchedLoad)
Public propertyOverrideDisabledFeedbackObsolete.
This property is to indicate that override mode is disabled. True: relay ignores the override mode: False: relay override mode is enabled.

This property will trigger LoadStateChange event with OverrideDisabledEventId.

Public propertyOverrideLevel This property sets the Override level to defined value. This property is not supported by ZumLinkDtQuattroDlsRly, ZumLinkIrQuattroDlsRly, ZumLinkIrQuattroHdDlsRly, ZumLinkUsHallwayDlsRly, ZumLinkUsOnewayDlsRly, ZumLinkUsQuattroDlsRly, ZumLinkJbox20APlug and "ZumNetJBoxDaliGroups" and "ZumNetDinDaliGroups" devices.
Public propertyOverrideLevelFeedback This property reports override level feedback. This property is not supported by ZumLinkDtQuattroDlsRly, ZumLinkIrQuattroDlsRly, ZumLinkIrQuattroHdDlsRly, ZumLinkUsHallwayDlsRly, ZumLinkUsOnewayDlsRly, ZumLinkUsQuattroDlsRly, ZumLinkJbox20APlug and "ZumNetJBoxDaliGroups" and "ZumNetDinDaliGroups" devices.

This property will trigger LoadStateChange with OverrideLevelFeedbackEventId.

Public propertyParent The parent that a this load is added to.
(Inherited from LightLoad)
Public propertyType Type of load this object represents.
(Inherited from SwitchedLoad)
Public propertyUserSpecifiedObject Object holder for any use by the programmer.
(Inherited from LightLoad)
Top
Methods
 NameDescription
Public methodDisableOverrideObsolete.
Method to disable override.
Public methodEnableOverrideObsolete.
Method to enable override.
Public methodEnterManualOverride Enter manual override mode. This method is not supported by ZumLinkDtQuattroDlsRly, ZumLinkIrQuattroDlsRly, ZumLinkIrQuattroHdDlsRly, ZumLinkUsHallwayDlsRly, ZumLinkUsOnewayDlsRly, ZumLinkUsQuattroDlsRly, ZumLinkJbox20APlug and "ZumNetJBoxDaliGroups" and "ZumNetDinDaliGroups" devices.
Public methodEqualsDetermines whether the specified object is equal to the current object.
(Inherited from Object)
Public methodExitManualOverride Exit manual override mode. This method is not supported by ZumLinkDtQuattroDlsRly, ZumLinkIrQuattroDlsRly, ZumLinkIrQuattroHdDlsRly, ZumLinkUsHallwayDlsRly, ZumLinkUsOnewayDlsRly, ZumLinkUsQuattroDlsRly, ZumLinkJbox20APlug and "ZumNetJBoxDaliGroups" and "ZumNetDinDaliGroups" devices.
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 turn the load off.
(Inherited from SwitchedLoad)
Public methodFullOn Method to turn the load on.
(Inherited from SwitchedLoad)
Public methodGetHashCodeServes as the default hash function.
(Inherited from Object)
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 eventOverrideEventHandler Event to attach override event handlers
Top

Version Information

.NET

Supported in: 6.0

.NET Compact Framework

Supported in: 3.5
See Also