Enum UIClass

Namespace

OverKizApi.Enums

Assembly

OverKizApi.dll

Maps to the uiClass field returned in a device definition. The UI class broadly categorises what a device is (e.g. a shutter, a sensor, a lock) and is used by applications to choose the correct control template.

public enum UIClass

Fields

AdjustableSlatsRollerShutter = 1

Roller shutter whose slats can be individually tilted as well as raised/lowered.

AirPlaySocket = 3

AirPlay-enabled power socket (smart plug with AirPlay audio routing).

AirSensor = 4

Air quality sensor (generic; see also more specific sensor classes).

Alarm = 2

Alarm panel or intrusion detection system.

AtmosphericPressureSensor = 5

Barometric (atmospheric) pressure sensor.

Awning = 6

Retractable fabric awning (horizontal sun shade).

Balcony = 7

Balcony-mounted device (generic balcony classification).

Bike = 8

Bike rack or bicycle storage device.

BioclimaticPergola = 9

Bioclimatic pergola (louvred roof pergola that adjusts to weather conditions).

Camera = 10

Security or surveillance camera.

CarbonDioxideSensor = 11

CO₂ (carbon dioxide) concentration sensor.

CarbonMonoxideSensor = 12

CO (carbon monoxide) concentration sensor.

CircuitBreaker = 13

Smart circuit breaker or electrical panel switch.

ConfigurableGate = 14

Gate whose open/close behaviour can be configured.

ContactSensor = 15

Magnetic or reed-switch contact sensor (door/window open detection).

CumulatedElectricPowerSensor = 16

Sensor that accumulates total electrical power consumption over time.

Curtain = 17

Fabric curtain that draws to the side(s).

DimmerExteriorHeating = 18

Exterior heating element with dimmer (variable heat output) control.

DimmerLight = 19

Dimmable light fixture.

Door = 20

Motorised or smart door.

DoorLock = 21

Electronic door lock (deadbolt or latch with remote control).

DualSensor = 22

Combined sensor that measures two different physical quantities.

ElectricitySensor = 23

Real-time electricity consumption sensor (instant power draw).

ExteriorBlind = 24

Exterior blind (fabric or slat blind installed outside the window).

ExteriorScreen = 25

Exterior roller screen (insect screen or sun screen mounted outside).

ExteriorVenetianBlind = 26

Exterior Venetian blind (angled horizontal slats, mounted outside).

Fan = 27

Ceiling or desk fan.

FanController = 28

Controller hub for one or more fans.

Garage = 29

Single-car or multi-car garage (non-motorised or generic).

GarageDoor = 30

Motorised garage door.

Gate = 31

Motorised entry gate (driveway or pedestrian).

Generic = 32

Generic device that does not map to a more specific UI class.

HeatingSystem = 33

Central heating system controller (boiler, heat pump, or underfloor heating).

HitachiAirToAirHeatPump = 34

Hitachi air-to-air heat pump (requires Hitachi-specific commands).

HorizontalAwning = 35

Horizontal retractable awning (extends horizontally over a terrace or balcony).

HumiditySensor = 36

Relative humidity sensor.

Light = 37

Light fixture (on/off, no dimming).

LightSensor = 38

Ambient light level sensor (lux).

Lock = 39

Generic lock (door, safe, or access-control lock).

MotionSensor = 40

Passive infrared or microwave motion detector.

NetworkComponent = 41

Network infrastructure component (switch, access point, etc.).

NoiseSensor = 42

Acoustic noise level sensor (dB).

OccupancySensor = 43

Occupancy sensor (presence detection).

OnOff = 44

Simple on/off actuator (relay or smart plug without energy metering).

OnOffLight = 45

On/off light (non-dimmable smart bulb or switch).

OvenOven = 46

Smart oven device.

Pergola = 47

Pergola (open-structure canopy, fixed louvres).

PergolaHorizontalAwning = 48

Pergola fitted with a retractable horizontal awning.

Pool = 49

Swimming pool controller (pumps, heating, chemistry dosing).

PoolPump = 50

Pool circulation or filter pump.

ProtocolGateway = 51

Protocol gateway/bridge device (e.g. an io-homecontrol to Z-Wave bridge).

Pump = 52

Generic pump actuator.

RainSensor = 53

Rain detector or precipitation sensor.

RollerShutter = 54

Roller shutter (opaque panel that rolls up into a box).

Screen = 55

Interior roller screen or sun screen.

ShowerRoomFan = 56

Shower-room extractor fan.

Siren = 57

Alarm siren (audible/visual alert actuator).

SirenSensor = 58

Combined siren and sensor (e.g. siren with built-in motion detection).

Slats = 59

Adjustable slat panel (louvred screen, not a full roller shutter).

SmokeSensor = 60

Optical or ionisation smoke detector.

StatelessAlarm = 61

Alarm panel that is stateless (no persistent armed/disarmed state on the gateway).

StatelessExteriorHeating = 62

Exterior heater that is stateless (no persistent on/off state on the gateway).

SunSensor = 63

Solar irradiance or sunshine duration sensor.

SwimmingPool = 64

Full swimming pool management system.

SwingingShutter = 65

Swinging shutter (bi-fold or hinged panel shutter).

TemperatureSensor = 66

Ambient air temperature sensor.

ThermostatZonesController = 67

Multi-zone thermostat controller.

ThreeWayWindowHandle = 68

Window handle with three positions (closed, tilt, open).

TiltOnlyVenetianBlind = 69

Venetian blind that can only tilt its slats (no raise/lower travel).

TimedOnOff = 70

Timed on/off actuator (relay that switches off automatically after a delay).

TimedOnOffLight = 71

Timed on/off light (switches off automatically after a configured duration).

UniversalSensor = 72

Universal sensor that can be configured to measure different quantities.

Unknown = 0

UI class could not be parsed or is not yet known to this library.

Untyped = 73

Device whose type has not been classified by the gateway.

UpDownBioclimaticPergola = 74

Bioclimatic pergola with up/down travel control.

UpDownCellularScreen = 75

Cellular (honeycomb) screen with up/down travel.

UpDownCurtain = 76

Curtain with up/down travel (vertical draw curtain on a track).

UpDownDualCurtain = 77

Dual curtain (two panels) with up/down travel.

UpDownExteriorScreen = 78

Exterior roller screen with up/down travel.

UpDownExteriorVenetianBlind = 79

Exterior Venetian blind with up/down travel and slat tilt.

UpDownGarageDoor = 80

Motorised garage door with up/down travel (2-wire control).

UpDownGarageDoor4T = 81

Motorised garage door with up/down travel (4-wire terminal control).

UpDownGarageDoorWithVentilationPosition = 82

Motorised garage door with up/down travel and a ventilation stop position.

UpDownHorizontalAwning = 83

Horizontal awning with up/down travel axis.

UpDownRollerShutter = 84

Roller shutter with up/down travel.

UpDownScreen = 85

Interior screen with up/down travel.

UpDownSheerScreen = 86

Sheer (translucent) roller screen with up/down travel.

UpDownSwingingShutter = 87

Swinging shutter with up/down travel.

UpDownVenetianBlind = 88

Venetian blind with up/down travel and slat tilt.

UpDownWindow = 89

Motorised window with up/down travel.

UpDownZebraScreen = 90

Zebra (alternating sheer/opaque stripe) roller screen with up/down travel.

VOCSensor = 91

VOC (volatile organic compound) air quality sensor.

ValveHeatingTemperatureInterface = 92

Thermostatic valve with a temperature interface (TRV or zone valve).

VentilationInlet = 93

Controlled ventilation inlet (fresh-air intake damper).

VentilationOutlet = 94

Controlled ventilation outlet (exhaust-air damper or extractor).

VentilationTransfer = 95

Controlled ventilation transfer damper (between zones).

WaterDetectionSensor = 96

Water ingress / flooding detection sensor.

WeatherForecastSensor = 97

Multi-parameter weather forecast sensor (temperature, humidity, wind, rain).

Wifi = 98

Wi-Fi access point or repeater device.

WindSpeedAndDirectionSensor = 100

Anemometer measuring both wind speed and direction.

WindSpeedSensor = 99

Anemometer measuring wind speed only.

WindowLock = 101

Motorised or smart window lock.

WindowWithTiltSensor = 102

Window sensor that also detects tilt (open vs. tilted vs. closed).

ZWaveAeotecConfiguration = 103

Z-Wave Aeotec device configuration interface.

ZWaveConfiguration = 104

Generic Z-Wave device configuration interface.

ZWaveDanfossRSLink = 105

Z-Wave Danfoss RS Link thermostatic head configuration interface.

ZWaveDoorLockConfiguration = 106

Z-Wave door lock parameter configuration interface.

ZWaveFibaroRollerShutterConfiguration = 107

Z-Wave Fibaro roller shutter module configuration interface.

ZWaveHeatitThermostatConfiguration = 108

Z-Wave Heatit thermostat configuration interface.

ZWaveNodonConfiguration = 109

Z-Wave NodOn device configuration interface.

ZWaveQubinoConfiguration = 110

Z-Wave Qubino module configuration interface.

ZWaveSEDeviceConfiguration = 111

Z-Wave Schneider Electric device configuration interface.

ZWaveTransceiver = 112

Z-Wave transceiver (radio dongle or module acting as a Z-Wave controller).

ZigbeeNetwork = 113

Zigbee network coordinator or router device.

ZigbeeStack = 114

Zigbee protocol stack component (low-level Zigbee controller).