Enum EControlUse
public enum EControlUseNamespace: HomeSeer.PluginSdk.Devices.Controls
Assembly: PluginSdk.dll
Defines what a StatusControl is used for.
Remarks
This is primarily used to improve integrations with 3rd-party systems. It helps determine how a control is used within the context of the owning HsFeature.
Fields
| Name | Description |
|---|---|
| ColorControl | This control is used to adjust the color of a feature. |
| ColorTemp | This control is used to set the color temperature value. |
| ColorTempPreset | This control is used to set the color temperature to a preset value. |
| ContactActive | Used for integrations to represent a status indicating a contact sensor triggering. |
| ContactInActive | Used for integrations to represent a status indicating a contact sensor being reset. |
| CoolSetPoint | This control is used to set the desired temperature when cooling. |
| DecrementValue | This control is used to decrement the value of a feature. |
| Dim | This control is used to adjust the brightness of a light. |
| DimFan | This control is used to adjust the rate for a fan. |
| DoorLock | This control is used to lock a door. |
| DoorUnLock | This control is used to unlock a door. |
| Forward | This control is used to fast-forward media playback. |
| GarageDoorClose | This control is used to Close a Garage Door. This is different from a generic Open/Close because a garage door may have security. |
| GarageDoorOpen | This control is used to Open a Garage Door. This is different from a generic Open/Close because a garage door may have security. |
| GeneralNoUnit | A multi-level sensor (e.g. range of values) |
| GeneralPercent | A multi-level value that is represented as a percent. |
| GenericBinaryActive | Used to indicate an "active" state for a sensor without any other descriptive unit of measure or identifying state name. |
| GenericBinaryInactive | Used to indicate an "inactive" state for a sensor without any other descriptive unit of measure or identifying state name. |
| GenericClose | This control is used to Close a Garage Door. This is different from a generic Open/Close because a garage door may have security. |
| GenericOpen | This control is used to Open a Garage Door. This is different from a generic Open/Close because a garage door may have security. |
| HeatSetPoint | This control is used to set the desired temperature when heating. |
| IncrementValue | This control is used to increment the value of a feature. |
| MediaMuted | A volume muted state. |
| MediaPaused | A media playing state. |
| MediaPlaying | A media playing state. |
| MediaStopped | A media playing state. |
| MediaUnmuted | A volume unmuted state. |
| MotionActive | Used for integrations to represent a status indicating active motion. |
| MotionInActive | Used for integrations to represent a status indicating a motion sensor resetting to idle. |
| Mute | This control is used to mute media playback. |
| MuteToggle | This control is used to mute or un-mute media playback. |
| Next | This control is used to advance to the next track available for playback. |
| NotSpecified | Default use. The control's use is not defined. |
| Off | This control is used to turn something off. |
| On | This control is used to turn something on. |
| OnAlternate | This control is used as an alternative command to turn something on. |
| Pause | This control is used to pause media playback. |
| PercentHumidity | Uses to indicate relative humidity in percent. |
| Play | This control is used to play media. |
| Previous | This control is used to select the previous track for media playback. |
| Repeat | This control is used to repeat media playback. |
| RepeatOff | This control is used to set playback to Normal (no more repeat). |
| Rewind | This control is used to rewind media playback. |
| SensorBinaryActive | A sensor state indicating active. |
| SensorBinaryInactive | A sensor state indicating that Carbon Monoxide is no longer/not present. |
| Shuffle | This control is used to shuffle the media playback. |
| ShuffleOff | This control is used to set playback to Normal (no more shuffle). |
| SimpleEventSource | Used by Alexa in routines for things like central scene |
| StartOver | This control is used to play media from the beginning. |
| Stop | This control is used to stop media playback. |
| Temperature | Used for integrations to represent a status indicating a Temperature sensor. This does not imply a unit of measure (F/C/K) so in most cases it will be reported as just degrees. |
| TemperatureC | Uses to indicate temperature using the Celsius scale. |
| TemperatureF | Uses to indicate temperature using the Fahrenheit scale. |
| TemperatureK | Uses to indicate temperature using the Kelvin scale. |
| ThermFanAuto | This control is used to set the fan mode for a thermostat to auto. |
| ThermFanCirculate | This control is used to set the fan mode for a thermostat to Circulate. |
| ThermFanOn | This control is used to set the fan mode for a thermostat to on. |
| ThermModeAuto | This control is used to set the thermostat operation mode to auto. |
| ThermModeCool | This control is used to set the thermostat operation mode to cool. |
| ThermModeEco | This control is used to set the thermostat operation mode to economy. |
| ThermModeEMHeat | This control is used to set the thermostat operation mode to emergency heat. |
| ThermModeHeat | This control is used to set the thermostat operation mode to heat. |
| ThermModeOff | This control is used to set the thermostat operation mode to off. |
| UnMute | This control is used to un-mute media playback. |
| Volume | This control is used to adjust the volume of media playback. |
| WindowCoverClose | This control is used to close a window covering such as a curtain, blind, or shade. |
| WindowCoverMoveTo | This control is used to set a window covering such as a curtain, blind, or shade to a specific position. (Like in dimming, this should be the range of values exclusive of open/close, etc. that are defined elsewhere) |
| WindowCoverOpen | This control is used to open a window covering such as a curtain, blind, or shade. |
| WindowCoverPreset | This control is used to set a window covering such as a curtain, blind, or shade to a preset position. |
| WindowCoverStopHold | This control is used to stop movement on a window covering such as a curtain, blind, or shade. |
| WindowCoverTiltAngle | This control is used to tilt a window blind to a specific angular position. |
| WindowCoverTiltValue | This control is used to tilt a window blind to a specific position. (Like in dimming, this should be the range of values 1 to 99 percent.) |