Zum |
public class ZumXJBoxSwitch : ZumXJBoxSwitchBase
The ZumXJBoxSwitch type exposes the following members.
| Name | Description | |
|---|---|---|
| ConnectedIpList |
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) | |
| Description |
Get/Set the description of this device.
(Inherited from GenericBase) | |
| DeviceInfoDataFeedback |
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) | |
| Disposed |
Property to indicate if the device has been disposed.
(Inherited from GenericDevice) | |
| EnergyMonitor |
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) | |
| ID |
Property to get the ID of the device.
(Inherited from GenericDevice) | |
| IdentifySlotNumber |
Property to set identify slot number.
(Inherited from ZumXJBoxSwitchBase) | |
| IdentifyTimeOut |
Property to set sensor identify timeout.
(Inherited from ZumXJBoxSwitchBase) | |
| IsOnline |
Property to get the current online state of the device.
(Inherited from GenericDevice) | |
| Name |
Get the name of this device.
(Inherited from GenericBase) | |
| OccupancySensor |
Object which has Occupancy Sensor Properties for Zum Wired Switches.
This object is not supported by ZUM-LINK-JBOX-IO.
(Inherited from ZumXJBoxSwitchBase) | |
| Parent |
The parent that a given object was added to.
(Inherited from GenericBase) | |
| PhotoSensor |
Object which has Photo Sensor Properties for Zum Wired Switches.
This object is not supported by ZUM-LINK-JBOX-IO.
(Inherited from ZumXJBoxSwitchBase) | |
| ReadyForConfigurationUpdateFeedback |
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) | |
| Registerable |
Property to indicate that this device can be registered.
(Inherited from GenericDevice) | |
| Registered |
Property to get the current registration state of the device.
(Inherited from GenericDevice) | |
| RegistrationFailureReason |
Property to get the Registration Failure Reason, this will match the return value from the call to register.
(Inherited from GenericDevice) | |
| RoomIdFeedback |
This property reports a string that indicates the room id.
This property will trigger BaseEvent event with RoomIdFeedbackEventId. (Inherited from ZumXJBoxSwitchBase) | |
| SIMPLDeviceImplementation |
Internal protected member used for actual device control.
(Inherited from GenericDevice) | |
| SwitchedLoads |
Collection of Switched loads for this device.
This property will trigger LoadStateChange with LoadEventIds. | |
| Type |
Property to determine to type of device this is.
(Inherited from GenericDevice) | |
| UnRegistrationFailureReason |
Property to get the Unregistration Failure Reason, this will match the return value from the call to unregister.
(Inherited from GenericDevice) | |
| UserSpecifiedObject |
Can be assigned anything that user wants.
(Inherited from GenericBase) | |
| XioEndpointStubSIMPLDevice |
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) |
| Name | Description | |
|---|---|---|
| Dispose |
Clean up of resources.
(Inherited from GenericBase) | |
| Dispose(Boolean) |
Method to perform the actual disposing of the device.
(Inherited from GenericDevice) | |
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object) | |
| Finalize |
Destructor of the device.
(Inherited from GenericDevice) | |
| GetDeviceInfo |
This method is to get the device information into DeviceInfoDataFeedback.
(Inherited from ZumXJBoxSwitchBase) | |
| GetEventId |
Method to get the event id and index from SigEventArgs
(Overrides ZumXJBoxSwitchBaseGetEventId(SigEventArgs, UInt32, UInt32, ZumJBoxSwitchLoadBase)) | |
| GetHashCode | Serves as the default hash function. (Inherited from Object) | |
| GetType | Gets the Type of the current instance. (Inherited from Object) | |
| IdentifyTrigger |
Method to identify trigger.
(Inherited from ZumXJBoxSwitchBase) | |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object) | |
| OnBaseEvent(Int32) |
Protected member used to fire the BaseEvent with the default extended information.
(Inherited from GenericBase) | |
| OnBaseEvent(Int32, UInt16) |
Protected member used to fine the BaseEvent with extended event information.
(Inherited from GenericBase) | |
| OnLoadStateChange |
Method to fire the LoadStateChange event.
(Inherited from LightingBase) | |
| Register |
Register this device with the system.
(Inherited from GenericDevice) | |
| SendParameters |
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) | |
| switchSlot_SigChange |
Subscription to the Switch Slot change.
(Inherited from ZumXJBoxSwitchBase) | |
| ToString |
Return the name of the device.
(Inherited from GenericDevice) | |
| UnRegister |
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) |
| Name | Description | |
|---|---|---|
| BaseEvent |
Generic base event, triggered when the there are no other handlers available
for a specific EventID.
(Inherited from GenericBase) | |
| IpInformationChange |
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) | |
| LoadStateChange |
Event triggered when information from a load is received.
EventIds for this event are located in the LoadEventIds class.
(Inherited from LightingBase) | |
| OnlineStatusChange |
Event triggered when the Online status of the device changes.
(Inherited from GenericDevice) |
| Name | Description | |
|---|---|---|
| _SwitchedLoads |
Collection of switched loads.
(Inherited from Switch) |