Class NumberConfig

Namespace

HaMqttDiscoverable.Entities

Assembly

HaMqttDiscoverable.dll

Configuration for a Number entity: a numeric value that can be read and set.

public sealed class NumberConfig : EntityConfig

Inheritance

object

EntityConfig

NumberConfig

Inherited Members

EntityConfig.Name

EntityConfig.UniqueId

EntityConfig.ObjectId

EntityConfig.Device

EntityConfig.HasEntityName

EntityConfig.Icon

EntityConfig.DeviceClass

EntityConfig.EntityCategory

EntityConfig.EnabledByDefault

EntityConfig.Qos

EntityConfig.Availability

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Properties

Component

The MQTT component Home Assistant should treat this entity as, e.g. sensor or switch. Used to build the discovery topic; not part of the discovery payload itself.

public override string Component { get; }

Property Value

string

Max

The maximum value. Defaults to 100.

[JsonPropertyName("max")]
public double? Max { get; set; }

Property Value

double?

Min

The minimum value. Defaults to 1.

[JsonPropertyName("min")]
public double? Min { get; set; }

Property Value

double?

Mode

How the number should be displayed: "auto" (default), "box", or "slider".

[JsonPropertyName("mode")]
public string? Mode { get; set; }

Property Value

string

Step

The step between selectable values. Defaults to 1.

[JsonPropertyName("step")]
public double? Step { get; set; }

Property Value

double?

UnitOfMeasurement

The unit of measurement of the value, e.g. "%".

[JsonPropertyName("unit_of_measurement")]
public string? UnitOfMeasurement { get; set; }

Property Value

string