Class Definition

Full capability definition for a device, describing every command it accepts and every state it can report.

public sealed class Definition

Inherited Members: object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

Properties

All commands supported by the device.

[JsonPropertyName("commands")]
public IReadOnlyList<CommandDefinition> Commands { get; init; }

Qualified name of the device controllable type (e.g. "io:RollerShutterGenericIOComponent").

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

All states the device can report.

[JsonPropertyName("states")]
public IReadOnlyList<StateDefinition> States { get; init; }

UI class name used by the Overkiz app to categorise the device.

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

UI widget name used by the Overkiz app to render the device.

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