Click or drag to resize

ClsC6xBase Class

Base class for CLS-C6 and CLS-C6M iLux Integrated Lighting Systems.

This class will trigger BaseEvent, SceneControlChange, LoadSettingsChange, ButtonStateChange, LoadStateChange and SceneProgrammingStateChange events.

Inheritance Hierarchy

Namespace: Crestron.SimplSharpPro.Lighting
Assembly: Crestron.SimplSharpPro.Lighting (in Crestron.SimplSharpPro.Lighting.dll) Version: 2.21.121
Syntax
C#
public class ClsC6xBase : LightingBase, IButton, 
	IFeedback

The ClsC6xBase type exposes the following members.

Constructors
 NameDescription
Public methodClsC6xBase Constructor for creating new ClsC6xBase object on Cresnet Branch.
Top
Properties
 NameDescription
Public propertyAllLightsScene All Lights Scene Property present on the device.

This property will trigger SceneControlChange event with event IDs defined in ClsC6xBase.

Public propertyButton Collection of buttons supported by the device.
Public propertyCombining Combining object present on ClsC6xBase.

This property will trigger BaseEvent event with event IDs defined in ClsC6xBase.

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 propertyDaylightHarvesting Daylight Harvesting object present on ClsC6xBase.

This property will trigger BaseEvent event with event IDs defined in ClsC6xBase.

Public propertyCode exampleDescription Get/Set the description of this device.
(Inherited from GenericBase)
Public propertyDisposed Property to indicate if the device has been disposed.
(Inherited from GenericDevice)
Public propertyFeedbacks Property to get the collection of feedbacks on the device.
Public propertyID Property to get the ID of the device.
(Inherited from GenericDevice)
Public propertyIsOnline Property to get the current online state of the device.
(Inherited from GenericDevice)
Public propertyLastScene Last Scene Property present on the device.

This property will trigger SceneControlChange event with event IDs defined in ClsC6xBase.

Public propertyLightingLoads Collection of LDimmingLoad objects on the ClsC6xBase.

This property will trigger LoadStateChange event with event IDs defined in LoadEventIds.

Public propertyLightOverrideMode Property to control Light Override Mode.

This property will trigger LoadSettingsChange event with event IDs defined in ClsC6xBase.

Public propertyName Get the name of this device.
(Inherited from GenericBase)
Public propertyOccupancySensing Occupancy Sensing object present on ClsC6xBase.

This property will trigger BaseEvent event with event IDs defined in ClsC6xBase.

Public propertyOffScene Off Scene Property present on the device.

This property will trigger SceneControlChange event with event IDs defined in ClsC6xBase.

Public propertyOnScene On Scene Property present on the device.

This property will trigger SceneControlChange event with event IDs defined in ClsC6xBase.

Public propertyParent The parent that a given object was added to.
(Inherited from GenericBase)
Public propertyPartitionControl Collection of Partition Control objects on ClsC6xBase.

This property will trigger BaseEvent event with event IDs defined in ClsC6xBase.

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 propertySceneProgramming Scene Programming object present on ClsC6xBase.

This property will trigger SceneProgrammingStateChange event with event IDs defined in ClsC6xBase.

Public propertyScenes Standard Scenes collection.

This property will trigger SceneControlChange event with event IDs defined in ClsC6xBase.

Public propertyShadeGroups Collection of ClsC6xBaseClsC6ShadeController objects on the ClsC6xBase.

This property will trigger BaseEvent event with event IDs defined in ShadeDrapeControllerEventIds.

Public propertyShedMode Property to control Shed Mode.

This property will trigger LoadSettingsChange event with event IDs defined in ClsC6xBase.

Protected propertySIMPLDeviceImplementation Internal protected member used for actual device control.
(Inherited from GenericDevice)
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 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)
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)
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 eventButtonStateChange Event fired when a button state change was received from the device.
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 eventLoadSettingsChange Event triggered when a feedback has changed for a ClsC6xBaseClsC6LoadSettings object. EventIds for this event are located in the ClsC6xBase class.
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)
Public eventSceneControlChange Event triggered when a feedback has changed for a ClsC6xBaseClsC6Dimming object. EventIds for this event are located in the ClsC6xBase class.
Top
Fields
 NameDescription
Public fieldStatic memberEnergySavingsInPercentageFeedbackEventId The value of EnergySavingsInPercentageFeedback has changed.

The BaseEvent event will trigger for this event id.

Public fieldStatic memberEnergySavingsInWattsFeedbackEventId The value of EnergySavingsInWattsFeedback has changed.

The BaseEvent event will trigger for this event id.

Public fieldStatic memberEntrySceneEnabledEventId The state of EntrySceneEnabledFeedback has changed.

The BaseEvent event will trigger for this event id.

Public fieldStatic memberExitSceneEnabledEventId The state of ExitSceneEnabledFeedback has changed.

The BaseEvent event will trigger for this event id.

Public fieldStatic memberFadeTimeFeedbackEventId The value of FadeTimeFeedback has changed.

The SceneProgrammingStateChange event will trigger for this event id.

Public fieldStatic memberFadeTimeInMinutesEventId The state of FadeTimeInMinutesFeedback has changed.

The SceneProgrammingStateChange event will trigger for this event id.

Public fieldStatic memberFromThisSystemFeedbackEventId The value of FromThisSystemFeedback has changed.

The BaseEvent event will trigger for this event id.

Public fieldStatic memberFunctionActivityDetectedEventId The state of FunctionActivityFeedback has changed.

The BaseEvent event will trigger for this event id.

Public fieldStatic memberInSceneEventId The state of InSceneFeedback has changed.

The SceneProgrammingStateChange event will trigger for this event id.

Public fieldStatic memberInSetupModeEventId The state of InSetupModeFeedback has changed.

The SceneProgrammingStateChange event will trigger for this event id.

Public fieldStatic memberLoadUnderPhotocellControlEventId 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.

Public fieldStatic memberMinimumPhotocellDimLevelFeedbackEventId 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.

Public fieldStatic memberModeEnteredEventId The state of EnteredFeedback has changed.

The LoadSettingsChange event will trigger for this event id.

Public fieldStatic memberMotionActivityDetectedEventId The state of MotionActivityFeedback has changed.

The BaseEvent event will trigger for this event id.

Public fieldStatic memberOccupancyDetectedEventId The state of OccupancyDetectedFeedback has changed.

The BaseEvent event will trigger for this event id.

Public fieldStatic memberPartitionOpenedEventId The state of OpenedFeedback has changed.

The BaseEvent event will trigger for this event id and Index will indicate the index into the PartitionControl.

Public fieldStatic memberPhotocellControlEnabledForLoadEventId 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.

Public fieldStatic memberPhotocellEnergySavingsInPercentageFeedbackEventId The value of PhotocellEnergySavingsInPercentageFeedback has changed.

The BaseEvent event will trigger for this event id.

Public fieldStatic memberPhotocellLevelFeedbackEventId The value of PhotocellLevelFeedback has changed.

The BaseEvent event will trigger for this event id.

Public fieldStatic memberPhotocellSensitivityFeedbackEventId 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.

Public fieldStatic memberProgrammingSceneEventId The state of ProgrammingSceneFeedback has changed.

The SceneProgrammingStateChange event will trigger for this event id.

Public fieldStatic memberResponseTimeFeedbackEventId The value of ResponseTimeFeedback has changed.

The BaseEvent event will trigger for this event id.

Public fieldStatic memberResponseTimeStringFeedbackEventId The value of ResponseTimeStringFeedback has changed.

The BaseEvent event will trigger for this event id.

Public fieldStatic memberSceneAnyLightsOnEventId The state of AnyLightsOnFeedback has changed.

The SceneControlChange event will trigger for this event id.

Public fieldStatic memberSceneLightsDownEventId The state of LightsDownFeedback has changed.

The SceneControlChange event will trigger for this event id.

Public fieldStatic memberSceneLightsUpEventId The state of LightsUpFeedback has changed.

The SceneControlChange event will trigger for this event id.

Public fieldStatic memberSceneLockedEventId The state of SceneLockedFeedback has changed.

The SceneProgrammingStateChange event will trigger for this event id.

Public fieldStatic memberSceneNumberFeedbackEventId The value of ProgrammedSceneFeedback has changed.

The SceneControlChange event will trigger for this event id.

Public fieldStatic memberSceneRecallingEventId The state of RecallingFeedback has changed.

The SceneControlChange event will trigger for this event id.

Public fieldStatic memberSceneRecallingLightsOffEventId The state of RecallingLightsOffFeedback has changed.

The SceneControlChange event will trigger for this event id.

Public fieldStatic memberSceneSelectedEventId The state of SelectedFeedback has changed.

The SceneControlChange event will trigger for this event id.

Public fieldStatic memberTimeoutHoursFeedbackEventId The value of TimeoutHoursFeedback has changed.

The BaseEvent event will trigger for this event id.

Public fieldStatic memberTimeoutMinutesFeedbackEventId The value of TimeoutMinutesFeedback has changed.

The BaseEvent event will trigger for this event id.

Top

Version Information

.NET

Supported in: 6.0

.NET Compact Framework

Supported in: 3.5
See Also