Class Device

Namespace

OverKizApi.Models

Assembly

OverKizApi.dll

Represents a physical or virtual device registered in a setup. The DeviceUrl uniquely identifies the device across the entire API.

public sealed class Device

Inheritance

object

Device

Inherited Members

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

Properties

Attributes

Device attributes (manufacturer-specific, immutable metadata states).

[JsonPropertyName("attributes")]
public States Attributes { get; init; }

Property Value

States

Available

Whether the device is currently reachable by the gateway.

[JsonPropertyName("available")]
public bool Available { get; init; }

Property Value

bool

ControllableName

Controllable type name (e.g. "io:RollerShutterGenericIOComponent").

[JsonPropertyName("controllableName")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
public string? ControllableName { get; init; }

Property Value

string

DataProperties

Manufacturer-defined data properties (opaque).

[JsonPropertyName("dataProperties")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
[JsonConverter(typeof(DeviceValuesConverter))]
public IReadOnlyList<object?>? DataProperties { get; init; }

Property Value

IReadOnlyList<object>

Definition

Full capability definition (commands and states) for this device.

[JsonPropertyName("definition")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
public Definition? Definition { get; init; }

Property Value

Definition

DeviceAddress

Device address portion parsed from the device URL.

[JsonIgnore]
public string? DeviceAddress { get; }

Property Value

string

DeviceUrl

Unique device URL in the format protocol://gatewayId/deviceAddress[#subsystemId] (e.g. io://1234-5678-9012/12345678).

[JsonPropertyName("deviceURL")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
public string? DeviceUrl { get; init; }

Property Value

string

Enabled

Whether the device is enabled in the user's setup.

[JsonPropertyName("enabled")]
public bool Enabled { get; init; }

Property Value

bool

GatewayId

Gateway serial number parsed from the device URL.

[JsonIgnore]
public string? GatewayId { get; }

Property Value

string

Id

Alias for DeviceUrl; provided for convenience.

[JsonIgnore]
public string? Id { get; }

Property Value

string

IsSubDevice

true if this device is a sub-device (has a SubsystemId).

[JsonIgnore]
public bool IsSubDevice { get; }

Property Value

bool

Label

User-visible label for the device.

[JsonPropertyName("label")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
public string? Label { get; init; }

Property Value

string

PlaceOid

OID of the place (room/floor) the device is assigned to.

[JsonPropertyName("placeOid")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
public string? PlaceOid { get; init; }

Property Value

string

Protocol

Communication protocol parsed from the device URL prefix (e.g. Io).

[JsonIgnore]
public Protocol? Protocol { get; }

Property Value

Protocol?

States

Current live states reported by the device.

[JsonPropertyName("states")]
public States States { get; init; }

Property Value

States

SubsystemId

Sub-system index parsed from the device URL fragment, or null for top-level devices.

[JsonIgnore]
public int? SubsystemId { get; }

Property Value

int?

Type

Whether the device is an actuator, a sensor, or unknown.

[JsonPropertyName("type")]
public ProductType Type { get; init; }

Property Value

ProductType

UiClass

UI class parsed from UiClass.

[JsonIgnore]
public UIClass? UiClass { get; }

Property Value

UIClass?

Widget

UI widget parsed from WidgetName.

[JsonIgnore]
public UIWidget? Widget { get; }

Property Value

UIWidget?