Table of Contents

Enum UIWidget

Namespace
OverKizApi.Enums
Assembly
OverKizApi.dll

Maps to the widgetName field returned in a device definition. The widget name selects the specific UI control rendered by the Overkiz app for a device. Where a widget name matches a UIClass name the semantics are identical; not every UIClass value has a corresponding widget.

public enum UIWidget

Fields

AdjustableSlatsRollerShutter = 1

Widget for a roller shutter with individually tiltable slats.

AirPlaySocket = 4

Widget for an AirPlay-enabled smart socket.

Alarm = 2

Widget for an alarm panel or intrusion detection system.

AlarmRemoteController = 3

Widget for an alarm-specific remote controller.

AtmosphericPressureSensor = 5

Widget for a barometric pressure sensor.

Awning = 6

Widget for a retractable fabric awning.

Camera = 7

Widget for a security or surveillance camera.

CarbonDioxideSensor = 8

Widget for a CO₂ concentration sensor.

CarbonMonoxideSensor = 9

Widget for a CO concentration sensor.

CircuitBreaker = 10

Widget for a smart circuit breaker.

ConfigurableGate = 11

Widget for a configurable entry gate.

ContactSensor = 12

Widget for a magnetic contact / door-window open sensor.

Curtain = 14

Widget for a fabric curtain that draws to the side(s).

CyclicSlidingGateOpener = 13

Widget for a cyclic sliding gate opener.

DimmerExteriorHeating = 15

Widget for an exterior heater with variable (dimmer) control.

DimmerLight = 16

Widget for a dimmable light.

Door = 17

Widget for a motorised or smart door.

DoorLock = 18

Widget for an electronic door lock.

DynamicRemoteController = 19

Widget for a dynamic remote controller.

DynamicScene = 20

Widget for a dynamic scene object.

DynamicSceneLauncherController = 21

Widget for a dynamic scene-launcher controller.

ElectricitySensor = 22

Widget for a real-time electricity consumption sensor.

EmptyRemoteController = 23

Widget for an unconfigured or placeholder remote controller.

ExteriorBlind = 24

Widget for an exterior fabric or slat blind.

ExteriorScreen = 25

Widget for an exterior roller screen.

ExteriorVenetianBlind = 26

Widget for an exterior Venetian blind.

Fan = 27

Widget for a ceiling or desk fan.

FanController = 28

Widget for a fan controller hub.

GarageDoor = 29

Widget for a motorised garage door.

Gate = 30

Widget for a motorised entry gate.

Generic = 31

Widget for a generic device with no specific template.

HeatingSystem = 32

Widget for a heating system controller.

HitachiAirToAirHeatPump = 33

Widget for a Hitachi air-to-air heat pump.

HorizontalAwning = 34

Widget for a horizontal retractable awning.

HumiditySensor = 35

Widget for a relative humidity sensor.

Light = 36

Widget for an on/off light fixture.

LightSensor = 37

Widget for an ambient light level sensor.

Lock = 38

Widget for a generic lock.

MotionSensor = 39

Widget for a motion / PIR sensor.

NoiseSensor = 40

Widget for an acoustic noise level sensor.

OccupancySensor = 41

Widget for an occupancy / presence sensor.

OnOff = 42

Widget for a simple on/off relay or smart plug.

OnOffLight = 43

Widget for a non-dimmable on/off light.

Pergola = 44

Widget for a fixed-louvre pergola.

Pool = 45

Widget for a swimming pool controller.

PoolPump = 46

Widget for a pool circulation pump.

ProtocolGateway = 47

Widget for a protocol gateway/bridge device.

Pump = 48

Widget for a generic pump actuator.

PushButton = 49

Widget for a push-button controller.

RainAlarmSensor = 50

Widget for a rain sensor that also exposes an alarm state.

RainSensor = 51

Widget for a rain / precipitation sensor.

RemoteControllerOneWay = 52

Widget for a one-way remote controller.

RollerShutter = 53

Widget for a roller shutter.

ScenarioTrigger = 55

Widget for a scenario trigger control.

Scene = 56

Widget for a scene object.

Screen = 54

Widget for an interior roller screen.

Siren = 57

Widget for an alarm siren.

SirenSensor = 58

Widget for a combined siren and sensor.

SmokeSensor = 59

Widget for a smoke detector.

SolenoidValve = 60

Widget for a solenoid valve actuator.

StartStopTimer = 63

Widget for a combined start/stop timer control.

StartTimer = 64

Widget for a start timer control.

StatefulOnOffSwitch = 65

Widget for a stateful on/off wall switch.

StatelessAlarm = 61

Widget for a stateless alarm panel.

StatelessExteriorHeating = 62

Widget for a stateless exterior heater.

SwimmingPool = 66

Widget for a full swimming pool management system.

SwingingShutter = 67

Widget for a hinged or bi-fold swinging shutter.

TemperatureSensor = 68

Widget for an ambient temperature sensor.

ThermostatZonesController = 69

Widget for a multi-zone thermostat controller.

TiltOnlyVenetianBlind = 70

Widget for a Venetian blind that can only tilt (no travel).

TimedOnOff = 71

Widget for a timed on/off relay.

TimedOnOffLight = 72

Widget for a timed on/off light.

TimedSolenoidValve = 73

Widget for a timed solenoid valve actuator.

TwoButtonsController = 74

Widget for a two-buttons controller.

UniversalSensor = 75

Widget for a configurable universal sensor.

Unknown = 0

Widget name could not be parsed or is not yet known to this library.

Untyped = 76

Widget for an unclassified device.

UpDownRollerShutter = 77

Widget for a roller shutter with up/down travel.

UpDownScreen = 78

Widget for an interior screen with up/down travel.

UpDownVenetianBlind = 79

Widget for a Venetian blind with up/down travel and slat tilt.

UpDownWindow = 80

Widget for a motorised window with up/down travel.

UrmetCallForwarding = 94

Widget for Urmet call-forwarding control.

UrmetStack = 95

Widget for an Urmet stack/integration component.

ValveHeatingTemperatureInterface = 81

Widget for a thermostatic valve with temperature interface.

VentilationExtractor = 82

Widget for a ventilation extractor unit.

VentilationInlet = 83

Widget for a controlled fresh-air ventilation inlet.

VentilationOutlet = 84

Widget for a controlled exhaust-air ventilation outlet.

VentilationTransfer = 85

Widget for a controlled inter-zone ventilation transfer damper.

WallHeatingTemperatureInterface = 93

Widget for a wall heating temperature interface.

WaterDetectionSensor = 86

Widget for a water ingress / flood detection sensor.

WeatherForecastSensor = 87

Widget for a multi-parameter weather forecast sensor.

Wifi = 88

Widget for a Wi-Fi access point or repeater.

WindSpeedAndDirectionSensor = 90

Widget for an anemometer measuring wind speed and direction.

WindSpeedSensor = 89

Widget for an anemometer measuring wind speed only.

WindowLock = 91

Widget for a motorised or smart window lock.

WindowWithTiltSensor = 92

Widget for a window sensor that detects tilt as well as open/closed state.

YokisTransceiver = 96

Widget for a Yokis transceiver.

ZWaveTransceiver = 97

Widget for a Z-Wave transceiver module.

ZigbeeNetwork = 98

Widget for a Zigbee network coordinator or router.

ZigbeeStack = 99

Widget for a Zigbee protocol stack component.