@ginden/ha-mqtt-discoverable
    Preparing search index...

    Class NumberInfo

    Information about the 'number' entity

    Hierarchy (View Summary)

    Index

    Properties

    component device? deviceClass? enabledByDefault? entityCategory? expireAfter? forceUpdate? icon? max min mode? name objectId? optimistic? payloadReset? qos? retain? stateTopic? step? uniqueId? unitOfMeasurement?

    Methods

    modelDump propertyMap create wholeValidation

    Properties

    component: "number" = 'number'

    One of the supported MQTT components, for instance binary_sensor

    device?: DeviceInfo

    Information about the device this sensor belongs to

    deviceClass?: string

    Sets the class of the device, changing the device state and icon that is displayed on the frontend.

    enabledByDefault?: boolean

    Flag which defines if the entity should be enabled when first added.

    entityCategory?: string

    Classification of a non-primary entity.

    expireAfter?: number

    If set, it defines the number of seconds after the sensor’s state expires, if it’s not updated. After expiry, the sensor’s state becomes unavailable. Default the sensors state never expires.

    forceUpdate?: boolean

    Sends update events even if the value hasn’t changed. Useful if you want to have meaningful value graphs in history.

    icon?: string

    Icon of the entity

    max: number = 100

    The maximum value of the number (defaults to 100)

    min: number = 1

    The maximum value of the number (defaults to 1)

    mode?: "box" | "slider" | "auto"

    Control how the number should be displayed in the UI. Can be set to box or slider to force a display mode.

    name: string

    Name of the sensor inside Home Assistant

    objectId?: string

    Set this to generate the entity_id in HA instead of using name

    optimistic?: boolean

    Flag that defines if switch works in optimistic mode. Default: true if no state_topic defined, else false.

    payloadReset?: string

    A special payload that resets the state to None when received on the state_topic.

    qos?: number

    The maximum QoS level to be used when receiving messages.

    retain?: boolean

    If the published message should have the retain flag on or not

    stateTopic?: string

    The MQTT topic subscribed to receive state updates.

    step?: number

    Step value. Smallest acceptable value is 0.001. Defaults to 1.0.

    uniqueId?: string

    Set this to enable editing sensor from the HA ui and to integrate with a device

    unitOfMeasurement?: string

    Defines the unit of measurement of the sensor, if any. The unit_of_measurement can be null.

    Methods

    • Generates a JSON object that can be used as an MQTT payload.

      Returns Record<string, unknown>

    • Mapping of class properties to MQTT payload keys.

      Returns {
          component: "component";
          device: "device";
          deviceClass: "device_class";
          enabledByDefault: "enabled_by_default";
          entityCategory: "entity_category";
          expireAfter: "expire_after";
          forceUpdate: "force_update";
          icon: "icon";
          max: "max";
          min: "min";
          mode: "mode";
          name: "name";
          objectId: "object_id";
          optimistic: "optimistic";
          payloadReset: "payload_reset";
          qos: "qos";
          retain: "retain";
          stateTopic: "state_topic";
          step: "step";
          uniqueId: "unique_id";
          unitOfMeasurement: "unit_of_measurement";
      }

    Settings

    Member Visibility

    On This Page

    Properties
    Methods