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.yamlThe configuration.yaml file is the main configuration file for Home Assistant. It lists the integrations to be loaded and their specific configurations. In some cases, the configuration needs to be edited manually directly in the configuration.yaml file. Most integrations can be configured in the UI.[Learn more] file:
# Example configuration.yaml entry
mqtt:
- number:
command_topic: my-device/threshold
Configuration Variables
A list of MQTT topics subscribed to receive availability (online/offline) updates. Must not be used together with availability_topic.
The payload that represents the available state.
The payload that represents the unavailable state.
The MQTT topic subscribed to receive availability (online/offline) updates. Must not be used together with availability.
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.
Defines a template to generate the payload to send to command_topic.
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.
A link to the webpage that can manage the configuration of this device. Can be either an http://, https:// or an internal homeassistant:// URL.
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"]].
A list of IDs that uniquely identify the device. For example a serial number.
The type/class of the number. The device_class can be null.
Flag which defines if the entity should be enabled when first added.
The encoding of the payloads received and published messages. Set to "" to disable decoding of incoming payload.
The category of the entity.
Defines a template to extract the JSON dictionary from messages received on the json_attributes_topic.
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.
Control how the number should be displayed in the UI. Can be set to box or slider to force a display mode.
The name of the Number. Can be set to null if only the device name is relevant.
Flag that defines if number works in optimistic mode.
true if no state_topic defined, else false.
A special payload that resets the state to unknown when received on the state_topic.
The maximum QoS level to be used when receiving and publishing messages.
If the published message should have the retain flag on or not.
An ID that uniquely identifies this Number. If two Numbers have the same unique ID Home Assistant will raise an exception.
Defines the unit of measurement of the sensor, if any. The unit_of_measurement can be null.
Make sure that your topic matches exactly. some-topic/ and some-topic are different topics.