Click or drag to resize

CenOdtCPoe Properties

The CenOdtCPoe type exposes the following members.

Properties
 NameDescription
Public propertyAndWhenOccupiedFeedback Indicates that both passive infrared (PIR) OR ultrasonic (US) sensor technologies must not register motion to trigger room vacancy. true = Vacancy determined by the lack of sensed motion by both technologies; false = AND logic disabled.

The CenOccupancySensorChange event will trigger with AndWhenOccupiedFeedbackEventId.

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.

The CenOccupancySensorChange event will trigger with AndWhenVacatedFeedbackEventId.

Public propertyBrightToDarkThreshold Property to set the threshold value to transition room from BRIGHT to DARK state. When the LightValue drops below this value, a BRIGHT room transitions to DARK RoomIsBrightFeedback will set to false and RoomIsDarkFeedback will set to true.
Public propertyBrightToDarkThresholdFeedback Property to report the current threshold value set to transition room from BRIGHT to DARK state. When the LightValue rises above this value, a BRIGHT room transitions to DARK RoomIsBrightFeedback will set to false and RoomIsDarkFeedback will set to true.

The BaseEvent event will trigger with BrightToDarkThresholdFeedbackEventId.

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, in seconds. The timeout is the elapsed time of raw vacancy needed for the sensor to declare the room vacant and send OccupancyDetectedFeedback to false and VacancyDetectedFeedback to true.

The BaseEvent event will trigger with TimeoutFeedbackEventId.

Public propertyDarkToBrightThreshold Property to set the threshold value to transition room from DARK to BRIGHT state. When the LightValue rises above this value, a DARK room transitions to BRIGHT. RoomIsDarkFeedback will set to false and RoomIsBrightFeedback will set to true.
Public propertyDarkToBrightThresholdFeedback Property to report the current threshold value set to transition room from DARK to BRIGHT state. When the LightValue rises above this value, a DARK room transitions to BRIGHT RoomIsDarkFeedback will set to false and RoomIsBrightFeedback sets to true.

The BaseEvent event will trigger with DarkToBrightThresholdFeedbackEventId.

Public propertyCode exampleDescription Get/Set the description of this device.
(Inherited from GenericBase)
Public propertyDisposed Property to indicate if the device has been disposed.
(Inherited from GenericDevice)
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 propertyID Property to get the ID of the device.
(Inherited from GenericDevice)
Public propertyIdentityModeOnFeedback Reports if the device is in Identify Mode. true = Device is in Identify Mode; false = Device is out of Identify Mode.

The CenOccupancySensorChange event will trigger with IdentityOnFeedbackEventId.

Public propertyInternalPhotoSensorMinimumChange Property to set the minimum change in value that the internal photosensor must sense before reporting a new value. The default minimum change of the device is 655 (1% of the full scale). Valid Range: 0 (0 lux) to 65535 (MAXIMUM VALUE O BE DETERMINED lux); if a value of 0 is input, a default of 655 will be applied.
Public propertyInternalPhotoSensorMinimumChangeFeedback Reports the minimum change that the photosensor must sense before reporting a new value. Valid Range: 0 (0 lux) to 65535 (MAXIMUM VALUE TO BE DETERMINED lux).

The BaseEvent event will trigger with InternalPhotoSensorMinimumChangeFeedbackEventId.

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.

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 LEDs are enabled or disabled that indicates if motion is detected. true = Feedback LEDs enabled; false = Feedback LEDs disabled.

The CenOccupancySensorChange event will trigger with LedFlashEnabledFeedbackEventId.

Public propertyName Get the name of this device.
(Inherited from GenericBase)
Public propertyOccupancyDetectedFeedback Property to indicate when the room is occupied. While occupied, either the passive infrared (PIR) sensor or ultrasonic (US) sensor can be triggered to maintain that state. VacancyDetectedFeedback sets to false and OccupancyDetectedFeedback sets to true. true = Room Occupied ; false = Room Vacant.

The BaseEvent event will trigger with RoomOccupiedFeedbackEventId.

Public propertyOrWhenOccupiedFeedback Indicates if either passive infrared (PIR) OR ultrasonic (US) sensor technologies can un-trigger to determine vacancy. true = Vacancy determined by the lack of sense by only one technology; false = OR logic disabled.

The CenOccupancySensorChange event will trigger with OrWhenOccupiedFeedbackEventId.

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.

The CenOccupancySensorChange event will trigger with OrWhenVacatedFeedbackEventId.

Public propertyParent The parent that a given object was added to.
(Inherited from GenericBase)
Public propertyPassiveInfraredSensorEnabledFeedback Property to report if the passive infrared (PIR) Sensor is enabled. true = PIR Sensor enabled; false = PIR Sensor disabled.

The CenOccupancySensorChange event will trigger with PirEnabledFeedbackEventId.

Public propertyPassiveInfraredSensorSensitivityInOccupiedState Property to set the Sensitivity level for passive infrared (PIR) while sensor in occupied state. Value passed for Sensitivity level is not valid.
Public propertyPassiveInfraredSensorSensitivityInOccupiedStateFeedback Property to report Sensitivity level for passive infrared (PIR) while sensor is in occupied state.

The CenOccupancySensorChange event will trigger with PirSensitivityInOccupiedStateFeedbackEventId.

Public propertyPassiveInfraredSensorSensitivityInVacantState Property to set the Sensitivity level for passive infrared (PIR) while sensor in vacant state. Value passed for Sensitivity level is not valid.
Public propertyPassiveInfraredSensorSensitivityInVacantStateFeedback Property to report Sensitivity level for passive infrared (PIR) while sensor is in vacant state.

The CenOccupancySensorChange event will trigger with PirSensitivityInVacantStateFeedbackEventId.

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 propertyRawStatesEnabledFeedback Property to indicate if RawOccupancyDetectedFeedback, RawOccupancyDetectedByPassiveInfraredSensorFeedback and RawOccupancyDetectedByUltrasonicSensorFeedback are enabled or disabled. true = Raw Occupancy properties are enabled; false = Raw Occupancy properties are disabled.

The BaseEvent event will trigger with RawStatesEnabledFeedbackEventId.

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 in seconds. This property is typically used to set different timeouts based upon time of day, or state of room. Valid range: 5 (5sec) – 1800 (30min). Any value above 1800 will revert to 1800s and any value below 5 will revert to 5s.
Public propertyRoomIsBrightFeedback Property to indicate when the room is determined to be brightly lit. RoomIsDarkFeedback is set to false and RoomIsDarkFeedback is set to true. true = Room Bright; false = Room Dark.

The BaseEvent event will trigger with RoomIsBrightFeedbackEventId.

Public propertyRoomIsDarkFeedback Property to indicate when the room is determined to not be brightly lit. RoomIsDarkFeedback is set to false and RoomIsDarkFeedback is set to true. true = Room Dark; false = Room Bright.

The BaseEvent event will trigger with RoomIsDarkFeedbackEventId.

Public propertyShortTimeoutEnabledFeedback Property to report if the short timeout functionality has been enabled. true = Short timeout enabled; false = Short timeout disabled

The CenOccupancySensorChange event will trigger with ShortTimeoutEnabledFeedbackEventId.

Protected propertySIMPLDeviceImplementation Internal protected member used for actual device control.
(Inherited from GenericDevice)
Public propertyType Property to determine to type of device this is.
(Inherited from GenericDevice)
Public propertyUltrasonicSensorSensitivityInOccupiedState Property to set the Sensitivity level for ultrasonic (US) while sensor is in occupied state. Value passed for Sensitivity level is not defined in the enum eSensitivityLevel.
Public propertyUltrasonicSensorSensitivityInOccupiedStateFeedback Property to report Sensitivity level for ultrasonic (US) while sensor is in occupied state.

The CenOccupancySensorChange event will trigger with UsSensitivityInOccupiedStateFeedbackEventId.

Public propertyUltrasonicSensorSensitivityInVacantState Property to set the Sensitivity level for ultrasonic (US) while sensor is in vacant state. Value passed for Sensitivity level is not defined in the enum eSensitivityLevel.
Public propertyUltrasonicSensorSensitivityInVacantStateFeedback Property to report Sensitivity level for ultrasonic (US) while sensor is in vacant state.

The CenOccupancySensorChange event will trigger with UsSensitivityInVacantStateFeedbackEventId.

Public propertyUltrasonicSensorSideAEnabledFeedback Property to report if the ultrasonic (US) Sensor side A is enabled.

The CenOccupancySensorChange event will trigger with UsAEnabledFeedbackEventId.

Public propertyUltrasonicSensorSideBEnabledFeedback Property to report if the ultrasonic (US) Sensor side B is enabled. true = US Sensor B enabled; false = US Sensor B disabled.

The CenOccupancySensorChange event will trigger with UsBEnabledFeedbackEventId.

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. OccupancyDetectedFeedback sets to false and VacancyDetectedFeedback sets to true. true = Room Vacant ; false = Room Occupied.

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
See Also