Click or drag to resize

IGlsCenOcc Interface

Interface to define the common sigs between GLS and CEN-ODT-C-POE Occupancy Sensors.

Namespace: Crestron.SimplSharpPro.GeneralIO
Assembly: Crestron.SimplSharpPro.GeneralIO (in Crestron.SimplSharpPro.GeneralIO.dll) Version: 2.21.121
Syntax
C#
public interface IGlsCenOcc : ICommonOccupancySensorInfo

The IGlsCenOcc type exposes the following members.

Properties
 NameDescription
Public propertyAndWhenVacatedFeedback Property to indicate if both passive infrared (PIR) OR ultrasonic (US) sensor technologies must register motion to trigger initial room occupancy. true = motion sensed needed by both technologies for initial occupancy; false = AND logic disabled.
Public propertyCurrentTimeoutFeedback Property to indicate which timeout is being used by the sensor.

The BaseEvent event will trigger with: GlsOccupancySensorBase.TimeoutFeedbackEventId for GlsOccupancySensorBase devices; GlsOirCsmExBattEventIds.CurrentTimeoutReceivedEventId for GlsOirCsmExBatt devices. For GlppBase devices GlppBase.GlppOccupancySensorIrChange event will trigger with GlppEventIds.TimeoutFeedbackEventId.


(Inherited from ICommonOccupancySensorInfo)
Public propertyGraceOccupancyDetectedFeedback Property to indicate occupancy event detected within 15s of initial vacancy event. Beyond 15s after the initial vacancy event, this property cannot be triggered. This property is most commonly used in an application where a vacancy-only sensor is desired. In such an instance, only this property will be used to turn on the lights, while OccupancyDetectedFeedback will remain unused. true = Occupancy event detected within 15s of initial vacancy event; false = No occupancy event detected within 15s of initial vacancy event.

The BaseEvent event will trigger with GraceOccupancyDetectedFeedbackEventId.

Public propertyInternalPhotoSensorValueFeedback Property to report the internal photosensor value. The output range is from 0 to MAXIMIM VALUE TO BE DETERMINED lux, scaled linearly from 0 to 65535.
Public propertyLedFlashEnabledFeedback Property to indicate if feedback LEDs are enabled or disabled that indicates if motion is detected. true = Feedback LEDs enabled; false = Feedback LEDs disabled.
Public propertyOccupancyDetectedFeedback Property to indicate occupancy status. Value is true when occupancy is detected, value is false when vacancy is detected.

The BaseEvent event will trigger with: GlsOccupancySensorBase.RoomOccupiedFeedbackEventId for GlsOccupancySensorBase devices; GlsOirCsmExBattEventIds.OccupancyStatusReceivedEventId for GlsOirCsmExBatt devices. For GlppBase devices GlppBase.GlppOccupancySensorIrChange event will trigger with GlppEventIds.RoomIsOccupiedFeedbackEventId.


(Inherited from ICommonOccupancySensorInfo)
Public propertyOrWhenVacatedFeedback Property to indicate if either passive infrared (PIR) OR ultrasonic (US) sensor technologies can trigger initial occupancy. true = motion sensed needed by only one technology; false = OR logic disabled.
Public propertyPassiveInfraredSensorEnabledFeedback Property to report if the passive infrared (PIR) Sensor is enabled. true = PIR Sensor enabled; false = PIR Sensor disabled.
Public propertyPassiveInfraredSensorSensitivityInOccupiedStateFeedback Property to report Sensitivity level for passive infrared (PIR) while sensor is in occupied state.
Public propertyPassiveInfraredSensorSensitivityInVacantStateFeedback Property to report Sensitivity level for passive infrared (PIR) while sensor is in vacant state.
Public propertyRawOccupancyDetectedByPassiveInfraredSensorFeedback Property to indicate if any raw motion registered/detected by the passive infrared (PIR) sensor. true = motion detected by passive infrared (PIR) sensor; false = No motion detected by passive infrared (PIR) sensor.

The BaseEvent event will trigger with RawOccupancyPirFeedbackEventId.

Public propertyRawOccupancyDetectedByUltrasonicSensorFeedback Property to indicate if any raw motion registered/detected by the ultrasonic (US) sensor. true = motion detected by ultrasonic (US); false = No motion detected by ultrasonic (US).

The BaseEvent event will trigger with RawOccupancyUsFeedbackEventId.

Public propertyRawOccupancyDetectedFeedback This property value will be set to true if ultrasonic (US) AND/OR passive infrared (PIR) sensors detect motion. The AND/OR determination is decided based upon the chosen logic. To see which logic is chosen, look at OrWhenVacatedFeedback and AndWhenVacatedFeedback. For example, in “Vacancy AND” logic both ultrasonic (US) and passive infrared (PIR) technologies must register motion in order to set this property value to true. true = motion detected by logical state; false = No motion detected by logical state.

The BaseEvent event will trigger with RawOccupancyFeedbackEventId.

Public propertyRemoteTimeout Property to set timeout remotely.
(Inherited from ICommonOccupancySensorInfo)
Public propertyShortTimeoutEnabledFeedback Property to report if the short timeout functionality has been enabled. true = Short timeout enabled; false = Short timeout disabled
Public propertyUltrasonicSensorSensitivityInOccupiedStateFeedback Property to report Sensitivity level for ultrasonic (US) while sensor is in occupied state.
Public propertyUltrasonicSensorSensitivityInVacantStateFeedback Property to report Sensitivity level for ultrasonic (US) while sensor is in vacant state.
Public propertyUltrasonicSensorSideAEnabledFeedback Property to report if the ultrasonic (US) Sensor side A is enabled.
Public propertyUltrasonicSensorSideBEnabledFeedback Property to report if the ultrasonic (US) Sensor side B is enabled. true = US Sensor B enabled; false = US Sensor B disabled.
Public propertyVacancyDetectedFeedback Property to indicate when the room is vacant. "OccupancyDetectedFeedback" sets to false and VacancyDetectedFeedback sets to true. true = Room Vacant ; false = Room Occupied.

The BaseEvent event will trigger with RoomVacantFeedbackEventId.

Top
Methods
 NameDescription
Public methodAndWhenVacated Method to trigger both passive infrared (PIR) OR ultrasonic (US) motion sensors to detect motion to declare initial occupancy, if the room is vacant.
Public methodDisableLedFlash Method to disable the red and green feedback LEDs from blinking when motion is detected.
Public methodDisablePassiveInfraredSensor Method to disable the passive infrared (PIR) Sensor.
Public methodDisableShortTimeout Method to disable the short timeout functionality. See EnableShortTimeout method for description.
Public methodDisableUltrasonicSensorSideA Method to disable the ultrasonic (US) Sensor side A. This does NOT enable side B.
Public methodDisableUltrasonicSensorSideB Method to disable the ultrasonic (US) Sensor side B. This does not enable side A.
Public methodEnableLedFlash Method to enable the red and green feedback LEDs. The red LED turns on as the passive infrared (PIR) sensor detects motion, and the green LED turns on as the ultrasonic (US) sensor detects motion.
Public methodEnablePassiveInfraredSensor Method to enable the passive infrared (PIR) Sensor.
Public methodEnableRawStates Method to enable "RawOccupancyDetectedFeedback", RawOccupancyDetectedByPassiveInfraredSensorFeedback and RawOccupancyDetectedByUltrasonicSensorFeedback properties.
Public methodEnableShortTimeout Method to enable a “walk-through” mode for a shorter timeouts upon periods of minimal occupancy. If the room is occupied for less than 90s, the timeout will revert to 60s. If the normally programmed timeout is set less than 60s, that timeout will take precedence. This is useful for rooms with normally a long timeout setting, so if the room is only entered for a short period of time, and occupancy is triggered, the lights do not remain on for a longer period than needed. Short timeout does not apply if occupancy event was a ""Grace occupancy"" (previous vacancy time is greater than 15 seconds).
Public methodEnableUltrasonicSensorSideA Method to enable the ultrasonic (US) Sensor side A. Does NOT disable side B. Side A is the side where the majority of the red LED is shown through the dome.
Public methodEnableUltrasonicSensorSideB Method to enable the ultrasonic (US) Sensor side B. This does NOT disable side A. Side B is the side where the majority of the green LED is shown through the dome and is also identified on the back-housing plastic rim.
Public methodForceOccupied Method to force the device to report that the room is occupied even if the passive infrared (PIR) sensor does not detect motion. VacancyDetectedFeedback sets to false and "OccupancyDetectedFeedback" sets to true. RawOccupancyDetectedFeedback is set to true when ForceOccupied is called. The sensor will then be in the occupied state for the duration of the set timeout.
Public methodForceVacant Method to force the device to report that the room is vacant even if the passive infrared (PIR) sensor does not detect vacancy. "OccupancyDetectedFeedback" sets to false and VacancyDetectedFeedback sets to true. Upon forcing vacancy, there is a 5 second delay before the sensor begins re-sensing for motion.
Public methodOrWhenVacated Method to trigger either passive infrared (PIR) OR ultrasonic (US) motion sensors to declare initial occupancy and set the sensor to the occupied state, if the room is vacant.
Top

Version Information

.NET

Supported in: 6.0

.NET Compact Framework

Supported in: 3.5
See Also