Click or drag to resize

ClsC6 Class

An iLux Integrated Lighting System.

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 sealed class ClsC6 : ClsC6xBase

The ClsC6 type exposes the following members.

Constructors
 NameDescription
Public methodClsC6(UInt32, CrestronControlSystem) Constructor for the CLS-C6 device on the Control System.
Public methodClsC6(UInt32, IDeviceBranch) Constructor for the CLS-C6 device on the 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.


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

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


(Inherited from 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.


(Inherited from 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.
(Inherited from ClsC6xBase)
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.


(Inherited from ClsC6xBase)
Public propertyLightingLoads Collection of LDimmingLoad objects on the ClsC6xBase.

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


(Inherited from ClsC6xBase)
Public propertyLightOverrideMode Property to control Light Override Mode.

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


(Inherited from 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.


(Inherited from ClsC6xBase)
Public propertyOffScene Off Scene Property present on the device.

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


(Inherited from ClsC6xBase)
Public propertyOnScene On Scene Property present on the device.

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


(Inherited from 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.


(Inherited from 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.


(Inherited from ClsC6xBase)
Public propertyScenes Standard Scenes collection.

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


(Inherited from ClsC6xBase)
Public propertyShadeGroups Collection of ClsC6xBaseClsC6ShadeController objects on the ClsC6xBase.

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


(Inherited from ClsC6xBase)
Public propertyShedMode Property to control Shed Mode.

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


(Inherited from 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 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.
(Inherited from ClsC6xBase)
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.
(Inherited from ClsC6xBase)
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.
(Inherited from ClsC6xBase)
Top
Example
C#
static ClsC6 _clsC6x;

public ControlSystemClsC6x()
{
    //Register console commands
    CrestronConsole.AddNewConsoleCommand(CreateDeviceCmd, "CreateDevice", "This is a CLS-C6X CreateDevice command", ConsoleAccessLevelEnum.AccessOperator);
}

//Method to create CLS-C6/CLS-C6M device class object
public void CreateDeviceCmd(String args)
{
    //Initialize the CLS-C6 device for Cresnet Communication
    _clsC6x = new ClsC6(0x16, this);

    _clsC6x.BaseEvent += ClsC6_BaseEventHandler;
    _clsC6x.ButtonStateChange += ClsC6XButtonChange;
    _clsC6x.SceneControlChange += ClsC6SceneControlChange;
    _clsC6x.LoadStateChange += ClsC6LightingLoadStateChange;
    _clsC6x.SceneProgramming.SceneProgrammingStateChange += SceneProgrammingStateChange;
    _clsC6x.LoadSettingsChange += ClsC6LoadSettingsStateChange;

    _clsC6x.SceneProgramming.ProgrammedScene = _clsC6x.LastScene;

    //Register the CLS-C6 with the Control system
    //This will enable the gateway connection ("127.0.0.1") in the system at the 
    //ID specified above that the CLS-C6 will connect to.
    _clsC6x.Register();
}

// Method to handle Partition Control, Shade Groups, Daylight Harvesting, Occupancy Sensing, Combining sig change events for CLS-C6X 
static void ClsC6_BaseEventHandler(GenericBase device, BaseEventArgs args)
{
    if (args.EventId == ClsC6xBase.PhotocellControlEnabledForLoadEventId)
    {
        CrestronConsole.PrintLine("Photocell Control Enabled event for Load {0} received, state is {1}\r\n", args.Index, _clsC6x.DaylightHarvesting.LoadDaylightHarvesting[(uint)args.Index].EnabledFeedback.BoolValue);
    }
}

//Method to handle the button events
static void ClsC6XButtonChange(GenericBase currentDevice, ButtonEventArgs args)
{
    CrestronConsole.PrintLine("Button{0}'s state is {1}\r\n", args.Button.Number, args.Button.State);
}

//Method to handle the Light Override and Shed Mode slot sig events
static void ClsC6LoadSettingsStateChange(ClsC6xBase device, LoadSettingsEventArgs args)
{
    if (args.EventId == ClsC6xBase.ModeEnteredEventId)
    {
        CrestronConsole.PrintLine("Mode {0} Entered event occurred, EnteredFeedback value is {1}\r\n", args.LoadSettings.Mode, args.LoadSettings.EnteredFeedback.BoolValue);
    }
}

//Method to handle the Scene Programming slot sig change events
static void SceneProgrammingStateChange(ClsC6xBase paramDevice, SceneProgrammingLoadEventArgs args)
{
    if (args.EventId == ClsC6xBase.InSceneEventId)
    {
        CrestronConsole.PrintLine("In Scene event occurred for Scene Programming Load {0} Load Type {1}\r\n", args.ProgrammingLoad.Number, args.ProgrammingLoad.InSceneFeedback.BoolValue, args.ProgrammingLoad.LoadType);
    }
    else if (args.EventId == ClsC6xBase.InSetupModeEventId)
    {
        CrestronConsole.PrintLine("In setup mode event received, sig is {0}\r\n", _clsC6x.SceneProgramming.InSetupModeFeedback);
    }
    else if(args.EventId == ClsC6xBase.SceneNumberFeedbackEventId)
    {
       CrestronConsole.PrintLine("Scene Number Feedback event received, scene type is {0}\r\n", _clsC6x.SceneProgramming.ProgrammedSceneFeedback.Type);
    }
}

//Method to handle the Lighting Load slot sig change events
static void ClsC6LightingLoadStateChange(LightingBase lightingObject, LoadEventArgs args)
{
    if (args.EventId == LoadEventIds.LevelChangeEventId)
    {
        CrestronConsole.PrintLine("Level Changed event occurred for Load {0}, value is {1}\r\n", args.Load.Number, ((ClsC6xBase)lightingObject).LightingLoads[args.Load.Number].LevelFeedback);
    }
}

//Method to handle the Scene and Master Dimming slot sig change events
static void ClsC6SceneControlChange(ClsC6xBase paramDevice, SceneControlEventArgs args)
{
    if (args.EventId == ClsC6xBase.SceneRecallingEventId)
    {
        CrestronConsole.PrintLine("Scene Recalling event occurred for Scene {0} Scene Type {1}, value is {2}\r\n", args.SceneControl.Number, args.SceneControl.Type, ((ClsC6xBase.ClsC6Scene)args.SceneControl).RecallingFeedback.BoolValue);
    }
    else if (args.EventId == ClsC6xBase.SceneLightsUpEventId)
    {
        CrestronConsole.PrintLine("Scene Lights Up event occurred for Scene {0} Scene Type {1}, value is {2}\r\n", args.SceneControl.Number, args.SceneControl.Type, args.SceneControl.LightsUpFeedback.BoolValue);
    }
}

Version Information

.NET

Supported in: 6.0

.NET Compact Framework

Supported in: 3.5
See Also