Cls |
This class will trigger BaseEvent, SceneControlChange, LoadSettingsChange, ButtonStateChange, LoadStateChange and SceneProgrammingStateChange events.
public class ClsC6xBase : LightingBase, IButton, IFeedback
The ClsC6xBase type exposes the following members.
| Name | Description | |
|---|---|---|
| ClsC6xBase | Constructor for creating new ClsC6xBase object on Cresnet Branch. |
| Name | Description | |
|---|---|---|
| AllLightsScene |
All Lights Scene Property present on the device.
This property will trigger SceneControlChange event with event IDs defined in ClsC6xBase. | |
| Button | Collection of buttons supported by the device. | |
| Combining |
Combining object present on ClsC6xBase.
This property will trigger BaseEvent event with event IDs defined in ClsC6xBase. | |
| 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) | |
| DaylightHarvesting |
Daylight Harvesting object present on ClsC6xBase.
This property will trigger BaseEvent event with event IDs defined in ClsC6xBase. | |
| Description |
Get/Set the description of this device.
(Inherited from GenericBase) | |
| Disposed |
Property to indicate if the device has been disposed.
(Inherited from GenericDevice) | |
| Feedbacks | Property to get the collection of feedbacks on the device. | |
| ID |
Property to get the ID of the device.
(Inherited from GenericDevice) | |
| IsOnline |
Property to get the current online state of the device.
(Inherited from GenericDevice) | |
| LastScene |
Last Scene Property present on the device.
This property will trigger SceneControlChange event with event IDs defined in ClsC6xBase. | |
| LightingLoads |
Collection of LDimmingLoad objects on the ClsC6xBase.
This property will trigger LoadStateChange event with event IDs defined in LoadEventIds. | |
| LightOverrideMode |
Property to control Light Override Mode.
This property will trigger LoadSettingsChange event with event IDs defined in ClsC6xBase. | |
| Name |
Get the name of this device.
(Inherited from GenericBase) | |
| OccupancySensing |
Occupancy Sensing object present on ClsC6xBase.
This property will trigger BaseEvent event with event IDs defined in ClsC6xBase. | |
| OffScene |
Off Scene Property present on the device.
This property will trigger SceneControlChange event with event IDs defined in ClsC6xBase. | |
| OnScene |
On Scene Property present on the device.
This property will trigger SceneControlChange event with event IDs defined in ClsC6xBase. | |
| Parent |
The parent that a given object was added to.
(Inherited from GenericBase) | |
| PartitionControl |
Collection of Partition Control objects on ClsC6xBase.
This property will trigger BaseEvent event with event IDs defined in ClsC6xBase. | |
| 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) | |
| SceneProgramming |
Scene Programming object present on ClsC6xBase.
This property will trigger SceneProgrammingStateChange event with event IDs defined in ClsC6xBase. | |
| Scenes |
Standard Scenes collection.
This property will trigger SceneControlChange event with event IDs defined in ClsC6xBase. | |
| ShadeGroups |
Collection of ClsC6xBaseClsC6ShadeController objects on the ClsC6xBase.
This property will trigger BaseEvent event with event IDs defined in ShadeDrapeControllerEventIds. | |
| ShedMode |
Property to control Shed Mode.
This property will trigger LoadSettingsChange event with event IDs defined in ClsC6xBase. | |
| SIMPLDeviceImplementation |
Internal protected member used for actual device control.
(Inherited from GenericDevice) | |
| 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) | |
| 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) | |
| 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) | |
| 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) | |
| ButtonStateChange | Event fired when a button state change was received from the device. | |
| 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) | |
| LoadSettingsChange | Event triggered when a feedback has changed for a ClsC6xBaseClsC6LoadSettings object. EventIds for this event are located in the ClsC6xBase class. | |
| 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) | |
| SceneControlChange | Event triggered when a feedback has changed for a ClsC6xBaseClsC6Dimming object. EventIds for this event are located in the ClsC6xBase class. |
| Name | Description | |
|---|---|---|
| EnergySavingsInPercentageFeedbackEventId |
The value of EnergySavingsInPercentageFeedback has changed.
The BaseEvent event will trigger for this event id. | |
| EnergySavingsInWattsFeedbackEventId |
The value of EnergySavingsInWattsFeedback has changed.
The BaseEvent event will trigger for this event id. | |
| EntrySceneEnabledEventId |
The state of EntrySceneEnabledFeedback has changed.
The BaseEvent event will trigger for this event id. | |
| ExitSceneEnabledEventId |
The state of ExitSceneEnabledFeedback has changed.
The BaseEvent event will trigger for this event id. | |
| FadeTimeFeedbackEventId |
The value of FadeTimeFeedback has changed.
The SceneProgrammingStateChange event will trigger for this event id. | |
| FadeTimeInMinutesEventId |
The state of FadeTimeInMinutesFeedback has changed.
The SceneProgrammingStateChange event will trigger for this event id. | |
| FromThisSystemFeedbackEventId |
The value of FromThisSystemFeedback has changed.
The BaseEvent event will trigger for this event id. | |
| FunctionActivityDetectedEventId |
The state of FunctionActivityFeedback has changed.
The BaseEvent event will trigger for this event id. | |
| InSceneEventId |
The state of InSceneFeedback has changed.
The SceneProgrammingStateChange event will trigger for this event id. | |
| InSetupModeEventId |
The state of InSetupModeFeedback has changed.
The SceneProgrammingStateChange event will trigger for this event id. | |
| LoadUnderPhotocellControlEventId |
The state of ActiveFeedback has changed.
The BaseEvent event will trigger for this event id and Index will indicate the index into the LoadDaylightHarvesting collection. | |
| MinimumPhotocellDimLevelFeedbackEventId |
The value of MinimumDimLevelFeedback has changed.
The BaseEvent event will trigger for this event id and Index will indicate the index into the LoadDaylightHarvesting collection. | |
| ModeEnteredEventId |
The state of EnteredFeedback has changed.
The LoadSettingsChange event will trigger for this event id. | |
| MotionActivityDetectedEventId |
The state of MotionActivityFeedback has changed.
The BaseEvent event will trigger for this event id. | |
| OccupancyDetectedEventId |
The state of OccupancyDetectedFeedback has changed.
The BaseEvent event will trigger for this event id. | |
| PartitionOpenedEventId |
The state of OpenedFeedback has changed.
The BaseEvent event will trigger for this event id and Index will indicate the index into the PartitionControl. | |
| PhotocellControlEnabledForLoadEventId |
The state of EnabledFeedback has changed.
The BaseEvent event will trigger for this event id and Index will indicate the index into the LoadDaylightHarvesting collection. | |
| PhotocellEnergySavingsInPercentageFeedbackEventId |
The value of PhotocellEnergySavingsInPercentageFeedback has changed.
The BaseEvent event will trigger for this event id. | |
| PhotocellLevelFeedbackEventId |
The value of PhotocellLevelFeedback has changed.
The BaseEvent event will trigger for this event id. | |
| PhotocellSensitivityFeedbackEventId |
The value of SensitivityFeedback has changed.
The BaseEvent event will trigger for this event id and Index will indicate the index into the LoadDaylightHarvesting collection. | |
| ProgrammingSceneEventId |
The state of ProgrammingSceneFeedback has changed.
The SceneProgrammingStateChange event will trigger for this event id. | |
| ResponseTimeFeedbackEventId |
The value of ResponseTimeFeedback has changed.
The BaseEvent event will trigger for this event id. | |
| ResponseTimeStringFeedbackEventId |
The value of ResponseTimeStringFeedback has changed.
The BaseEvent event will trigger for this event id. | |
| SceneAnyLightsOnEventId |
The state of AnyLightsOnFeedback has changed.
The SceneControlChange event will trigger for this event id. | |
| SceneLightsDownEventId |
The state of LightsDownFeedback has changed.
The SceneControlChange event will trigger for this event id. | |
| SceneLightsUpEventId |
The state of LightsUpFeedback has changed.
The SceneControlChange event will trigger for this event id. | |
| SceneLockedEventId |
The state of SceneLockedFeedback has changed.
The SceneProgrammingStateChange event will trigger for this event id. | |
| SceneNumberFeedbackEventId |
The value of ProgrammedSceneFeedback has changed.
The SceneControlChange event will trigger for this event id. | |
| SceneRecallingEventId |
The state of RecallingFeedback has changed.
The SceneControlChange event will trigger for this event id. | |
| SceneRecallingLightsOffEventId |
The state of RecallingLightsOffFeedback has changed.
The SceneControlChange event will trigger for this event id. | |
| SceneSelectedEventId |
The state of SelectedFeedback has changed.
The SceneControlChange event will trigger for this event id. | |
| TimeoutHoursFeedbackEventId |
The value of TimeoutHoursFeedback has changed.
The BaseEvent event will trigger for this event id. | |
| TimeoutMinutesFeedbackEventId |
The value of TimeoutMinutesFeedback has changed.
The BaseEvent event will trigger for this event id. |