Click or drag to resize

DinDliBase Class

Base class for DIN-DLI device classes.
Inheritance Hierarchy
SystemObject
  Crestron.SimplSharpProGenericBase
    Crestron.SimplSharpProGenericDevice
      Crestron.SimplSharpPro.LightingDinDliBase
        Crestron.SimplSharpPro.LightingDinDli

Namespace: Crestron.SimplSharpPro.Lighting
Assembly: Crestron.SimplSharpPro.Lighting (in Crestron.SimplSharpPro.Lighting.dll) Version: 2.21.121
Syntax
C#
public class DinDliBase : GenericDevice

The DinDliBase type exposes the following members.

Properties
 NameDescription
Public propertyAllDriverLower Property to lower the light level of all the drivers on the DinDliBase, using the ramp rate defined in the DliDriver.
Public propertyAllDriverRaise Property to raise the light level of all the drivers on the DinDliBase, using the ramp rate defined in the DliDriver.
Public propertyAllDriverTcLower Property to lower the Tc level of all the drivers on the DinDliBase, using the ramp rate defined in the DliDriver.
Public propertyAllDriverTcRaise Property to raise the Tc level of all the drivers on the DinDliBase, using the ramp rate defined in the DliDriver.
Public propertyBroadcastLevel Property to set the brightness level for all drivers on the DinDliBase.
Public propertyBroadcastTcLevel Property to set the Tc level for all drivers on the DinDliBase.
Public propertyCctSceneApproximationNeedsUpdateFeedback Property to indicate that the CCT scene approximation needs updated.

The BaseEvent event will trigger with CctSceneApproximationNeedsUpdateEventId.

Public propertyCctSceneApproximationProgrammingInProgressFeedback Property to indicate that the CCT scene approximation programming is in progress.

The BaseEvent event will trigger with CctSceneApproximationProgrammingInProgressEventId.

Public propertyConfigurationReadFeedback Property to indicate that the DALI controller is reading configuration parameters (i.e., minimum/maximum and override levels). These parameters are typically set when using the DALI Commissioning Tool.

The DriverSigEventChange event will trigger with ConfigurationReadFeedbackEventId.

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 propertyCurrentCctOperatingModeFeedback Property to report the current CCT operating mode.

The BaseEvent event will trigger with CurrentCctOperatingModeFeedbackEventId.

Public propertyDaliBusErrorFeedback Property to indicate that an error has been detected on the DinDliBase.

The DriverSigEventChange event will trigger with DaliBusErrorFeedbackEventId.

Public propertyCode exampleDescription Get/Set the description of this device.
(Inherited from GenericBase)
Public propertyDeviceName Property to set the Device Name of this DinDliBase
Public propertyDeviceNameFeedback Property to read the Device Name value of this DinDliBase

The BaseEvent event will trigger with DeviceNameFeedbackEventId.

Public propertyDisposed Property to indicate if the device has been disposed.
(Inherited from GenericDevice)
Public propertyDriverReplacement Object of Driver Replacement on DIN-DLI.
Public propertyDriversDLI Drivers collection. Valid index values for this collection are from Driver0 to Driver63.
Public propertyDriverSceneConfigurationOperations Object of Driver Scene Configuration Operations on DIN-DLI.
Public propertyDriverSceneRecallSave Object of Driver Scene Recall Save on DIN-DLI.
Public propertyGroupsDLI Groups collection. Valid index values for this collection are from Group0 to Group15.
Public propertyGroupSceneConfigurationOperations Object of Group Scene Configuration Operations on DIN-DLI.
Public propertyGroupSceneRecallSave Object of Group Scene Recall Save on DIN-DLI.
Public propertyID Property to get the ID of the device.
(Inherited from GenericDevice)
Public propertyInExternalOverrideFeedback Property to indicate that external override is active.

The OverrideEventHandler event will trigger with External.

Public propertyInManualOverrideFeedback Property to indicate that manual override is active.

The OverrideEventHandler event will trigger with Manual.

Public propertyIsDynamicFadeTimeEnabledFeedback Property to indicate the enabled state of Dynamic Fade Times.

The BaseEvent event will trigger with IsDynamicFadeTimeEnabledEventId.

Public propertyIsExtendedFadeTimeEnabledFeedback Property to indicate the enabled state of Extended Fade Times.

The BaseEvent event will trigger with IsExtendedFadeTimeEnabledEventId.

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 propertyParent The parent that a given object was added to.
(Inherited from GenericBase)
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 propertySetCctOperatingMode Property to set the CCT operating mode.
Protected propertySIMPLDeviceImplementation Internal protected member used for actual device control.
(Inherited from GenericDevice)
Public propertyThreeByteCommandNoResponseFeedback Property to indicate that no response has been received after triggering the 3-byte command using Execute(Byte, Byte, Byte) method.

The DriverSigEventChange event will trigger with ThreeByteCommandNoResponseFeedbackEventId.

Public propertyThreeByteCommandResponseFeedback 8-bit response to the last executed 3-byte command. The high-order byte of the response is ignored.

The DriverSigEventChange event will trigger with ThreeByteCommandResponseReceivedEventId.

Public propertyThreeByteCommandResponseValidFeedback Property to indicate that the 3-byte command Response contains valid data. The data is sent from the other DALI controller in response to an Execute(Byte, Byte, Byte) command.

The DriverSigEventChange event will trigger with ThreeByteCommandResponseValidFeedbackEventId.

Public propertyTwoByteCommandNoResponseFeedback Property to indicate that no response has been received after triggering a 2-byte command using Execute(Byte, Byte).

The DriverSigEventChange event will trigger with TwoByteCommandNoResponseFeedbackEventId.

Public propertyTwoByteCommandResponseFeedback 8-bit response to the last executed 2-byte query command. The high-order byte of the response is ignored.

The DriverSigEventChange event will trigger with TwoByteCommandResponseReceivedEventId.

Public propertyTwoByteCommandResponseValidFeedback Property to indicate that the 2-byte command Response contains valid data.

The DriverSigEventChange event will trigger with TwoByteCommandResponseValidFeedbackEventId.

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 methodApplyCctOperatingMode Method to start using the CCT operating mode.
Public methodBroadcastOff Method to turn off all the drivers on the DinDliBase.
Public methodDisableDynamicFadeTimes Method to disable the use of Dynamic Fade Times.
Public methodDisableExtendedFadeTimes Method to disable the use of Extended Fade Times.
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 methodEnableDynamicFadeTimes Method to enable the use of Dynamic Fade Times.
Public methodEnableExtendedFadeTimes Method to enable the use of Extended Fade Times.
Public methodEnterManualOverride Method to enter manual override mode. This recalls the override load levels stored in the DliDriver.
Public methodEqualsDetermines whether the specified object is equal to the current object.
(Inherited from Object)
Public methodExecute(Byte, Byte) Method to send the 2-byte DALI control/query command or special command specified by "paramAddress" (byte 1) and "paramCommandOrData" (byte 2). The commands can be sent to individual DliDriver/DliGroup/ all drivers that are part of the DinDliBase.
Public methodExecute(Byte, Byte, Byte) Method to send the 3-byte DALI command. The DALI command consists of "paramAddress" (byte 1), "paramCommandOrData" (byte 2) and "paramData" (byte 3).
Public methodExitManualOverride Method to exit manual override mode. This will restore the loads to the non-override states (assuming not also in External override mode).
Protected methodFinalize Destructor of the device.
(Inherited from GenericDevice)
Public methodGetDriverExtendedType Method to force the ExtendedTypeFeedback properties to refresh.
Public methodGetDriverGTIN Method to force updating all the GTINFeedback properties of this DliDriver
Public methodGetDriverTcRangeCoolest Method to force updating all the TcRangeCoolestFeedback properties of this DliDriver
Public methodGetDriverTcRangeWarmest Method to force updating all the TcRangeWarmestFeedback properties of this DliDriver
Public methodGetDriverType Method to force the TypeFeedback properties to refresh.
Public methodGetGroupCapabilty Method to force updating all the CapabilityFeedback properties of this DliGroup
Public methodGetGroupTcRangeCoolest Method to force updating all the TcRangeCoolestFeedback properties of this DliGroup
Public methodGetGroupTcRangeWarmest Method to force updating all the TcRangeWarmestFeedback properties of this DliGroup
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)
Public methodProgramCctSceneApproximationValues Method to program the CCT scene approximation values.
Public methodRegister Register this device with the system.
(Inherited from GenericDevice)
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 eventDriverSigEventChange Event triggered when the DliDriver reports information to the Control System. Will fire the DriverSigEventChange with GenericEventArgs.

Valid event IDs are available in DinDliBase

Public eventGroupSigEventChange Event triggered when the DliGroup reports information to the Control System. Will fire the GroupSigEventChange with GenericEventArgs.

Valid event IDs are available in DinDliBase

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 eventOnlineStatusChange Event triggered when the Online status of the device changes.
(Inherited from GenericDevice)
Public eventOverrideEventHandler Event triggered when the DinDliBase reports Override sig information to the Control System.

Valid event IDs are available in eOverrideEvents.

Top
Fields
 NameDescription
Public fieldStatic memberBusyFeedbackEventId The state of BusyFeedback has changed.

The DriverSigEventChange event will trigger for this event id.

Public fieldStatic memberCapabilityFeedbackEventId The value of CapabilityFeedback has changed.

GroupSigEventChange will fire with the event Id and Index as index into the Groups collection.

Public fieldStatic memberCctSceneApproximationNeedsUpdateEventId The state of CctSceneApproximationNeedsUpdateFeedback has changed.

The BaseEvent event will trigger for this event id.

Public fieldStatic memberCctSceneApproximationProgrammingInProgressEventId The state of CctSceneApproximationProgrammingInProgressFeedback has changed.

The BaseEvent event will trigger for this event id.

Public fieldStatic memberConfigOperationsSceneLevelFeedbackEventId The value of SceneLevelFeedback has changed.

The DriverSigEventChange or GroupSigEventChange event will trigger for this event id.

Public fieldStatic memberConfigOperationsTcLevelFeedbackEventId The value of TcLevelFeedback has changed.

The DriverSigEventChange or GroupSigEventChange event will trigger for this event id.

Public fieldStatic memberConfigurationReadFeedbackEventId The state of ConfigurationReadFeedback has changed.

The DriverSigEventChange event will trigger for this event id.

Public fieldStatic memberCurrentCctOperatingModeFeedbackEventId The value of CurrentCctOperatingModeFeedback has changed.

The BaseEvent event will trigger for this event id.

Public fieldStatic memberDaliBusErrorFeedbackEventId The state of DaliBusErrorFeedback has changed.

The DriverSigEventChange event will trigger for this event id.

Public fieldStatic memberDeviceNameFeedbackEventId The value of DeviceNameFeedback has changed.

BaseEvent will fire with the event Id DeviceNameFeedbackEventId

Public fieldStatic memberFailFeedbackEventId The state of FailFeedback has changed.

The DriverSigEventChange event will trigger for this event id.

Public fieldStatic memberGTINFeedbackEventId The value of GTINFeedback has changed.

DriverSigEventChange will fire with the event Id and Index as index into the Drivers collection.

Public fieldStatic memberInDriverReplacementFeedbackEventId The state of InDriverReplacementFeedback has changed.

The DriverSigEventChange event will trigger for this event id.

Public fieldStatic memberInGroupFeedbackEventId The state of InGroupFeedback has changed.

DriverSigEventChange will fire with the event Id and Index as index into the Drivers collection.

Public fieldStatic memberIsDynamicFadeTimeEnabledEventId The value of IsDynamicFadeTimeEnabledFeedback has changed.

BaseEvent will fire with the event Id IsDynamicFadeTimeEnabledEventId

Public fieldStatic memberIsExtendedFadeTimeEnabledEventId The value of IsExtendedFadeTimeEnabledFeedback has changed.

BaseEvent will fire with the event Id IsExtendedFadeTimeEnabledEventId

Public fieldStatic memberIsSceneLightLevelMaskedFeedbackEventId The state of IsSceneLightLevelMaskedFeedback has changed.

The DriverSigEventChange or GroupSigEventChange event will trigger for this event id.

Public fieldStatic memberIsSceneTcMaskedFeedbackEventId The state of IsSceneTcMaskedFeedback has changed.

The DriverSigEventChange or GroupSigEventChange event will trigger for this event id.

Public fieldStatic memberLampFailureFeedbackEventId The state of LampFailureFeedback has changed.

DriverSigEventChange will fire with the event Id and Index as index into the Drivers collection.

Public fieldStatic memberLevelFeedbackEventId The value of LevelFeedback has changed.

DriverSigEventChange will fire with the event Id and Index as index into the Drivers collection.

Public fieldStatic memberMissingFeedbackEventId The state of MissingFeedback has changed.

DriverSigEventChange will fire with the event Id and Index as index into the Drivers collection.

Public fieldStatic memberNumberOfDrivers Number of DLI Drivers per DinDliBase.
Public fieldStatic memberNumberOfGroups Number of DLI Driver Groups per DinDliBase.
Public fieldStatic memberNumberOfMissingDriversFeedbackEventId The value of NumberOfMissingDriversFeedback has changed.

The DriverSigEventChange event will trigger for this event id.

Public fieldStatic memberNumberOfNewDriversFeedbackEventId The value of NumberOfNewDriversFeedback has changed.

The DriverSigEventChange event will trigger for this event id.

Public fieldStatic memberStatusReceivedEventId The value of StatusFeedback has changed.

DriverSigEventChange will fire with the event Id and index into the Drivers collection.

Public fieldStatic memberSuccessFeedbackEventId The state of SuccessFeedback has changed.

The DriverSigEventChange event will trigger for this event id.

Public fieldStatic memberTcCapableFeedbackEventId The state of TcCapableFeedback has changed.

DriverSigEventChange will fire with the event Id and Index as index into the Drivers collection.

Public fieldStatic memberTcLevelFeedbackEventId The value of TcLevelFeedback or TcLevelFeedback has changed.

DriverSigEventChange will fire with the event Id and Index as index into the Drivers collection.

GroupSigEventChange will fire with the event Id and Index as index into the Groups collection.

Public fieldStatic memberTcRangeCoolestFeedbackEventId The value of TcRangeCoolestFeedback has changed.

DriverSigEventChange will fire with the event Id and Index as index into the Drivers collection.

GroupSigEventChange will fire with the event Id and Index as index into the Groups collection.

Public fieldStatic memberTcRangePhysicalCoolestFeedbackEventId The value of TcRangePhysicalCoolestFeedback has changed.

DriverSigEventChange will fire with the event Id and Index as index into the Drivers collection.

Public fieldStatic memberTcRangePhysicalWarmestFeedbackEventId The value of TcRangePhysicalWarmestFeedback has changed.

DriverSigEventChange will fire with the event Id and Index as index into the Drivers collection.

Public fieldStatic memberTcRangeWarmestFeedbackEventId The value of TcRangeWarmestFeedback has changed.

DriverSigEventChange will fire with the event Id and Index as index into the Drivers collection.

GroupSigEventChange will fire with the event Id and Index as index into the Groups collection.

Public fieldStatic memberThreeByteCommandNoResponseFeedbackEventId The state of ThreeByteCommandNoResponseFeedback has changed.

The DriverSigEventChange event will trigger for this event id.

Public fieldStatic memberThreeByteCommandResponseReceivedEventId The state of ThreeByteCommandResponseFeedback has changed.

The DriverSigEventChange event will trigger for this event id.

Public fieldStatic memberThreeByteCommandResponseValidFeedbackEventId The state of ThreeByteCommandResponseValidFeedback has changed.

The DriverSigEventChange event will trigger for this event id.

Public fieldStatic memberTwoByteCommandNoResponseFeedbackEventId The state of TwoByteCommandNoResponseFeedback has changed.

The DriverSigEventChange event will trigger for this event id.

Public fieldStatic memberTwoByteCommandResponseReceivedEventId The state of TwoByteCommandResponseFeedback has changed.

The DriverSigEventChange event will trigger for this event id.

Public fieldStatic memberTwoByteCommandResponseValidFeedbackEventId The state of TwoByteCommandResponseValidFeedback has changed.

The DriverSigEventChange event will trigger for this event id.

Top

Version Information

.NET

Supported in: 6.0

.NET Compact Framework

Supported in: 3.5
See Also