Glpp |
public class GlppBase : LightingBase, IButton, ICommonOccupancySensorInfo
The GlppBase type exposes the following members.
| Name | Description | |
|---|---|---|
| Button | Get the collection of the Button objects for this device. | |
| CommandReceivedFeedbacks | Property to indicate that the corresponding button on the IR remote has been pressed. | |
| ConnectedIpList |
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) | |
| ContactClosure | Get the Button object corresponding to the ContactClosure button for this device. | |
| CurrentTimeoutFeedback |
Property to report the current timeout period.
The GlppOccupancySensorIrChange event will trigger with TimeoutFeedbackEventId. | |
| DaylightingActiveFeedback | Property to indicate the status of daylighting. | |
| DefeatLocalButtonLogic | Property to disable local button logic. | |
| DefeatLocalMotionLogic | Property to disable all local (internal, factory-programmed) occupancy sensor logic. | |
| DefeatLocalPhotocellLogic | Property to disable all local (internal, factory-programmed) photocell logic. | |
| Description |
Get/Set the description of this device.
(Inherited from GenericBase) | |
| DisableNightlightMode | Property to turn off LED "nightlight" mode. | |
| Disposed |
Property to indicate if the device has been disposed.
(Inherited from GenericDevice) | |
| EnableRawMotionData | Property to enable raw motion data reporting. | |
| EnableRawPhotocellData | Property to enable raw photocell data reporting. | |
| ID |
Property to get the ID of the device.
(Inherited from GenericDevice) | |
| IsOnline |
Property to get the current online state of the device.
(Inherited from GenericDevice) | |
| Name |
Get the name of this device.
(Inherited from GenericBase) | |
| NumberOfLoads | The number of Lighting Loads for the GLPP Series Device. | |
| OccupancyActionFeedback | Property to report the currently selected occupancy action, which will be triggered when the room goes from the unoccupied to the occupied state. | |
| OccupancyDetectedFeedback |
Property to indicate the occupancy status of the room.
The GlppOccupancySensorIrChange event will trigger with RoomIsOccupiedFeedbackEventId. | |
| OffLastRecallFeedback | Property to indicate that the last preset that have been recalled is set to off. | |
| OnLastRecallFeedback | Property to indicate that the last preset that have been recalled is set to on. | |
| OutputEnable | Property to allow the IR remote button presses to be reported. | |
| Parent |
The parent that a given object was added to.
(Inherited from GenericBase) | |
| PhotocellLoads | Photocell Loads of the GLPP Series Device. | |
| PhotoSensorResponseTimeFeedback | Property to report the photo sensor response time (adjusted by the "IncreaseResponseTime/DecreaseResponseTime" methods). | |
| PhotoSensorValueFeedback | Property to report the raw photo sensor value if the "EnableRawPhotocellData" property value is true. | |
| Presets | Collection of Presets for the GLPP Series Device. | |
| ProductIdFeedback | Property to report the device's Product ID. Internal use only. | |
| RawOccupancyStateFeedback | Property to track the state of the occupancy sensor, when raw motion data is enabled. | |
| Registerable |
Property to indicate that this device can be registered.
(Inherited from GenericDevice) | |
| Registered |
Property to get the current registration state of the device.
(Inherited from GenericDevice) | |
| RegistrationFailureReason |
Property to get the Registration Failure Reason, this will match the return value from the call to register.
(Inherited from GenericDevice) | |
| RemoteSwitchType | Property to specify the type of 3rd party switch attached to the Keypad+/- terminal of the GLPP device. | |
| RemoteTimeout | 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. | |
| SetLedOn | Property to set the feedback state of the GLPAA keypad LED indicator to ON. | |
| SetOccupancyAction | 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. | |
| SetVacatingAction | 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. | |
| SIMPLDeviceImplementation |
Internal protected member used for actual device control.
(Inherited from GenericDevice) | |
| SystemAddressReceivedFeedback | Property to report the IR ID of the IR remote. Reported values will range from 0d (IRID 00) to 31d (IRID 0x1F). | |
| Type |
Property to determine to type of device this is.
(Inherited from GenericDevice) | |
| UnRegistrationFailureReason |
Property to get the Unregistration Failure Reason, this will match the return value from the call to unregister.
(Inherited from GenericDevice) | |
| UserSpecifiedObject |
Can be assigned anything that user wants.
(Inherited from GenericBase) | |
| VacatingActionFeedback | Property to report the currently selected vacating action, which will be triggered when the room goes from the occupied to the unoccupied state. | |
| XioEndpointStubSIMPLDevice |
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) |
| Name | Description | |
|---|---|---|
| DecreaseResponseTime | 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. | |
| DecreaseTimeout | Method to decrement the pre-defined timeout period as follows: 30m, 10m, 5m, 2m, 1m, 30s and 0s. | |
| Dispose |
Clean up of resources.
(Inherited from GenericBase) | |
| Dispose(Boolean) |
Method to perform the actual disposing of the device.
(Inherited from GenericDevice) | |
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object) | |
| Finalize |
Destructor of the device.
(Inherited from GenericDevice) | |
| GetHashCode | Serves as the default hash function. (Inherited from Object) | |
| GetType | Gets the Type of the current instance. (Inherited from Object) | |
| IncreaseResponseTime | 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. | |
| IncreaseTimeout | Method to increment the pre-defined timeout period, as follows: 0s, 30s, 1m, 2m, 5m, 10m and 30m. | |
| InitializeDevice | Method to initialize the GLPP Series device. | |
| InitializeInputs | Method to initialize input Sig information of the GLPP Series Devices. | |
| InitializeOutputs | Method to initialize the output Sig information of the GLPP Series Device. | |
| InitializeSpecificGlppDevice | Method used to initialize specific information of the GLPP Series Device from the derived classes. | |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object) | |
| OnBaseEvent(Int32) |
Protected member used to fire the BaseEvent with the default extended information.
(Inherited from GenericBase) | |
| OnBaseEvent(Int32, UInt16) |
Protected member used to fine the BaseEvent with extended event information.
(Inherited from GenericBase) | |
| OnLoadStateChange |
Method to fire the LoadStateChange event.
(Inherited from LightingBase) | |
| Register |
Register this device with the system.
(Inherited from GenericDevice) | |
| SendParameters |
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) | |
| SetLoadsOff | Method to turn Off all loads. | |
| ToString |
Return the name of the device.
(Inherited from GenericDevice) | |
| UnRegister |
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) | |
| VerifyRfParameters | Method to verify the Parameters passed by the user to the actual infiNET EX based GLPP device class. |
| Name | Description | |
|---|---|---|
| BaseEvent |
Generic base event, triggered when the there are no other handlers available
for a specific EventID.
(Inherited from GenericBase) | |
| ButtonStateChange | Event fired when a button state change was received from the device. | |
| GlppOccupancySensorIrChange | Event triggered when the GLPP Series Device reports Occupancy Sensor or IR Settings information to the Control System. | |
| GlppPhotocellChange | Event triggered when the GLPP Series Device reports Photocell Settings information to the Control System. | |
| IpInformationChange |
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) | |
| LoadStateChange |
Event triggered when information from a load is received.
EventIds for this event are located in the LoadEventIds class.
(Inherited from LightingBase) | |
| OnlineStatusChange |
Event triggered when the Online status of the device changes.
(Inherited from GenericDevice) | |
| PresetChange | Event to indicate when preset information is received from the load. |
| Name | Description | |
|---|---|---|
| _DayLevelClosedLoopFeedback | Storage of the DayLevelClosedLoopFeedback Sig for GLPP Dimmers. | |
| _DayPhotoValueClosedLoopFeedback | Storage of the DayPhotoValueClosedLoopFeedback Sig for GLPP Dimmers. | |
| _DecreasePresetFadeTime | Storage of the DecreasePresetFadeTime Sig for GLPP Dimmers. | |
| _DecreaseRampTime | Storage of the DecreaseRampTime Sig for GLPP Dimmers. | |
| _IncreasePresetFadeTime | Storage of the IncreasePresetFadeTime Sig for GLPP Dimmers. | |
| _IncreaseRampTime | Storage of the IncreaseRampTime Sig for GLPP Dimmers. | |
| _LoadCurrentFeedback | Storage of the LoadCurrentFeedback Sig for GLPP Dimmers. | |
| _LoadCurrentMinimumChange | Storage of the LoadCurrentMinimumChange Sig for GLPP Dimmers. | |
| _Loads | Internal storage for collection of Lighting loads. | |
| _LoadsFastFullOn | Storage of the LoadsFastFullOn Sig for GLPP Dimmers. | |
| _LoadsFullOn | Storage of the LoadsFullOn Sig for GLPP Dimmers. | |
| _LoadsOn | Storage of the LoadsOn Sig for GLPP Switches. | |
| _MasterLower | Storage of the MasterLower Sig for GLPP Dimmers. | |
| _MasterRaise | Storage of the MasterRaise Sig for GLPP Dimmers. | |
| _MinimumLevelClosedLoopFeedback | Storage of the MinimumLevelClosedLoopFeedback Sig for GLPP Dimmers. | |
| _NightLevelClosedLoopFeedback | Storage of the NightLevelClosedLoopFeedback Sig for GLPP Dimmers. | |
| _NightPhotoValueClosedLoopFeedback | Storage of the NightPhotoValueClosedLoopFeedback Sig for GLPP Dimmers. | |
| _PhotocellLoads | Internal storage for collection of Photocell Loads. | |
| _PresetFadeTimeFeedback | Storage of the PresetFadeTimeFeedback Sig for GLPP Dimmers. | |
| _RampTimeFeedback | Storage of the RampTimeFeedback Sig for GLPP Dimmers. | |
| _SetDayLevelClosedLoop | Storage of the SetDayLevelClosedLoop Sig for GLPP Series Devices. | |
| _SetMinimumLevelClosedLoop | Storage of the SetMinimumLevelClosedLoop Sig for GLPP Dimmers. | |
| _SetNightLevelClosedLoop | Storage of the SetNightLevelClosedLoop Sig for GLPP Series Devices. | |
| _SetPresetFadeTime | Storage of the SetPresetFadeTime Sig for GLPP Dimmers. | |
| _SetRampTime | Storage of the SetRampTime Sig for GLPP Dimmers. | |
| InternalDevice | Actual Device class object for GLPP Series Devices. | |
| Load1DayPhotoValueOpenLoopFeedbackSigNumber | LoadDayPhotoValueOpenLoopFeedback sig number for Load1 for GLPP Series Device. | |
| Load1IsOnFeedbackSigNumber | LoadIsOnFeedback sig number for Load1 for GLPP Series Device. | |
| Load1MinimumLevelOpenLoopFeedbackSigNumber | LoadMinimumLevelOpenLoopFeedback sig number for Load1 for GLPP Series Device. | |
| Load1NightLevelOpenLoopFeedbackSigNumber | LoadDayNightLevelOpenLoopFeedback sig number for Load1 for GLPP Series Device. | |
| Load1NightPhotoValueOpenLoopFeedbackSigNumber | LoadNightPhotoValueOpenLoopFeedback sig number for Load1 for GLPP Series Device. | |
| Load1OffSigNumber | LoadOff sig number for Load1 for GLPP Series Device. | |
| Load1OnSigNumber | LoadOn sig number for Load1 for GLPP Series Device. | |
| NumberOfIrCommands | The number of IR Commands for the GLPP Series Device. | |
| NumberOfPresets | The number of Lighting Presets for the GLPP Series Device. | |
| PhotocellSettings | Reference to the GLPP Device Photocell Settings. | |
| SetLoad1DayLevelOpenLoopSigNumber | SetDayLevelOpenLoop sig number for Load1 for GLPP Series Device. | |
| SetLoad1NightLevelOpenLoopSigNumber | SetNightLevelOpenLoop sig number for Load1 for GLPP Series Device. |