Eutech |
This class will trigger BaseEvent, LightSensorChange and ButtonStateChange events.
public class EutechProlightKeypadBaseClass : KeypadBase, IAmbientLightSensor, ITemperatureFeedback, IHumidityFeedback, IPressureFeedback, IAirQualityFeedback, ISensorStatusFeedback
The EutechProlightKeypadBaseClass type exposes the following members.
| Name | Description | |
|---|---|---|
| AirQualityFeedback |
Property to report the air quality reading from the environmental sensor.
Note: RESERVED FOR FUTURE USE.
This property will trigger AirQualityChange event with AirQualityFeedback. | |
| Button |
Collection of buttons supported by the device.
(Inherited from KeypadBase) | |
| CleaningModeOnFeedback |
Property to report if Cleaning mode is currently turned on.
Cleaning mode is turned on by touching the Eutech Prolight Keypad with the open hand placed horizontally in the space
between the 3 lower keys and the interior edge for about 8 seconds.
The cleaning mode status is useful for Crestron macros to avoid reading key presses,
for example when the operator wants to clean the glass of the Eutech Prolight Keypad, without activating the keys.
True = Cleaning Mode On, False = Cleaning Mode off.
This property will trigger BaseEvent event with CleaningModeOnEventId. | |
| 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) | |
| Description |
Get/Set the description of this device.
(Inherited from GenericBase) | |
| Disposed |
Property to indicate if the device has been disposed.
(Inherited from GenericDevice) | |
| Feedbacks |
Property to get the collection of feedbacks on the device.
(Inherited from KeypadBase) | |
| HumidityFeedback |
Property to report the relative humidity reading from the environmental sensor.
Humidity values are given in percentage (%).
Use PercentToUshort(Single) to convert
the percentage to a ushort value or UshortToPercent(UInt16) to convert
the ushort value to percentage.
This property will trigger HumidityChange event with HumidityFeedback. | |
| ID |
Property to get the ID of the device.
(Inherited from GenericDevice) | |
| IsOnline |
Property to get the current online state of the device.
(Inherited from GenericDevice) | |
| LightSensorValue | Property to report the light reading, from the environmental sensor. Light is a value between 0 and 128 correlated with the light intensity, the higher the number; the higher the light intensity. Readings below 32 are correlated with night, readings near 127 are given in full day illumination. | |
| Name |
Get the name of this device.
(Inherited from GenericBase) | |
| NumberOfLeds | Property to report the count of LED's on this device. | |
| Parent |
The parent that a given object was added to.
(Inherited from GenericBase) | |
| PressureFeedback |
Property to report the atmospheric pressure reading from the environmental sensor.
Atmospheric pressure values are given in hecto Pascals(hPa).
This property will trigger PressureChange event with PressureFeedback. | |
| ProximityDetectedFeedback |
Property to report if an object or the operator (for example, the operator's hand) is near, in proximity of, the keypad.
Proximity is turned on when an object or the operator is approximately 3 to 7 cm away from the glass of the Eutech Prolight Keypad.
Proximity stays activated for all the time the object is near Eutech Prolight Keypad and for an additional 10-15 seconds when the object is pulled away.
True = Object or operator (user) near keypad, False = Object or operator (user) not near keypad.
This property will trigger BaseEvent event with ProximityDetectedEventId. | |
| ProximityLedColor | Property to get and set color for Proximity LED. LED colors are defined in EutechProlightKeypadBaseClasseLedColor. All values beyond Aqua should be treated as Aqua. | |
| ProximityLedOn | Property to turn on/off the Proximity/Perimeter LED. True: Proximity/Perimeter LED is On, False: Proximity/Perimeter LED is Off. | |
| 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) | |
| SensorStatusFeedback |
Property to report the environmental sensor's working status.
This property will trigger SensorStatusChange event with SensorStatusFeedback. | |
| SIMPLDeviceImplementation |
Internal protected member used for actual device control.
(Inherited from GenericDevice) | |
| TemperatureFeedback |
Property to report the temperature reading from the environmental sensor.
Temperature values are given in 0.01 Celsius degrees.
This property will trigger TemperatureChange event with TemperatureFeedback. | |
| 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) | |
| 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) | |
| GetLedColor |
Method to get LED's color.
Maximum index supported is known from NumberOfLeds. | |
| 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) | |
| RequestAirQuality | Method to request the air quality from the environmental sensor. Note: RESERVED FOR FUTURE USE. | |
| RequestAtmosphericPressure | Method to request the atmospheric pressure from the environmental sensor. | |
| RequestHumidity | Method to request the relative humidty from the environmental sensor. | |
| RequestLightLevel | Method to request the light reading from the environmental sensor. | |
| RequestSensorStatus | Method to request the working status of the environmental sensor. | |
| RequestTemperature | Method to request the air temperature from the environmental sensor. | |
| SetLedColor | Method to set color for LED's. Maximum index supported is known from NumberOfLeds. All values beyond Aqua will be treated as Aqua. | |
| 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 | |
|---|---|---|
| AirQualityChange | Event triggered when AirQualityFeedback has changed. | |
| BaseEvent |
Generic base event, triggered when the there are no other handlers available
for a specific EventID.
(Inherited from GenericBase) | |
| ButtonStateChange |
Event fired when a button state change was received from the device.
(Inherited from KeypadBase) | |
| HumidityChange | Event triggered when HumidityFeedback has changed. | |
| 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) | |
| LightSensorChange | Event triggered when the LightSensorValue is reported as a percentage from 0% to 100%, as determined by the internal light sensor. | |
| OnlineStatusChange |
Event triggered when the Online status of the device changes.
(Inherited from GenericDevice) | |
| PressureChange | Event triggered when PressureFeedback has changed. | |
| SensorStatusChange | Event triggered when SensorStatusFeedback has changed. | |
| TemperatureChange | Event triggered when TemperatureFeedback has changed. |
| Name | Description | |
|---|---|---|
| _Buttons |
Collection that contains button objects.
(Inherited from KeypadBase) | |
| CleaningModeOnEventId |
The state of CleaningModeOnFeedback has changed.
The BaseEvent event will trigger for this event id. | |
| ProximityDetectedEventId |
The state of ProximityDetectedFeedback has changed.
The BaseEvent event will trigger for this event id. |