Gls |
This class will trigger BaseEvent and GlsOccupancySensorChange events.
public class GlsOccupancySensorBase : GenericDevice, IGlsCenOcc, ICommonOccupancySensorInfo, IGlsOccupancySensorsCommonSigs
The GlsOccupancySensorBase type exposes the following members.
| Name | Description | |
|---|---|---|
| CommandReceivedFeedbackSigs |
Property to return a collection of Sigs each corresponding to an command number. Each BoolOutputSig is toggled when the IR receiver hears the corresponding command number.
The GlsOccupancySensorChange event will trigger with CommandReceivedFeedbackEventId. This property is not supported by "GlsOirLclCCn" device. | |
| 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) | |
| CurrentTimeoutFeedback |
Property to indicate which timeout being used by the sensor.
The BaseEvent event will trigger with TimeoutFeedbackEventId. | |
| DecrementPirSensitivityInOccupiedState | Property to decrease PIR sensitivity while sensor is in occupied state by 1. | |
| DecrementPirSensitivityInVacantState | Property to decrease the PIR sensitivity while sensor is in vacant state by 1. | |
| Description |
Get/Set the description of this device.
(Inherited from GenericBase) | |
| DisableLedFlash | Property to disable the red feedback LED from blinking when motion is detected. | |
| DisablePir | Property to disable the PIR Sensor. | |
| DisableShortTimeout | Property to disable the short timeout functionality. | |
| Disposed |
Property to indicate if the device has been disposed.
(Inherited from GenericDevice) | |
| EnableLedFlash | Property to enable the red feedback LEDs. | |
| EnablePir | Property to enable the PIR Sensor. | |
| EnableRawStates | Property to enable RawOccupancyFeedback property. | |
| EnableShortTimeout | Property to enable a “walk-through” mode for a shorter timeouts upon periods of minimal occupancy. | |
| EnableToReceiveIrOutputs | Property to enable the IR outputs. This property is not supported by "GlsOirLclCCn" device. | |
| ExternalPhotoSensorMinimumChange | Property to set the minimum change in lux that the external Photosensor must see before reporting a new value. This property is not supported by "GlsOirLclCCn" device. | |
| ExternalPhotoSensorValueFeedback |
Property to report the external photosensor value.
The BaseEvent event will trigger with ExternalPhotoSensorValueFeedbackEventId. This property is not supported by "GlsOirLclCCn" device. | |
| ForceOccupied | Property to force the device to report that the room is occupied even if the infrared sensor does not detect motion. | |
| ForceVacant | Property to force the sensor into the state of vacancy. | |
| GraceOccupancyDetectedFeedback |
Property to indicate occupancy event detected within 15s of initial vacancy event.
The BaseEvent event will trigger with GraceOccupancyDetectedFeedbackEventId. | |
| ID |
Property to get the ID of the device.
(Inherited from GenericDevice) | |
| IncrementPirSensitivityInOccupiedState | Property to increase the PIR sensitivity while sensor is in occupied state by 1. | |
| IncrementPirSensitivityInVacantState | Property to increase the PIR sensitivity while sensor is in vacant state by 1. | |
| InternalPhotoSensorMinimumChange | Property to set the minimum change in value that the internal Photosensor must sense before reporting a new value. | |
| InternalPhotoSensorValueFeedback |
Property to report the internal photosensor value.
The BaseEvent event will trigger with InternalPhotoSensorValueFeedbackEventId. | |
| IsOnline |
Property to get the current online state of the device.
(Inherited from GenericDevice) | |
| LedFlashEnabledFeedback |
Property to indicate if feedback LED is enabled or disabled.
The GlsOccupancySensorChange event will trigger with LedFlashEnabledFeedbackEventId. | |
| LocalTimeoutFeedback |
Property to report the timeout set from the IR remote.
The BaseEvent event will trigger with TimeoutLocalFeedbackEventId. | |
| Name |
Get the name of this device.
(Inherited from GenericBase) | |
| OccupancyDetectedFeedback |
Property to indicate when the room is occupied.
The BaseEvent event will trigger with RoomOccupiedFeedbackEventId. | |
| Parent |
The parent that a given object was added to.
(Inherited from GenericBase) | |
| PassiveInfraredSensorEnabledFeedback |
Property to report if the PIR Sensor is enabled.
The GlsOccupancySensorChange event will trigger with PirEnabledFeedbackEventId. | |
| PirEnabledFeedback |
Property to report if the PIR Sensor is enabled.
The GlsOccupancySensorChange event will trigger with PirEnabledFeedbackEventId. | |
| PirSensitivityInOccupiedStateFeedback |
Property to report Sensitivity level for PIR while sensor is in occupied state.
The GlsOccupancySensorChange event will trigger with PirSensitivityInOccupiedStateFeedbackEventId. | |
| PirSensitivityInVacantStateFeedback |
Property to report Sensitivity level for PIR while sensor is in vacant state.
The GlsOccupancySensorChange event will trigger with PirSensitivityInVacantStateFeedbackEventId. | |
| RawOccupancyFeedback |
Property to return the current occupancy status.
The BaseEvent event will trigger with RawOccupancyFeedbackEventId. | |
| 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) | |
| RemoteTimeout | Property to set a dynamic timeout. | |
| ShortTimeoutEnabledFeedback |
Property to report if the short timeout functionality has been enabled.
The GlsOccupancySensorChange event will trigger with ShortTimeoutEnabledFeedbackEventId. | |
| SIMPLDeviceImplementation |
Internal protected member used for actual device control.
(Inherited from GenericDevice) | |
| SystemAddressReceivedFeedback |
Property to return the system address heard by the IR receiver.
The GlsOccupancySensorChange event will trigger with SystemAddressReceivedFeedbackEventId. This property is not supported by "GlsOirLclCCn" device. | |
| 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) | |
| VacancyDetectedFeedback |
Property to indicate when the room is vacant.
The BaseEvent event will trigger with RoomVacantFeedbackEventId. | |
| 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 | |
|---|---|---|
| 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) | |
| 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) | |
| Register |
Register this device with the system.
(Inherited from GenericDevice) | |
| 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) |
| Name | Description | |
|---|---|---|
| BaseEvent |
Generic base event, triggered when the there are no other handlers available
for a specific EventID.
(Inherited from GenericBase) | |
| GlsOccupancySensorChange |
Event triggered when the GLS Cresnet Occupancy Sensor reports information to the Control System.
Valid event IDs are available in GlsOccupancySensorBase | |
| 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) | |
| OnlineStatusChange |
Event triggered when the Online status of the device changes.
(Inherited from GenericDevice) |
| Name | Description | |
|---|---|---|
| AndWhenOccupiedFeedbackEventId |
The state of "CenOdtCPoe.AndWhenOccupiedFeedback" has changed.
The GlsOccupancySensorChange event will trigger for this event id. | |
| AndWhenVacatedFeedbackEventId |
The state of AndWhenVacatedFeedback or "CenOdtCPoe.AndWhenVacatedFeedback" has changed.
The GlsOccupancySensorChange event will trigger for this event id. | |
| BrightToDarkThresholdFeedbackEventId |
The value of "CenOdtCPoe.BrightToDarkThresholdFeedback" has changed.
The GlsOccupancySensorChange event will trigger for this event id. | |
| CommandReceivedFeedbackEventId |
The state of one of the CommandReceivedFeedbackSigs has changed.
The GlsOccupancySensorChange event will trigger for this event id with the SigIndex property set to the sig that changed. | |
| DarkToBrightThresholdFeedbackEventId |
The value of "CenOdtCPoe.DarkToBrightThresholdFeedback" has changed.
The GlsOccupancySensorChange event will trigger for this event id. | |
| ExternalPhotoSensorValueFeedbackEventId |
The value of ExternalPhotoSensorValueFeedback has changed.
The BaseEvent event will trigger for this event id. | |
| GraceOccupancyDetectedFeedbackEventId |
The state of GraceOccupancyDetectedFeedback or "CenOdtCPoe.GraceOccupancyDetectedFeedback" has changed.
The BaseEvent event will trigger for this event id. | |
| IdentityOnFeedbackEventId |
The state of "CenOdtCPoe.IdentityOnFeedback" has changed.
The GlsOccupancySensorChange event will trigger for this event id. | |
| InternalPhotoSensorMinimumChangeFeedbackEventId |
The value of "CenOdtCPoe.InternalPhotoSensorMinimumChangeFeedback" has changed.
The GlsOccupancySensorChange event will trigger for this event id. | |
| InternalPhotoSensorValueFeedbackEventId |
The value of InternalPhotoSensorValueFeedback or "CenOdtCPoe.InternalPhotoSensorValueFeedback" has changed.
The BaseEvent event will trigger for this event id. | |
| LedFlashEnabledFeedbackEventId |
The state of LedFlashEnabledFeedback or "CenOdtCPoe.LedFlashEnabledFeedback" has changed.
The GlsOccupancySensorChange event will trigger for this event id. | |
| OrWhenOccupiedFeedbackEventId |
The state of "CenOdtCPoe.OrWhenOccupiedFeedback" has changed.
The GlsOccupancySensorChange event will trigger for this event id. | |
| OrWhenVacatedFeedbackEventId |
The state of OrWhenVacatedFeedback or "CenOdtCPoe.OrWhenVacatedFeedback" has changed.
The GlsOccupancySensorChange event will trigger for this event id. | |
| PirEnabledFeedbackEventId |
The state of PirEnabledFeedback or "CenOdtCPoe.PassiveInfraredSensorEnabledFeedback" has changed.
The GlsOccupancySensorChange event will trigger for this event id. | |
| PirSensitivityInOccupiedStateFeedbackEventId |
The value of PirSensitivityInOccupiedStateFeedback or "CenOdtCPoe.PassiveInfraredSensorSensitivityInOccupiedStateFeedback" has changed.
The GlsOccupancySensorChange event will trigger for this event id. | |
| PirSensitivityInVacantStateFeedbackEventId |
The value of PirSensitivityInVacantStateFeedback or "CenOdtCPoe.PassiveInfraredSensorSensitivityInVacantStateFeedback" has changed.
The GlsOccupancySensorChange event will trigger for this event id. | |
| RawOccupancyFeedbackEventId |
The state of RawOccupancyFeedback or "CenOdtCPoe.RawOccupancyDetectedFeedback" has changed.
The BaseEvent event will trigger for this event id. | |
| RawOccupancyPirFeedbackEventId |
The state of RawOccupancyPirFeedback or "CenOdtCPoe.RawOccupancyDetectedByPassiveInfraredSensorFeedback" has changed.
The BaseEvent event will trigger for this event id. | |
| RawOccupancyUsFeedbackEventId |
The state of RawOccupancyUsFeedback or "CenOdtCPoe.RawOccupancyDetectedByUltrasonicSensorFeedback" has changed.
The BaseEvent event will trigger for this event id. | |
| RawStatesEnabledFeedbackEventId |
The state of "CenOdtCPoe.RawStatesEnabledFeedback" has changed.
The GlsOccupancySensorChange event will trigger for this event id. | |
| RoomIsBrightFeedbackEventId |
The state of "CenOdtCPoe.RoomIsBrightFeedback" has changed.
The GlsOccupancySensorChange event will trigger for this event id. | |
| RoomIsDarkFeedbackEventId |
The state of "CenOdtCPoe.RoomIsDarkFeedback" has changed.
The GlsOccupancySensorChange event will trigger for this event id. | |
| RoomOccupiedFeedbackEventId |
The state of OccupancyDetectedFeedback or "CenOdtCPoe.OccupancyDetectedFeedback" has changed.
The BaseEvent event will trigger for this event id. | |
| RoomVacantFeedbackEventId |
The state of VacancyDetectedFeedback or "CenOdtCPoe.VacancyDetectedFeedback" has changed.
The BaseEvent event will trigger for this event id. | |
| ShortTimeoutEnabledFeedbackEventId |
The state of ShortTimeoutEnabledFeedback or "CenOdtCPoe.ShortTimeoutEnabledFeedback" has changed.
The GlsOccupancySensorChange event will trigger for this event id. | |
| SystemAddressReceivedFeedbackEventId |
The value of SystemAddressReceivedFeedback has changed.
The GlsOccupancySensorChange event will trigger for this event id. | |
| TimeoutFeedbackEventId |
The value of CurrentTimeoutFeedback or "CenOdtCPoe.CurrentTimeoutFeedback" has changed.
The BaseEvent event will trigger for this event id. | |
| TimeoutLocalFeedbackEventId |
The value of LocalTimeoutFeedback has changed.
The BaseEvent event will trigger for this event id. | |
| UsAEnabledFeedbackEventId |
The state of UsAEnabledFeedback or "CenOdtCPoe.UltrasonicSensorSideAEnabledFeedback" has changed.
The GlsOccupancySensorChange event will trigger for this event id. | |
| UsBEnabledFeedbackEventId |
The state of UsBEnabledFeedback or "CenOdtCPoe.UltrasonicSensorSideBEnabledFeedback" has changed.
The GlsOccupancySensorChange event will trigger for this event id. | |
| UsSensitivityInOccupiedStateFeedbackEventId |
The value of UsSensitivityInOccupiedStateFeedback or "CenOdtCPoe.UltrasonicSensorSensitivityInOccupiedStateFeedback" has changed.
The GlsOccupancySensorChange event will trigger for this event id. | |
| UsSensitivityInVacantStateFeedbackEventId |
The value of UsSensitivityInVacantStateFeedback or "CenOdtCPoe.UltrasonicSensorSensitivityInVacantStateFeedback" has changed.
The GlsOccupancySensorChange event will trigger for this event id. |