Click or drag to resize

GlppBase Class

GLPP Devices: Base class for GLPP Series Devices.
Inheritance Hierarchy

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

The GlppBase type exposes the following members.

Constructors
 NameDescription
Protected methodGlppBase Constructor for GLPP Series Devices base class.
Top
Properties
 NameDescription
Public propertyButton Get the collection of the Button objects for this device.
Public propertyCommandReceivedFeedbacks Property to indicate that the corresponding button on the IR remote has been pressed.
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 propertyContactClosure Get the Button object corresponding to the ContactClosure button for this device.
Public propertyCurrentTimeoutFeedback Property to report the current timeout period.

The GlppOccupancySensorIrChange event will trigger with TimeoutFeedbackEventId.

Public propertyDaylightingActiveFeedback Property to indicate the status of daylighting.
Public propertyDefeatLocalButtonLogic Property to disable local button logic.
Public propertyDefeatLocalMotionLogic Property to disable all local (internal, factory-programmed) occupancy sensor logic.
Public propertyDefeatLocalPhotocellLogic Property to disable all local (internal, factory-programmed) photocell logic.
Public propertyCode exampleDescription Get/Set the description of this device.
(Inherited from GenericBase)
Public propertyDisableNightlightMode Property to turn off LED "nightlight" mode.
Public propertyDisposed Property to indicate if the device has been disposed.
(Inherited from GenericDevice)
Public propertyEnableRawMotionData Property to enable raw motion data reporting.
Public propertyEnableRawPhotocellData Property to enable raw photocell data reporting.
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 propertyName Get the name of this device.
(Inherited from GenericBase)
Public propertyNumberOfLoads The number of Lighting Loads for the GLPP Series Device.
Public propertyOccupancyActionFeedback Property to report the currently selected occupancy action, which will be triggered when the room goes from the unoccupied to the occupied state.
Public propertyOccupancyDetectedFeedback Property to indicate the occupancy status of the room.

The GlppOccupancySensorIrChange event will trigger with RoomIsOccupiedFeedbackEventId.

Public propertyOffLastRecallFeedback Property to indicate that the last preset that have been recalled is set to off.
Public propertyOnLastRecallFeedback Property to indicate that the last preset that have been recalled is set to on.
Public propertyOutputEnable Property to allow the IR remote button presses to be reported.
Public propertyParent The parent that a given object was added to.
(Inherited from GenericBase)
Public propertyPhotocellLoads Photocell Loads of the GLPP Series Device.
Public propertyPhotoSensorResponseTimeFeedback Property to report the photo sensor response time (adjusted by the "IncreaseResponseTime/DecreaseResponseTime" methods).
Public propertyPhotoSensorValueFeedback Property to report the raw photo sensor value if the "EnableRawPhotocellData" property value is true.
Public propertyPresets Collection of Presets for the GLPP Series Device.
Public propertyProductIdFeedback Property to report the device's Product ID. Internal use only.
Public propertyRawOccupancyStateFeedback Property to track the state of the occupancy sensor, when raw motion data is enabled.
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 propertyRemoteSwitchType Property to specify the type of 3rd party switch attached to the Keypad+/- terminal of the GLPP device.
Public propertyRemoteTimeout Property to set the timeout period, which is the interval that must elapse with no motion detected before the state of the room changes from occupied to unoccupied.
Public propertySetLedOn Property to set the feedback state of the GLPAA keypad LED indicator to ON.
Public propertySetOccupancyAction Property to set the action that will be triggered when the room goes from the unoccupied to the occupied state. The valid values for the action are defined in eOccupancyActions Enum.
Public propertySetVacatingAction Property to set the action that will be triggered when the room goes from the occupied to the unoccupied state. The valid values for the action are defined in eVacatingActions Enum.
Protected propertySIMPLDeviceImplementation Internal protected member used for actual device control.
(Inherited from GenericDevice)
Public propertySystemAddressReceivedFeedback Property to report the IR ID of the IR remote. Reported values will range from 0d (IRID 00) to 31d (IRID 0x1F).
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)
Public propertyVacatingActionFeedback Property to report the currently selected vacating action, which will be triggered when the room goes from the occupied to the unoccupied state.
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 methodDecreaseResponseTime Method to decrement the pre-defined response time (the time to fade to a new daylighting level, based on a change to a photocell value), as follows: 1s, 30s, 1m, 5m. 10m and 30m.
Public methodDecreaseTimeout Method to decrement the pre-defined timeout period as follows: 30m, 10m, 5m, 2m, 1m, 30s and 0s.
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)
Public methodIncreaseResponseTime Method to increment the pre-defined response time (the time to fade to a new daylighting level, based on a change to a photocell value), as follows: 1s, 30s, 1m, 5m, 10m and 30m.
Public methodIncreaseTimeout Method to increment the pre-defined timeout period, as follows: 0s, 30s, 1m, 2m, 5m, 10m and 30m.
Protected methodInitializeDevice Method to initialize the GLPP Series device.
Protected methodInitializeInputs Method to initialize input Sig information of the GLPP Series Devices.
Protected methodInitializeOutputs Method to initialize the output Sig information of the GLPP Series Device.
Protected methodInitializeSpecificGlppDevice Method used to initialize specific information of the GLPP Series Device from the derived classes.
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 methodSetLoadsOff Method to turn Off all loads.
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)
Protected methodVerifyRfParameters Method to verify the Parameters passed by the user to the actual infiNET EX based GLPP device class.
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 eventGlppOccupancySensorIrChange Event triggered when the GLPP Series Device reports Occupancy Sensor or IR Settings information to the Control System.
Public eventGlppPhotocellChange Event triggered when the GLPP Series Device reports Photocell Settings information to the Control System.
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 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 eventPresetChange Event to indicate when preset information is received from the load.
Top
Fields
 NameDescription
Protected field_DayLevelClosedLoopFeedback Storage of the DayLevelClosedLoopFeedback Sig for GLPP Dimmers.
Protected field_DayPhotoValueClosedLoopFeedback Storage of the DayPhotoValueClosedLoopFeedback Sig for GLPP Dimmers.
Protected field_DecreasePresetFadeTime Storage of the DecreasePresetFadeTime Sig for GLPP Dimmers.
Protected field_DecreaseRampTime Storage of the DecreaseRampTime Sig for GLPP Dimmers.
Protected field_IncreasePresetFadeTime Storage of the IncreasePresetFadeTime Sig for GLPP Dimmers.
Protected field_IncreaseRampTime Storage of the IncreaseRampTime Sig for GLPP Dimmers.
Protected field_LoadCurrentFeedback Storage of the LoadCurrentFeedback Sig for GLPP Dimmers.
Protected field_LoadCurrentMinimumChange Storage of the LoadCurrentMinimumChange Sig for GLPP Dimmers.
Protected field_Loads Internal storage for collection of Lighting loads.
Protected field_LoadsFastFullOn Storage of the LoadsFastFullOn Sig for GLPP Dimmers.
Protected field_LoadsFullOn Storage of the LoadsFullOn Sig for GLPP Dimmers.
Protected field_LoadsOn Storage of the LoadsOn Sig for GLPP Switches.
Protected field_MasterLower Storage of the MasterLower Sig for GLPP Dimmers.
Protected field_MasterRaise Storage of the MasterRaise Sig for GLPP Dimmers.
Protected field_MinimumLevelClosedLoopFeedback Storage of the MinimumLevelClosedLoopFeedback Sig for GLPP Dimmers.
Protected field_NightLevelClosedLoopFeedback Storage of the NightLevelClosedLoopFeedback Sig for GLPP Dimmers.
Protected field_NightPhotoValueClosedLoopFeedback Storage of the NightPhotoValueClosedLoopFeedback Sig for GLPP Dimmers.
Protected field_PhotocellLoads Internal storage for collection of Photocell Loads.
Protected field_PresetFadeTimeFeedback Storage of the PresetFadeTimeFeedback Sig for GLPP Dimmers.
Protected field_RampTimeFeedback Storage of the RampTimeFeedback Sig for GLPP Dimmers.
Protected field_SetDayLevelClosedLoop Storage of the SetDayLevelClosedLoop Sig for GLPP Series Devices.
Protected field_SetMinimumLevelClosedLoop Storage of the SetMinimumLevelClosedLoop Sig for GLPP Dimmers.
Protected field_SetNightLevelClosedLoop Storage of the SetNightLevelClosedLoop Sig for GLPP Series Devices.
Protected field_SetPresetFadeTime Storage of the SetPresetFadeTime Sig for GLPP Dimmers.
Protected field_SetRampTime Storage of the SetRampTime Sig for GLPP Dimmers.
Protected fieldInternalDevice Actual Device class object for GLPP Series Devices.
Protected fieldStatic memberLoad1DayPhotoValueOpenLoopFeedbackSigNumber LoadDayPhotoValueOpenLoopFeedback sig number for Load1 for GLPP Series Device.
Protected fieldStatic memberLoad1IsOnFeedbackSigNumber LoadIsOnFeedback sig number for Load1 for GLPP Series Device.
Protected fieldStatic memberLoad1MinimumLevelOpenLoopFeedbackSigNumber LoadMinimumLevelOpenLoopFeedback sig number for Load1 for GLPP Series Device.
Protected fieldStatic memberLoad1NightLevelOpenLoopFeedbackSigNumber LoadDayNightLevelOpenLoopFeedback sig number for Load1 for GLPP Series Device.
Protected fieldStatic memberLoad1NightPhotoValueOpenLoopFeedbackSigNumber LoadNightPhotoValueOpenLoopFeedback sig number for Load1 for GLPP Series Device.
Protected fieldStatic memberLoad1OffSigNumber LoadOff sig number for Load1 for GLPP Series Device.
Protected fieldStatic memberLoad1OnSigNumber LoadOn sig number for Load1 for GLPP Series Device.
Public fieldStatic memberNumberOfIrCommands The number of IR Commands for the GLPP Series Device.
Public fieldStatic memberNumberOfPresets The number of Lighting Presets for the GLPP Series Device.
Protected fieldPhotocellSettings Reference to the GLPP Device Photocell Settings.
Protected fieldStatic memberSetLoad1DayLevelOpenLoopSigNumber SetDayLevelOpenLoop sig number for Load1 for GLPP Series Device.
Protected fieldStatic memberSetLoad1NightLevelOpenLoopSigNumber SetNightLevelOpenLoop sig number for Load1 for GLPP Series Device.
Top

Version Information

.NET

Supported in: 6.0

.NET Compact Framework

Supported in: 3.5
See Also