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 Assisant 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
number:
- platform: mqtt
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.
Information about the device this Number is a part of to tie it into the device registry. Only works through MQTT discovery and when unique_id
is set.
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.
Icon for the number.
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.
Flag that defines if number works in optimistic mode.
true
if no state_topic
defined, else false
.
The maximum QoS level of the state topic. Default is 0 and will also be used to publishing messages.
If the published message should have the retain flag on or not.
Make sure that your topic matches exactly. some-topic/
and some-topic
are different topics.
Suggest an edit to this page, or provide/view feedback for this page.