mirror of
https://github.com/adrianjagielak/home-assistant-futurehome.git
synced 2025-09-13 07:37:09 +00:00
102 lines
3.2 KiB
TypeScript
102 lines
3.2 KiB
TypeScript
import { BaseComponent } from './_base_component';
|
|
|
|
/**
|
|
* Represents a MQTT Vacuum component for Home Assistant MQTT Discovery.
|
|
*
|
|
* The `mqtt` vacuum integration allows you to control your MQTT-enabled vacuum.
|
|
* The initial state of the MQTT vacuum entity is `unknown` and can be reset by sending a `null` payload as state.
|
|
*
|
|
* For detailed documentation see:
|
|
* https://www.home-assistant.io/integrations/vacuum.mqtt/
|
|
*/
|
|
export interface VacuumComponent extends BaseComponent {
|
|
/**
|
|
* Must be `vacuum`.
|
|
* Only allowed and required in [MQTT auto discovery device messages](https://www.home-assistant.io/integrations/mqtt/#device-discovery-payload).
|
|
*/
|
|
platform: 'vacuum';
|
|
|
|
/**
|
|
* The MQTT topic to publish commands to control the vacuum.
|
|
*/
|
|
command_topic?: string;
|
|
|
|
/**
|
|
* List of possible fan speeds for the vacuum.
|
|
*/
|
|
fan_speed_list?: string[];
|
|
|
|
/**
|
|
* Defines a [template](https://www.home-assistant.io/docs/configuration/templating/#using-value-templates-with-mqtt)
|
|
* to extract the JSON dictionary from messages received on the `json_attributes_topic`.
|
|
* Usage example can be found in [MQTT sensor](https://www.home-assistant.io/integrations/sensor.mqtt/#json-attributes-template-configuration) documentation.
|
|
*/
|
|
json_attributes_template?: string;
|
|
|
|
/**
|
|
* The MQTT topic subscribed to receive a JSON dictionary payload and then set as sensor attributes.
|
|
* Usage example can be found in [MQTT sensor](https://www.home-assistant.io/integrations/sensor.mqtt/#json-attributes-topic-configuration) documentation.
|
|
*/
|
|
json_attributes_topic?: string;
|
|
|
|
/**
|
|
* The payload to send to the `command_topic` to begin a spot cleaning cycle.
|
|
* Default: "clean_spot"
|
|
*/
|
|
payload_clean_spot?: string;
|
|
|
|
/**
|
|
* The payload to send to the `command_topic` to locate the vacuum (typically plays a song).
|
|
* Default: "locate"
|
|
*/
|
|
payload_locate?: string;
|
|
|
|
/**
|
|
* The payload to send to the `command_topic` to pause the vacuum.
|
|
* Default: "pause"
|
|
*/
|
|
payload_pause?: string;
|
|
|
|
/**
|
|
* The payload to send to the `command_topic` to tell the vacuum to return to base.
|
|
* Default: "return_to_base"
|
|
*/
|
|
payload_return_to_base?: string;
|
|
|
|
/**
|
|
* The payload to send to the `command_topic` to begin the cleaning cycle.
|
|
* Default: "start"
|
|
*/
|
|
payload_start?: string;
|
|
|
|
/**
|
|
* The payload to send to the `command_topic` to stop cleaning.
|
|
* Default: "stop"
|
|
*/
|
|
payload_stop?: string;
|
|
|
|
/**
|
|
* The MQTT topic to publish custom commands to the vacuum.
|
|
*/
|
|
send_command_topic?: string;
|
|
|
|
/**
|
|
* The MQTT topic to publish commands to control the vacuum's fan speed.
|
|
*/
|
|
set_fan_speed_topic?: string;
|
|
|
|
/**
|
|
* The MQTT topic subscribed to receive state messages from the vacuum.
|
|
* Messages received on the `state_topic` must be a valid JSON dictionary,
|
|
* with a mandatory `state` key and optionally `battery_level` and `fan_speed` keys.
|
|
*/
|
|
state_topic?: string;
|
|
|
|
/**
|
|
* List of features that the vacuum supports.
|
|
* Possible values: "start", "stop", "pause", "return_home", "battery", "status", "locate", "clean_spot", "fan_speed", "send_command".
|
|
* Default: "start", "stop", "return_home", "status", "battery", "clean_spot"
|
|
*/
|
|
supported_features?: string[];
|
|
}
|