Click or drag to resize

ZumLinkOccupancySensor Class

This is Occupancy Sensor class for Zum Link Occupancy Vacancy Sensor devices.

This class will trigger OccupancySensorChange event.

Inheritance Hierarchy
SystemObject
  Crestron.SimplSharpPro.Lighting.ZumWiredZumOccupancySensor
    Crestron.SimplSharpPro.Lighting.ZumWiredZumLinkOccupancySensor

Namespace: Crestron.SimplSharpPro.Lighting.ZumWired
Assembly: Crestron.SimplSharpPro.Lighting (in Crestron.SimplSharpPro.Lighting.dll) Version: 2.21.121
Syntax
C#
public sealed class ZumLinkOccupancySensor : ZumOccupancySensor

The ZumLinkOccupancySensor type exposes the following members.

Properties
 NameDescription
Public propertyGraceOccupancyDetectedFeedback This property reports the grace occupancy state detected within 15s after a vacancy event. True = Occupancy event detected within 15s of initial vacancy event; False = No occupancy event detected within 15s of initial vacancy event.

This property will trigger OccupancySensorChange event with GraceOccupancyDetectedFeedbackEventId.

This property is not supported by ZUMLINK-JBOX-IO and ZUMLINK-DIN-IO.
(Inherited from ZumOccupancySensor)
Public propertyInfraredEnabledFeedback Property to report if the Infrared portion of sensor has been activated. True = IR portion of the sensor is activated ; False = IR portion of the sensor is deactivated This only applies to the Dual Technology (DT) products. This property is not supported by ZumNetJBoxDaliGroups, ZUMLINK-JBOX-IO and ZUMLINK-DIN-IO.

This property will trigger OccupancySensorChange event with InfraredEnabledEventId.


(Inherited from ZumOccupancySensor)
Public propertyOccupancyDetectedFeedback This property reports the occupancy state detected. True = Occupancy detected; False = Vacancy detected.

This property will trigger OccupancySensorChange event with OccupancyDetectedFeedbackEventId.

This property is not supported by ZUMLINK-JBOX-IO and ZUMLINK-DIN-IO.
(Inherited from ZumOccupancySensor)
Public propertyOccupancyRawInfraredStateFeedback This property reports the raw occupancy state for Infrared (IR) products only. True = Raw Occupancy digital output is enabled; False = Raw Occupancy digital output is disabled. This property is not supported by ZumNetJBoxDaliGroups, ZUMLINK-JBOX-IO and ZUMLINK-DIN-IO.

This property will trigger OccupancySensorChange event with OccupancyRawInfraredStateFeedbackEventId.


(Inherited from ZumOccupancySensor)
Public propertyOccupancyRawStateEnable This property is to enable/disable the reporting of raw states that are not tied to any timeout setting.

True: Enable raw occupancy digital output; False: Disable raw occupancy digital output

This property is not supported by ZUMLINK-JBOX-IO and ZUMLINK-DIN-IO.
(Inherited from ZumOccupancySensor)
Public propertyOccupancyRawStateFeedback This property reports the raw occupancy state. True = Raw Occupancy digital output is enabled; False = Raw Occupancy digital output is disabled.

This property will trigger OccupancySensorChange event with OccupancyRawStateFeedbackEventId.

This property is not supported by ZUMLINK-JBOX-IO and ZUMLINK-DIN-IO.
(Inherited from ZumOccupancySensor)
Public propertyOccupancyRawUltrasonicStateFeedback This property reports raw occupancy state for Ultrasonic (US) products only. True = Raw Occupancy digital output is enabled; False = Raw Occupancy digital output is disabled. This property is not supported by ZumNetJBoxDaliGroups, ZUMLINK-JBOX-IO and ZUMLINK-DIN-IO.

This property will trigger OccupancySensorChange event with OccupancyRawUltrasonicStateFeedbackEventId.


(Inherited from ZumOccupancySensor)
Public propertyParent The parent that a ZumOccupancySensor object was added to.
(Inherited from ZumOccupancySensor)
Public propertyRange Property to set the detection range.

This only applies to the Ultrasonic products and Dual Technology products.

The valid range is from 0-65535. 0 is the shortest range and 65535 is the longest range.

Public propertyRangeFeedback Property to report the detection range value that is set.

This only applies to the Ultrasonic and Dual Technology products.

The valid range is from 0-65535. 0 is the shortest range and 65535 is the longest range.

The OccupancySensorChange event will trigger with RangeFeedbackEventId.

Public propertySensitivity Property to set the detection sensitivity.

This only applies to the Ultrasonic and Dual Technology products.

The valid range is 0-15. 0 is the lowest sensitivity, 15 is the highest sensitivity, 1 is the default/reset value.

Public propertySensitivityFeedback Property to report the current detection sensitivity value that is set.

This only applies to the Ultrasonic and Dual Technology products.

The valid range is 0-15. 0 is the lowest sensitivity, 15 is the highest sensitivity, 1 is the default/reset value.

The OccupancySensorChange event will trigger with SensitivityFeedbackEventId.

Public propertyTimeOut This property sets the timeout period which must elapse with no motion detected before the state of the room changes from occupied to unoccupied.

Timeout is set in seconds. The valid values range from 0 to 65535.

This property is not supported by ZUMLINK-JBOX-IO and ZUMLINK-DIN-IO.
(Inherited from ZumOccupancySensor)
Public propertyTimeOutFeeback This property reports the current timeout period which must elapse with no motion detected before the state of the room changes from occupied to unoccupied. Timeout is set in seconds. The valid values range from 0 to 65535.

This property will trigger OccupancySensorChange event with TimeOutFeedbackEventId.

This property is not supported by ZUMLINK-JBOX-IO and ZUMLINK-DIN-IO.
(Inherited from ZumOccupancySensor)
Public propertyUltrasonicEnabledFeedback Property to report ultrasonic portion of sensor has been activated. True = US (ultrasonic) portion of the sensor is activated; False = US (ultrasonic) portion of the sensor is deactivated This only applies to the Dual Technology (DT) products. This property is not supported by ZumNetJBoxDaliGroups, ZUMLINK-JBOX-IO and ZUMLINK-DIN-IO.

This property will trigger OccupancySensorChange event with UltrasonicEnabledEventId.


(Inherited from ZumOccupancySensor)
Public propertyUserSpecifiedObject Can be assigned anything that user wants.
(Inherited from ZumOccupancySensor)
Public propertyVacancyDetectedFeedback This property reports currently vacant (no motion detected) after the timeout has elapsed. True = Vacancy detected; False = Occupancy Detected.

This property will trigger OccupancySensorChange event with VacancyDetectedFeedbackEventId.

This property is not supported by ZUMLINK-JBOX-IO and ZUMLINK-DIN-IO.
(Inherited from ZumOccupancySensor)
Top
Methods
 NameDescription
Public methodDisableInfrared Method to deactivate the Infrared portion of sensor. This only applies to the Dual Technology (DT) products. This property is not supported by ZumNetJBoxDaliGroups, ZUMLINK-JBOX-IO and ZUMLINK-DIN-IO.
(Inherited from ZumOccupancySensor)
Public methodDisableUltrasonic Method to deactivate ultrasonic portion of sensor. This only applies to the Dual Technology (DT) products. This property is not supported by ZumNetJBoxDaliGroups, ZUMLINK-JBOX-IO and ZUMLINK-DIN-IO.
(Inherited from ZumOccupancySensor)
Public methodEnableInfrared Method to activate Infrared portion of sensor. This only applies to the Dual Technology (DT) products. This property is not supported by ZumNetJBoxDaliGroups, ZUMLINK-JBOX-IO and ZUMLINK-DIN-IO.
(Inherited from ZumOccupancySensor)
Public methodEnableOccupancyRawStateObsolete.
This method will enable the reporting of raw states that are not tied to any timeout setting. This method is not supported by ZUMLINK-JBOX-IO and ZUMLINK-DIN-IO.
(Inherited from ZumOccupancySensor)
Public methodEnableUltrasonic Method to activate ultrasonic portion of the sensor. This only applies to the Dual Technology (DT) products. This property is not supported by ZumNetJBoxDaliGroups, ZUMLINK-JBOX-IO and ZUMLINK-DIN-IO.
(Inherited from ZumOccupancySensor)
Public methodEqualsDetermines whether the specified object is equal to the current object.
(Inherited from Object)
Public methodForceOccupied This method forces the sensor to occupied state. This method is not supported by ZUMLINK-JBOX-IO and ZUMLINK-DIN-IO.
(Inherited from ZumOccupancySensor)
Public methodForceVacant This method forces the sensor to vacant state. This method is not supported by ZUMLINK-JBOX-IO and ZUMLINK-DIN-IO.
(Inherited from ZumOccupancySensor)
Public methodForceVacntObsolete.
This method forces the sensor to vacant state. This method is not supported by ZUMLINK-JBOX-IO and ZUMLINK-DIN-IO.
(Inherited from ZumOccupancySensor)
Public methodGetHashCodeServes as the default hash function.
(Inherited from Object)
Public methodGetTypeGets the Type of the current instance.
(Inherited from Object)
Public methodToStringReturns a string that represents the current object.
(Inherited from Object)
Top
Events
 NameDescription
Public eventOccupancySensorChange Event triggered when a feedback has changed for this ZumOccupancySensor.
(Inherited from ZumOccupancySensor)
Top

Version Information

.NET

Supported in: 6.0

.NET Compact Framework

Supported in: 3.5
See Also