Click or drag to resize

DliDriverBase Class

Base class for DLI Driver Class.

This class will trigger BaseEvent and DriverSigEventChange events.

Inheritance Hierarchy
SystemObject
  Crestron.SimplSharpPro.LightingDliDriverBase
    Crestron.SimplSharpPro.LightingDliDriver

Namespace: Crestron.SimplSharpPro.Lighting
Assembly: Crestron.SimplSharpPro.Lighting (in Crestron.SimplSharpPro.Lighting.dll) Version: 2.21.121
Syntax
C#
public class DliDriverBase : IDimmingLoadInfo, 
	IBasicDimmingLoadInfo, IParentInformation

The DliDriverBase type exposes the following members.

Properties
 NameDescription
Public propertyDeviceLoadIsOn Returns the GenericBase device the DliDriver is on.
Public propertyEnableTcLevelRep Property to set enable the Tc Level reporting of the DliDriver.
Public propertyExtendedTypeFeedback Property to report the extended type of the DliDriver.

The DriverSigEventChange event will trigger with [!:DinDliBase.ExtendedTypeFeedbackEventId].

Public propertyGTINFeedback Property that reports the GTIN of the DliDriver
Public propertyInGroupFeedback Property to indicate if the DliDriver is a member or not, of the current group selected by AddToGroup(UInt16) or RemoveFromGroup(UInt16).

The DriverSigEventChange event will trigger with InGroupFeedbackEventId.

Read this property value from the event handler when the event is triggered for the event ID InGroupFeedbackEventId.
Public propertyLampFailureFeedback Property to report lamp failure at the DliDriver.

The DriverSigEventChange event will trigger with LampFailureFeedbackEventId.

Public propertyLevel Property to set the brightness level for the DliDriver.
Public propertyLevelFeedback Property to report the current brightness level for the DliDriver.

The DriverSigEventChange event will trigger with LevelFeedbackEventId.

Public propertyLevelReportingEnable Property to enable the driver level reporting through LevelFeedback for the DliDriver. true: Level reporting enabled; false: Level reporting not enabled
Public propertyLower Property to lower the light level of the DliDriver using the ramp rate defined in the DliDriver.
Public propertyMissingFeedback Property to indicate that the DliDriver has failed to report as part of the polling cycle.

The DriverSigEventChange event will trigger with MissingFeedbackEventId.

Public propertyNumberDliDriver number
Public propertyParent The parent that a DliDriver object was added to.
Public propertyRaise Property to raise the light level of the DliDriver using the ramp rate defined in the DliDriver.
Public propertyStatusFeedback Property which is an 8-bit value that reports the status of the DliDriver. The high-order byte is ignored.

The DriverSigEventChange event will trigger with StatusReceivedEventId.

Public propertyTcCapableFeedback Property to indicate that the DliDriver is Tc capable.

The DriverSigEventChange event will trigger with TcCapableFeedbackEventId.

Public propertyTcLevel Property to set the Tc level of DliDriver.
Public propertyTcLevelFeedback Property to indicate that the DliDriver is Tc Level Out.

The DriverSigEventChange event will trigger with TcLevelFeedbackEventId.

Public propertyTcLower Property to lower the Tc level of the DliDriver using the ramp rate defined in the DliDriver.
Public propertyTcRaise Property to raise the Tc level of the DliDriver using the ramp rate defined in the DliDriver.
Public propertyTcRangeCoolest Property to set the coolest Tc range of DliDriver.
Public propertyTcRangeCoolestFeedback Property to report that the DliDriver current coolest Tc range.

The DriverSigEventChange event will trigger with TcRangeCoolestFeedbackEventId.

Public propertyTcRangePhysicalCoolestFeedback Property to report that the DliDriver current physical coolest Tc range.

The DriverSigEventChange event will trigger with TcRangePhysicalCoolestFeedbackEventId.

Public propertyTcRangePhysicalWarmestFeedback Property to report that the DliDriver current physical warmest Tc range.

The DriverSigEventChange event will trigger with TcRangePhysicalWarmestFeedbackEventId.

Public propertyTcRangeWarmest Property to set the warmest Tc range of DliDriver.
Public propertyTcRangeWarmestFeedback Property to report that the DliDriver current warmest Tc range.

The DriverSigEventChange event will trigger with TcRangePhysicalWarmestFeedbackEventId.

Public propertyTypeFeedback Property to report the type of the DliDriver.

The DriverSigEventChange event will trigger with [!:DinDliBase.TypeFeedbackEventId].

Public propertyUserSpecifiedObject Can be assigned anything that user wants.
Top
Methods
 NameDescription
Public methodAddToGroup Method to add the DliDriver to the group number specified. Valid values are Group0 to Group15. If the invalid group number is passed it will be ignored.
Public methodEqualsDetermines whether the specified object is equal to the current object.
(Inherited from Object)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object)
Public methodFullOff Method to turn off the DliDriver.
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)
Public methodRemoveFromGroup Method to remove the DliDriver from the group number specified. Valid values are Group0 to Group15. If the invalid group number is passed it will be ignored.
Public methodToStringReturns a string that represents the current object.
(Inherited from Object)
Top

Version Information

.NET

Supported in: 6.0

.NET Compact Framework

Supported in: 3.5
See Also