Click or drag to resize

GlsOccupancySensorBase Class

Base class for GLS Occupancy Sensors.

This class will trigger BaseEvent and GlsOccupancySensorChange events.

Inheritance Hierarchy

Namespace: Crestron.SimplSharpPro.GeneralIO
Assembly: Crestron.SimplSharpPro.GeneralIO (in Crestron.SimplSharpPro.GeneralIO.dll) Version: 2.21.121
Syntax
C#
public class GlsOccupancySensorBase : GenericDevice, 
	IGlsCenOcc, ICommonOccupancySensorInfo, IGlsOccupancySensorsCommonSigs

The GlsOccupancySensorBase type exposes the following members.

Properties
 NameDescription
Public propertyCommandReceivedFeedbackSigs 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.
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 propertyCurrentTimeoutFeedback Property to indicate which timeout being used by the sensor.

The BaseEvent event will trigger with TimeoutFeedbackEventId.

Public propertyDecrementPirSensitivityInOccupiedState Property to decrease PIR sensitivity while sensor is in occupied state by 1.
Public propertyDecrementPirSensitivityInVacantState Property to decrease the PIR sensitivity while sensor is in vacant state by 1.
Public propertyCode exampleDescription Get/Set the description of this device.
(Inherited from GenericBase)
Public propertyDisableLedFlash Property to disable the red feedback LED from blinking when motion is detected.
Public propertyDisablePir Property to disable the PIR Sensor.
Public propertyDisableShortTimeout Property to disable the short timeout functionality.
Public propertyDisposed Property to indicate if the device has been disposed.
(Inherited from GenericDevice)
Public propertyEnableLedFlash Property to enable the red feedback LEDs.
Public propertyEnablePir Property to enable the PIR Sensor.
Public propertyEnableRawStates Property to enable RawOccupancyFeedback property.
Public propertyEnableShortTimeout Property to enable a “walk-through” mode for a shorter timeouts upon periods of minimal occupancy.
Public propertyEnableToReceiveIrOutputs Property to enable the IR outputs. This property is not supported by "GlsOirLclCCn" device.
Public propertyExternalPhotoSensorMinimumChange 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.
Public propertyExternalPhotoSensorValueFeedback Property to report the external photosensor value.

The BaseEvent event will trigger with ExternalPhotoSensorValueFeedbackEventId.

This property is not supported by "GlsOirLclCCn" device.
Public propertyForceOccupied Property to force the device to report that the room is occupied even if the infrared sensor does not detect motion.
Public propertyForceVacant Property to force the sensor into the state of vacancy.
Public propertyGraceOccupancyDetectedFeedback Property to indicate occupancy event detected within 15s of initial vacancy event.

The BaseEvent event will trigger with GraceOccupancyDetectedFeedbackEventId.

Public propertyID Property to get the ID of the device.
(Inherited from GenericDevice)
Public propertyIncrementPirSensitivityInOccupiedState Property to increase the PIR sensitivity while sensor is in occupied state by 1.
Public propertyIncrementPirSensitivityInVacantState Property to increase the PIR sensitivity while sensor is in vacant state by 1.
Public propertyInternalPhotoSensorMinimumChange Property to set the minimum change in value that the internal Photosensor must sense before reporting a new value.
Public propertyInternalPhotoSensorValueFeedback Property to report the internal photosensor value.

The BaseEvent event will trigger with InternalPhotoSensorValueFeedbackEventId.

Public propertyIsOnline Property to get the current online state of the device.
(Inherited from GenericDevice)
Public propertyLedFlashEnabledFeedback Property to indicate if feedback LED is enabled or disabled.

The GlsOccupancySensorChange event will trigger with LedFlashEnabledFeedbackEventId.

Public propertyLocalTimeoutFeedback Property to report the timeout set from the IR remote.

The BaseEvent event will trigger with TimeoutLocalFeedbackEventId.

Public propertyName Get the name of this device.
(Inherited from GenericBase)
Public propertyOccupancyDetectedFeedback Property to indicate when the room is occupied.

The BaseEvent event will trigger with RoomOccupiedFeedbackEventId.

Public propertyParent The parent that a given object was added to.
(Inherited from GenericBase)
Public propertyPassiveInfraredSensorEnabledFeedback Property to report if the PIR Sensor is enabled.

The GlsOccupancySensorChange event will trigger with PirEnabledFeedbackEventId.

Public propertyPirEnabledFeedback Property to report if the PIR Sensor is enabled.

The GlsOccupancySensorChange event will trigger with PirEnabledFeedbackEventId.

Public propertyPirSensitivityInOccupiedStateFeedback Property to report Sensitivity level for PIR while sensor is in occupied state.

The GlsOccupancySensorChange event will trigger with PirSensitivityInOccupiedStateFeedbackEventId.

Public propertyPirSensitivityInVacantStateFeedback Property to report Sensitivity level for PIR while sensor is in vacant state.

The GlsOccupancySensorChange event will trigger with PirSensitivityInVacantStateFeedbackEventId.

Public propertyRawOccupancyFeedback Property to return the current occupancy status.

The BaseEvent event will trigger with RawOccupancyFeedbackEventId.

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 propertyRemoteTimeout Property to set a dynamic timeout.
Public propertyShortTimeoutEnabledFeedback Property to report if the short timeout functionality has been enabled.

The GlsOccupancySensorChange event will trigger with ShortTimeoutEnabledFeedbackEventId.

Protected propertySIMPLDeviceImplementation Internal protected member used for actual device control.
(Inherited from GenericDevice)
Public propertySystemAddressReceivedFeedback 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.
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 propertyVacancyDetectedFeedback Property to indicate when the room is vacant.

The BaseEvent event will trigger with RoomVacantFeedbackEventId.

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 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)
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 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 eventGlsOccupancySensorChange Event triggered when the GLS Cresnet Occupancy Sensor reports information to the Control System.

Valid event IDs are available in GlsOccupancySensorBase

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)
Top
Fields
 NameDescription
Public fieldStatic memberAndWhenOccupiedFeedbackEventId The state of "CenOdtCPoe.AndWhenOccupiedFeedback" has changed.

The GlsOccupancySensorChange event will trigger for this event id.

Public fieldStatic memberAndWhenVacatedFeedbackEventId The state of AndWhenVacatedFeedback or "CenOdtCPoe.AndWhenVacatedFeedback" has changed.

The GlsOccupancySensorChange event will trigger for this event id.

Public fieldStatic memberBrightToDarkThresholdFeedbackEventId The value of "CenOdtCPoe.BrightToDarkThresholdFeedback" has changed.

The GlsOccupancySensorChange event will trigger for this event id.

Public fieldStatic memberCommandReceivedFeedbackEventId 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.

Public fieldStatic memberDarkToBrightThresholdFeedbackEventId The value of "CenOdtCPoe.DarkToBrightThresholdFeedback" has changed.

The GlsOccupancySensorChange event will trigger for this event id.

Public fieldStatic memberExternalPhotoSensorValueFeedbackEventId The value of ExternalPhotoSensorValueFeedback has changed.

The BaseEvent event will trigger for this event id.

Public fieldStatic memberGraceOccupancyDetectedFeedbackEventId The state of GraceOccupancyDetectedFeedback or "CenOdtCPoe.GraceOccupancyDetectedFeedback" has changed.

The BaseEvent event will trigger for this event id.

Public fieldStatic memberIdentityOnFeedbackEventId The state of "CenOdtCPoe.IdentityOnFeedback" has changed.

The GlsOccupancySensorChange event will trigger for this event id.

Public fieldStatic memberInternalPhotoSensorMinimumChangeFeedbackEventId The value of "CenOdtCPoe.InternalPhotoSensorMinimumChangeFeedback" has changed.

The GlsOccupancySensorChange event will trigger for this event id.

Public fieldStatic memberInternalPhotoSensorValueFeedbackEventId The value of InternalPhotoSensorValueFeedback or "CenOdtCPoe.InternalPhotoSensorValueFeedback" has changed.

The BaseEvent event will trigger for this event id.

Public fieldStatic memberLedFlashEnabledFeedbackEventId The state of LedFlashEnabledFeedback or "CenOdtCPoe.LedFlashEnabledFeedback" has changed.

The GlsOccupancySensorChange event will trigger for this event id.

Public fieldStatic memberOrWhenOccupiedFeedbackEventId The state of "CenOdtCPoe.OrWhenOccupiedFeedback" has changed.

The GlsOccupancySensorChange event will trigger for this event id.

Public fieldStatic memberOrWhenVacatedFeedbackEventId The state of OrWhenVacatedFeedback or "CenOdtCPoe.OrWhenVacatedFeedback" has changed.

The GlsOccupancySensorChange event will trigger for this event id.

Public fieldStatic memberPirEnabledFeedbackEventId The state of PirEnabledFeedback or "CenOdtCPoe.PassiveInfraredSensorEnabledFeedback" has changed.

The GlsOccupancySensorChange event will trigger for this event id.

Public fieldStatic memberPirSensitivityInOccupiedStateFeedbackEventId The value of PirSensitivityInOccupiedStateFeedback or "CenOdtCPoe.PassiveInfraredSensorSensitivityInOccupiedStateFeedback" has changed.

The GlsOccupancySensorChange event will trigger for this event id.

Public fieldStatic memberPirSensitivityInVacantStateFeedbackEventId The value of PirSensitivityInVacantStateFeedback or "CenOdtCPoe.PassiveInfraredSensorSensitivityInVacantStateFeedback" has changed.

The GlsOccupancySensorChange event will trigger for this event id.

Public fieldStatic memberRawOccupancyFeedbackEventId The state of RawOccupancyFeedback or "CenOdtCPoe.RawOccupancyDetectedFeedback" has changed.

The BaseEvent event will trigger for this event id.

Public fieldStatic memberRawOccupancyPirFeedbackEventId The state of RawOccupancyPirFeedback or "CenOdtCPoe.RawOccupancyDetectedByPassiveInfraredSensorFeedback" has changed.

The BaseEvent event will trigger for this event id.

Public fieldStatic memberRawOccupancyUsFeedbackEventId The state of RawOccupancyUsFeedback or "CenOdtCPoe.RawOccupancyDetectedByUltrasonicSensorFeedback" has changed.

The BaseEvent event will trigger for this event id.

Public fieldStatic memberRawStatesEnabledFeedbackEventId The state of "CenOdtCPoe.RawStatesEnabledFeedback" has changed.

The GlsOccupancySensorChange event will trigger for this event id.

Public fieldStatic memberRoomIsBrightFeedbackEventId The state of "CenOdtCPoe.RoomIsBrightFeedback" has changed.

The GlsOccupancySensorChange event will trigger for this event id.

Public fieldStatic memberRoomIsDarkFeedbackEventId The state of "CenOdtCPoe.RoomIsDarkFeedback" has changed.

The GlsOccupancySensorChange event will trigger for this event id.

Public fieldStatic memberRoomOccupiedFeedbackEventId The state of OccupancyDetectedFeedback or "CenOdtCPoe.OccupancyDetectedFeedback" has changed.

The BaseEvent event will trigger for this event id.

Public fieldStatic memberRoomVacantFeedbackEventId The state of VacancyDetectedFeedback or "CenOdtCPoe.VacancyDetectedFeedback" has changed.

The BaseEvent event will trigger for this event id.

Public fieldStatic memberShortTimeoutEnabledFeedbackEventId The state of ShortTimeoutEnabledFeedback or "CenOdtCPoe.ShortTimeoutEnabledFeedback" has changed.

The GlsOccupancySensorChange event will trigger for this event id.

Public fieldStatic memberSystemAddressReceivedFeedbackEventId The value of SystemAddressReceivedFeedback has changed.

The GlsOccupancySensorChange event will trigger for this event id.

Public fieldStatic memberTimeoutFeedbackEventId The value of CurrentTimeoutFeedback or "CenOdtCPoe.CurrentTimeoutFeedback" has changed.

The BaseEvent event will trigger for this event id.

Public fieldStatic memberTimeoutLocalFeedbackEventId The value of LocalTimeoutFeedback has changed.

The BaseEvent event will trigger for this event id.

Public fieldStatic memberUsAEnabledFeedbackEventId The state of UsAEnabledFeedback or "CenOdtCPoe.UltrasonicSensorSideAEnabledFeedback" has changed.

The GlsOccupancySensorChange event will trigger for this event id.

Public fieldStatic memberUsBEnabledFeedbackEventId The state of UsBEnabledFeedback or "CenOdtCPoe.UltrasonicSensorSideBEnabledFeedback" has changed.

The GlsOccupancySensorChange event will trigger for this event id.

Public fieldStatic memberUsSensitivityInOccupiedStateFeedbackEventId The value of UsSensitivityInOccupiedStateFeedback or "CenOdtCPoe.UltrasonicSensorSensitivityInOccupiedStateFeedback" has changed.

The GlsOccupancySensorChange event will trigger for this event id.

Public fieldStatic memberUsSensitivityInVacantStateFeedbackEventId The value of UsSensitivityInVacantStateFeedback or "CenOdtCPoe.UltrasonicSensorSensitivityInVacantStateFeedback" has changed.

The GlsOccupancySensorChange event will trigger for this event id.

Top

Version Information

.NET

Supported in: 6.0

.NET Compact Framework

Supported in: 3.5
See Also