Click or drag to resize

ZumXJBoxSwitch Class

This is base class for ZumLinkJbox20ASw.
Inheritance Hierarchy

Namespace: Crestron.SimplSharpPro.Lighting.ZumWired
Assembly: Crestron.SimplSharpPro.Lighting (in Crestron.SimplSharpPro.Lighting.dll) Version: 2.21.121
Syntax
C#
public class ZumXJBoxSwitch : ZumXJBoxSwitchBase

The ZumXJBoxSwitch type exposes the following members.

Properties
 NameDescription
Public propertyConnectedIpList A property containing the list of the ConnectedIpInformation objects which contain information about the devices that are connected to this IP ID. This property is only valid for an ethernet device. If this is not an ethernet device, then this property will return null. If this is an ethernet device, the list will be non-null. It will be empty if no devices are connected. The order of items in this list is not guaranteed.
(Inherited from GenericDevice)
Public propertyCode exampleDescription Get/Set the description of this device.
(Inherited from GenericBase)
Public propertyDeviceInfoDataFeedback This property reports a string that indicates the device type and what are its capabilities (i.e. Load Controller, Occ Sensor, Photo, Keypad, etc...), and also appends the associated device variant details (i.e. LV dimmer, Phase dimmer, switch, number of buttons)

This property will trigger BaseEvent event with DeviceInfoDataFeedbackEventId.


(Inherited from ZumXJBoxSwitchBase)
Public propertyDisposed Property to indicate if the device has been disposed.
(Inherited from GenericDevice)
Public propertyEnergyMonitor Object which has Energy Monitor Properties on Zum Wired JBox Dimmers. This object is not supported by ZUM-LINK-JBOX-IO.

This property will trigger EnergyMonitorChange with ZumJBoxEventIds.


(Inherited from ZumXJBoxSwitchBase)
Public propertyID Property to get the ID of the device.
(Inherited from GenericDevice)
Public propertyIdentifySlotNumber Property to set identify slot number.
(Inherited from ZumXJBoxSwitchBase)
Public propertyIdentifyTimeOut Property to set sensor identify timeout.
(Inherited from ZumXJBoxSwitchBase)
Public propertyIsOnline Property to get the current online state of the device.
(Inherited from GenericDevice)
Public propertyName Get the name of this device.
(Inherited from GenericBase)
Public propertyOccupancySensor Object which has Occupancy Sensor Properties for Zum Wired Switches. This object is not supported by ZUM-LINK-JBOX-IO.
(Inherited from ZumXJBoxSwitchBase)
Public propertyParent The parent that a given object was added to.
(Inherited from GenericBase)
Public propertyPhotoSensor Object which has Photo Sensor Properties for Zum Wired Switches. This object is not supported by ZUM-LINK-JBOX-IO.
(Inherited from ZumXJBoxSwitchBase)
Public propertyReadyForConfigurationUpdateFeedback When this property is true then the Zum Wired Device is ready to update configuration parameters. When this property is false then the Zum Wired Device will ignore the configuraion parameters.

This property will trigger BaseEvent event with ReadyForConfigUpdateFeedbackEventId.


(Inherited from ZumXJBoxSwitchBase)
Public propertyRegisterable Property to indicate that this device can be registered.
(Inherited from GenericDevice)
Public propertyRegistered Property to get the current registration state of the device.
(Inherited from GenericDevice)
Public propertyRegistrationFailureReason Property to get the Registration Failure Reason, this will match the return value from the call to register.
(Inherited from GenericDevice)
Public propertyRoomIdFeedback This property reports a string that indicates the room id.

This property will trigger BaseEvent event with RoomIdFeedbackEventId.


(Inherited from ZumXJBoxSwitchBase)
Protected propertySIMPLDeviceImplementation Internal protected member used for actual device control.
(Inherited from GenericDevice)
Public propertySwitchedLoads Collection of Switched loads for this device.

This property will trigger LoadStateChange with LoadEventIds.

Public propertyType Property to determine to type of device this is.
(Inherited from GenericDevice)
Public propertyUnRegistrationFailureReason Property to get the Unregistration Failure Reason, this will match the return value from the call to unregister.
(Inherited from GenericDevice)
Public propertyUserSpecifiedObject Can be assigned anything that user wants.
(Inherited from GenericBase)
Protected propertyXioEndpointStubSIMPLDevice The SIMPL "stub" Device that the XiO Director creates for an endpoint to send the 1C/0E to the correct place in hierarchy.
(Inherited from GenericDevice)
Top
Methods
 NameDescription
Public methodDispose Clean up of resources.
(Inherited from GenericBase)
Protected methodDispose(Boolean) Method to perform the actual disposing of the device.
(Inherited from GenericDevice)
Public methodEqualsDetermines whether the specified object is equal to the current object.
(Inherited from Object)
Protected methodFinalize Destructor of the device.
(Inherited from GenericDevice)
Public methodGetDeviceInfo This method is to get the device information into DeviceInfoDataFeedback.
(Inherited from ZumXJBoxSwitchBase)
Protected methodGetEventId Method to get the event id and index from SigEventArgs
(Overrides ZumXJBoxSwitchBaseGetEventId(SigEventArgs, UInt32, UInt32, ZumJBoxSwitchLoadBase))
Public methodGetHashCodeServes as the default hash function.
(Inherited from Object)
Public methodGetTypeGets the Type of the current instance.
(Inherited from Object)
Public methodIdentifyTrigger Method to identify trigger.
(Inherited from ZumXJBoxSwitchBase)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object.
(Inherited from Object)
Protected methodOnBaseEvent(Int32) Protected member used to fire the BaseEvent with the default extended information.
(Inherited from GenericBase)
Protected methodOnBaseEvent(Int32, UInt16) Protected member used to fine the BaseEvent with extended event information.
(Inherited from GenericBase)
Protected methodOnLoadStateChange Method to fire the LoadStateChange event.
(Inherited from LightingBase)
Public methodRegister Register this device with the system.
(Inherited from GenericDevice)
Public methodSendParameters This will send the parameters fields (if any) to the device. It allows the parameters to be modified and resent without unregistering and re-registering a device. It requires firmware support on the device. Not Currently implemented. This will throw a NotSupportedException
(Inherited from LightingBase)
Protected methodswitchSlot_SigChange Subscription to the Switch Slot change.
(Inherited from ZumXJBoxSwitchBase)
Public methodToString Return the name of the device.
(Inherited from GenericDevice)
Public methodUnRegister Unregister this device with the system. This function can not be called from the device's own SigChange event handler.

On successful unregistration, if this device supports the OnlineStatusChange event, it will trigger indicating the device when offline.


(Inherited from GenericDevice)
Top
Events
 NameDescription
Public eventBaseEvent Generic base event, triggered when the there are no other handlers available for a specific EventID.
(Inherited from GenericBase)
Public eventIpInformationChange Event that tells what IP Address is connected/disconnected from an IP ID for a non-UDP device. This is only valid for an Ethernet device. An exception will be thrown if it is not.
(Inherited from GenericDevice)
Public eventLoadStateChange Event triggered when information from a load is received. EventIds for this event are located in the LoadEventIds class.
(Inherited from LightingBase)
Public eventOnlineStatusChange Event triggered when the Online status of the device changes.
(Inherited from GenericDevice)
Top
Fields
 NameDescription
Protected field_SwitchedLoads Collection of switched loads.
(Inherited from Switch)
Top

Version Information

.NET

Supported in: 6.0

.NET Compact Framework

Supported in: 3.5
See Also