Zum |
public class ZumJBoxPlugLoadBase : ZumJBoxSwitchLoadBase
The ZumJBoxPlugLoadBase type exposes the following members.
| Name | Description | |
|---|---|---|
| DebugFeedback |
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) | |
| DeviceLoadIsOn |
Property to Get the lighting device this load is on.
(Inherited from SwitchedLoad) | |
| ErrorFeedback |
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) | |
| InExternalOverrideFeedback |
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. (Inherited from ZumJBoxSwitchLoadBase) | |
| InManualOverrideFeedback |
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. (Inherited from ZumJBoxSwitchLoadBase) | |
| IsOn |
Property to determine if the load is on.
The LoadStateChange event will trigger with IsOnEventId. (Inherited from SwitchedLoad) | |
| 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.
(Inherited from ZumJBoxSwitchLoadBase) | |
| 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. (Inherited from ZumJBoxSwitchLoadBase) | |
| LoadshedLevel |
This property sets the loadshed level to defined value.
(Inherited from ZumJBoxSwitchLoadBase) | |
| LoadshedLevelFeedback |
This property reports Load shed level feedback.
This property will trigger LoadStateChange with LoadShedLevelFeedbackEventId. (Inherited from ZumJBoxSwitchLoadBase) | |
| Number |
Number of this load.
(Inherited from SwitchedLoad) | |
| OverrideDisabledFeedback | Obsolete. 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. (Inherited from ZumJBoxSwitchLoadBase) | |
| OverrideLevel |
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.
(Inherited from ZumJBoxSwitchLoadBase) | |
| OverrideLevelFeedback |
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. (Inherited from ZumJBoxSwitchLoadBase) | |
| Parent |
The parent that a this load is added to.
(Inherited from LightLoad) | |
| SceneActiveFeedback |
This property is to indicate that the desired saved scene level. (This will be for scene X = 1 to 16)
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 16. 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 16.
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. A 16-bit mask value that corresponds to all 16 scenes supported on the load, where each bit value of 1 un-assigns that scene from triggering the load during a scene recall. Example Value = 12 or 0x0C indicates that scenes 3 and 4 are not recalled on this load when either "ActivateScene(3)" or "ActivateScene(4)" are recalled. Valid value range is 0 to 65535. | |
| SceneUnaffectedFeedback |
This property reports the bitmask of scenes that are not affected when scene recall is triggered.
Valid values range from 0 to 65535.
This property will trigger LoadStateChange event with SceneUnaffectedFeedbackEventId. | |
| Type |
Type of load this object represents.
(Inherited from SwitchedLoad) | |
| UserSpecifiedObject |
Object holder for any use by the programmer.
(Inherited from LightLoad) |
| Name | Description | |
|---|---|---|
| ActivateScene | This method triggers the load to ramp to the desired saved scene levels. (This will be for scene X = 1 to 16) | |
| DisableOverride | Obsolete. Method to disable override. (Inherited from ZumJBoxSwitchLoadBase) | |
| EnableOverride | Obsolete. Method to enable override. (Inherited from ZumJBoxSwitchLoadBase) | |
| EnterManualOverride |
Enter manual override mode.
This method is not supported by ZumLinkDtQuattroDlsRly, ZumLinkIrQuattroDlsRly, ZumLinkIrQuattroHdDlsRly,
ZumLinkUsHallwayDlsRly, ZumLinkUsOnewayDlsRly, ZumLinkUsQuattroDlsRly, ZumLinkJbox20APlug and
"ZumNetJBoxDaliGroups" and "ZumNetDinDaliGroups" devices.
(Inherited from ZumJBoxSwitchLoadBase) | |
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object) | |
| ExitManualOverride |
Exit manual override mode.
This method is not supported by ZumLinkDtQuattroDlsRly, ZumLinkIrQuattroDlsRly, ZumLinkIrQuattroHdDlsRly,
ZumLinkUsHallwayDlsRly, ZumLinkUsOnewayDlsRly, ZumLinkUsQuattroDlsRly, ZumLinkJbox20APlug and
"ZumNetJBoxDaliGroups" and "ZumNetDinDaliGroups" devices.
(Inherited from ZumJBoxSwitchLoadBase) | |
| 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 turn the load off.
(Inherited from SwitchedLoad) | |
| FullOn |
Method to turn the load on.
(Inherited from SwitchedLoad) | |
| 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) | |
| ToString |
String representation of this light load.
(Inherited from LightLoad) |
| Name | Description | |
|---|---|---|
| OverrideEventHandler |
Event to attach override event handlers
(Inherited from ZumJBoxSwitchLoadBase) |