Home Assistant

MQTT Number

The mqtt Number platform allows you to integrate devices that might expose configuration options through MQTT into Home Assistant as a Number. Every time a message under the topic in the configuration is received, the number entity will be updated in Home Assistant and vice-versa, keeping the device and Home Assistant in-sync.

Configuration

To enable MQTT Number in your installation, add the following to your configuration.yaml file:

# Example configuration.yaml entry
mqtt:
  - number:
      command_topic: my-device/threshold

Configuration Variables

Looking for your configuration file?
availability list (Optional)

A list of MQTT topics subscribed to receive availability (online/offline) updates. Must not be used together with availability_topic.

payload_available string (Optional, default: online)

The payload that represents the available state.

payload_not_available string (Optional, default: offline)

The payload that represents the unavailable state.

topic string Required

An MQTT topic subscribed to receive availability (online/offline) updates.

availability_topic string (Optional)

The MQTT topic subscribed to receive availability (online/offline) updates. Must not be used together with availability.

availability_mode string (Optional, default: latest)

When availability is configured, this controls the conditions needed to set the entity to available. Valid entries are all, any, and latest. If set to all, payload_available must be received on all configured availability topics before the entity is marked as online. If set to any, payload_available must be received on at least one configured availability topic before the entity is marked as online. If set to latest, the last payload_available or payload_not_available received on any configured availability topic controls the availability.

command_template template (Optional)

Defines a template to generate the payload to send to command_topic.

command_topic string Required

The MQTT topic to publish commands to change the number.

device map (Optional)

Information about the device this Number is a part of to tie it into the device registry. Only works when unique_id is set. At least one of identifiers or connections must be present to identify the device.

configuration_url string (Optional)

A link to the webpage that can manage the configuration of this device. Can be either an http://, https:// or an internal homeassistant:// URL.

connections list (Optional)

A list of connections of the device to the outside world as a list of tuples [connection_type, connection_identifier]. For example the MAC address of a network interface: "connections": [["mac", "02:5b:26:a8:dc:12"]].

hw_version string (Optional)

The hardware version of the device.

identifiers list | string (Optional)

A list of IDs that uniquely identify the device. For example a serial number.

manufacturer string (Optional)

The manufacturer of the device.

model string (Optional)

The model of the device.

name string (Optional)

The name of the device.

serial_number string (Optional)

The serial number of the device.

suggested_area string (Optional)

Suggest an area if the device isn’t in one yet.

sw_version string (Optional)

The firmware version of the device.

via_device string (Optional)

Identifier of a device that routes messages between this device and Home Assistant. Examples of such devices are hubs, or parent devices of a sub-device. This is used to show device topology in Home Assistant.

device_class device_class (Optional)

The type/class of the number. The device_class can be null.

enabled_by_default boolean (Optional, default: true)

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

encoding string (Optional, default: utf-8)

The encoding of the payloads received and published messages. Set to "" to disable decoding of incoming payload.

entity_category string (Optional)

The category of the entity.

icon icon (Optional)

Icon for the entity.

json_attributes_template template (Optional)

Defines a template to extract the JSON dictionary from messages received on the json_attributes_topic.

json_attributes_topic string (Optional)

The MQTT topic subscribed to receive a JSON dictionary payload and then set as number attributes. Implies force_update of the current number state when a message is received on this topic.

min float (Optional, default: 1)

Minimum value.

max float (Optional, default: 100)

Maximum value.

mode string (Optional, default: “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 (Optional)

The name of the Number. Can be set to null if only the device name is relevant.

object_id string (Optional)

Used instead of name for automatic generation of entity_id

optimistic boolean (Optional)

Flag that defines if number works in optimistic mode.

Default:

true if no state_topic defined, else false.

payload_reset string (Optional, default: “None”)

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

qos integer (Optional, default: 0)

The maximum QoS level to be used when receiving and publishing messages.

retain boolean (Optional, default: false)

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

state_topic string (Optional)

The MQTT topic subscribed to receive number values.

step float (Optional, default: 1)

Step value. Smallest value 0.001.

unique_id string (Optional)

An ID that uniquely identifies this Number. If two Numbers have the same unique ID Home Assistant will raise an exception.

unit_of_measurement string (Optional)

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

value_template template (Optional)

Defines a template to extract the value.

Make sure that your topic matches exactly. some-topic/ and some-topic are different topics.