Home Assistant Unofficial Reference 2024.12.1
Classes | Functions | Variables
homeassistant.components.mqtt.update Namespace Reference

Classes

class  MqttUpdate
 

Functions

None async_setup_entry (HomeAssistant hass, ConfigEntry config_entry, AddEntitiesCallback async_add_entities)
 

Variables

 _LOGGER = logging.getLogger(__name__)
 
string CONF_DISPLAY_PRECISION = "display_precision"
 
string CONF_LATEST_VERSION_TEMPLATE = "latest_version_template"
 
string CONF_LATEST_VERSION_TOPIC = "latest_version_topic"
 
string CONF_PAYLOAD_INSTALL = "payload_install"
 
string CONF_RELEASE_SUMMARY = "release_summary"
 
string CONF_RELEASE_URL = "release_url"
 
string CONF_TITLE = "title"
 
string DEFAULT_NAME = "MQTT Update"
 
 DISCOVERY_SCHEMA = vol.All(PLATFORM_SCHEMA_MODERN.extend({}, extra=vol.REMOVE_EXTRA))
 
 MQTT_JSON_UPDATE_SCHEMA
 
int PARALLEL_UPDATES = 0
 
 PLATFORM_SCHEMA_MODERN
 

Detailed Description

Configure update platform in a device through MQTT topic.

Function Documentation

◆ async_setup_entry()

None homeassistant.components.mqtt.update.async_setup_entry ( HomeAssistant  hass,
ConfigEntry  config_entry,
AddEntitiesCallback  async_add_entities 
) 
Set up MQTT update entity through YAML and through MQTT discovery.

Definition at line 82 of file update.py.

Variable Documentation

◆ _LOGGER

homeassistant.components.mqtt.update._LOGGER = logging.getLogger(__name__)
private

Definition at line 33 of file update.py.

◆ CONF_DISPLAY_PRECISION

string homeassistant.components.mqtt.update.CONF_DISPLAY_PRECISION = "display_precision"

Definition at line 39 of file update.py.

◆ CONF_LATEST_VERSION_TEMPLATE

string homeassistant.components.mqtt.update.CONF_LATEST_VERSION_TEMPLATE = "latest_version_template"

Definition at line 40 of file update.py.

◆ CONF_LATEST_VERSION_TOPIC

string homeassistant.components.mqtt.update.CONF_LATEST_VERSION_TOPIC = "latest_version_topic"

Definition at line 41 of file update.py.

◆ CONF_PAYLOAD_INSTALL

string homeassistant.components.mqtt.update.CONF_PAYLOAD_INSTALL = "payload_install"

Definition at line 42 of file update.py.

◆ CONF_RELEASE_SUMMARY

string homeassistant.components.mqtt.update.CONF_RELEASE_SUMMARY = "release_summary"

Definition at line 43 of file update.py.

◆ CONF_RELEASE_URL

string homeassistant.components.mqtt.update.CONF_RELEASE_URL = "release_url"

Definition at line 44 of file update.py.

◆ CONF_TITLE

string homeassistant.components.mqtt.update.CONF_TITLE = "title"

Definition at line 45 of file update.py.

◆ DEFAULT_NAME

string homeassistant.components.mqtt.update.DEFAULT_NAME = "MQTT Update"

Definition at line 37 of file update.py.

◆ DISCOVERY_SCHEMA

homeassistant.components.mqtt.update.DISCOVERY_SCHEMA = vol.All(PLATFORM_SCHEMA_MODERN.extend({}, extra=vol.REMOVE_EXTRA))

Definition at line 65 of file update.py.

◆ MQTT_JSON_UPDATE_SCHEMA

homeassistant.components.mqtt.update.MQTT_JSON_UPDATE_SCHEMA
Initial value:
1 = vol.Schema(
2  {
3  vol.Optional("installed_version"): cv.string,
4  vol.Optional("latest_version"): cv.string,
5  vol.Optional("title"): cv.string,
6  vol.Optional("release_summary"): cv.string,
7  vol.Optional("release_url"): cv.url,
8  vol.Optional("entity_picture"): cv.url,
9  vol.Optional("in_progress"): cv.boolean,
10  vol.Optional("update_percentage"): vol.Any(vol.Range(min=0, max=100), None),
11  }
12 )

Definition at line 68 of file update.py.

◆ PARALLEL_UPDATES

int homeassistant.components.mqtt.update.PARALLEL_UPDATES = 0

Definition at line 35 of file update.py.

◆ PLATFORM_SCHEMA_MODERN

homeassistant.components.mqtt.update.PLATFORM_SCHEMA_MODERN
Initial value:
1 = MQTT_RO_SCHEMA.extend(
2  {
3  vol.Optional(CONF_COMMAND_TOPIC): valid_publish_topic,
4  vol.Optional(CONF_DEVICE_CLASS): vol.Any(DEVICE_CLASSES_SCHEMA, None),
5  vol.Optional(CONF_DISPLAY_PRECISION, default=0): cv.positive_int,
6  vol.Optional(CONF_LATEST_VERSION_TEMPLATE): cv.template,
7  vol.Optional(CONF_LATEST_VERSION_TOPIC): valid_subscribe_topic,
8  vol.Optional(CONF_NAME): vol.Any(cv.string, None),
9  vol.Optional(CONF_PAYLOAD_INSTALL): cv.string,
10  vol.Optional(CONF_RELEASE_SUMMARY): cv.string,
11  vol.Optional(CONF_RELEASE_URL): cv.string,
12  vol.Optional(CONF_RETAIN, default=DEFAULT_RETAIN): cv.boolean,
13  vol.Optional(CONF_TITLE): cv.string,
14  },
15 ).extend(MQTT_ENTITY_COMMON_SCHEMA.schema)

Definition at line 48 of file update.py.