evan/home-assistant-futurehome
1
0
Fork 0
mirror of https://github.com/adrianjagielak/home-assistant-futurehome.git synced 2025-09-13 15:47:08 +00:00
Code Issues Packages Projects Releases Wiki Activity

Remove unnecessary MQTT components interface fields

Browse Source
This commit is contained in:
Adrian Jagielak 2025-07-24 16:03:53 +02:00
parent 1a7ed95c6b
commit 09b98321a1
No known key found for this signature in database
GPG Key ID: 0818CF7AF6C62BFB
29 changed files with 2 additions and 3202 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
futurehome/config.yaml
View File

@ -1,6 +1,6 @@
# https://developers.home-assistant.io/docs/add-ons/configuration#add-on-config
name: Futurehome
version: "0.0.30"
version: "0.0.31"
slug: futurehome
description: Local Futurehome Smarthub integration
url: "https://github.com/adrianjagielak/home-assistant-futurehome"

123
futurehome/src/ha/mqtt_components/alarm_control_panel.ts
View File

@ -41,56 +41,6 @@ export interface AlarmControlPanelComponent {
*/
command_topic: string;
/**
* A list of MQTT topics subscribed to receive availability (online/offline) updates.
* Must not be used together with `availability_topic`.
*/
availability?: Array<{
/**
* An MQTT topic subscribed to receive availability (online/offline) updates.
*/
topic: string;
/**
* The payload that represents the available state.
* Default: "online"
*/
payload_available?: string;
/**
* The payload that represents the unavailable state.
* Default: "offline"
*/
payload_not_available?: string;
/**
* Defines a [template](https://www.home-assistant.io/docs/configuration/templating/#using-value-templates-with-mqtt)
* to extract device's availability from the `topic`.
* To determine the device's availability, result of this template will be compared to `payload_available` and `payload_not_available`.
*/
value_template?: string;
}>;
/**
* When `availability` is configured, this controls the conditions needed to set the entity to `available`.
* Valid values: "all", "any", "latest".
* Default: "latest"
*/
availability_mode?: 'all' | 'any' | 'latest';
/**
* Defines a [template](https://www.home-assistant.io/docs/configuration/templating/#using-value-templates-with-mqtt)
* to extract device's availability from the `availability_topic`.
* To determine the device's availability, result of this template will be compared to `payload_available` and `payload_not_available`.
*/
availability_template?: string;
/**
* The MQTT topic subscribed to receive availability (online/offline) updates.
* Must not be used together with `availability`.
*/
availability_topic?: string;
/**
* If defined, specifies a code to enable or disable the alarm in the frontend.
* Note that the code is validated locally and blocks sending MQTT messages to the remote device.
@ -126,79 +76,6 @@ export interface AlarmControlPanelComponent {
*/
command_template?: string;
/**
* Information about the device this alarm panel is a part of to tie it into the [device registry](https://developers.home-assistant.io/docs/en/device_registry_index.html).
* Only works when [`unique_id`](#unique_id) is set.
* At least one of identifiers or connections must be present to identify the device.
*/
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.
*/
configuration_url?: string;
/**
* 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"]]`.
*/
connections?: Array<[string, string]>;
/**
* The hardware version of the device.
*/
hw_version?: string;
/**
* A list of IDs that uniquely identify the device.
* For example a serial number.
*/
identifiers?: string[];
/**
* The manufacturer of the device.
*/
manufacturer?: string;
/**
* The model of the device.
*/
model?: string;
/**
* The model identifier of the device.
*/
model_id?: string;
/**
* The name of the device.
*/
name?: string;
/**
* The serial number of the device.
*/
serial_number?: string;
/**
* Suggest an area if the device isn’t in one yet.
*/
suggested_area?: string;
/**
* The firmware version of the device.
*/
sw_version?: string;
/**
* 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.
*/
via_device?: string;
};
/**
* Flag which defines if the entity should be enabled when first added.
* Default: true

125
futurehome/src/ha/mqtt_components/binary_sensor.ts
View File

@ -137,58 +137,6 @@ export interface BinarySensorComponent {
*/
off_delay?: number;
/**
* A list of MQTT topics subscribed to receive availability (online/offline) updates.
* Must not be used together with `availability_topic`.
*/
availability?: Array<{
/**
* An MQTT topic subscribed to receive availability (online/offline) updates.
*/
topic: string;
/**
* The payload that represents the available state.
* Default: "online"
*/
payload_available?: string;
/**
* The payload that represents the unavailable state.
* Default: "offline"
*/
payload_not_available?: string;
/**
* Defines a [template](https://www.home-assistant.io/docs/configuration/templating/#using-value-templates-with-mqtt)
* to extract device's availability from the `topic`.
* To determine the device's availability, result of this template will be compared to `payload_available` and `payload_not_available`.
*/
value_template?: string;
}>;
/**
* When `availability` is configured, this controls the conditions needed to set the entity to `available`.
* Valid values: "all", "any", "latest"
* Default: "latest"
*/
availability_mode?: 'all' | 'any' | 'latest';
/**
* Defines a [template](https://www.home-assistant.io/docs/configuration/templating/#using-value-templates-with-mqtt)
* to extract device's availability from the `availability_topic`.
* To determine the device's availability, result of this template will be compared to `payload_available` and `payload_not_available`.
*/
availability_template?: string;
/**
* The MQTT topic subscribed to receive birth and LWT messages from the MQTT device.
* If `availability` is not defined, the binary sensor will always be considered `available` and its state will be `on`, `off` or `unknown`.
* If `availability` is defined, the binary sensor will be considered as `unavailable` by default and the sensor's initial state will be `unavailable`.
* Must not be used together with `availability`.
*/
availability_topic?: string;
/**
* The string that represents the `online` state.
* Default: "online"
@ -200,77 +148,4 @@ export interface BinarySensorComponent {
* Default: "offline"
*/
payload_not_available?: string;
/**
* Information about the device this binary sensor is a part of to tie it into the [device registry](https://developers.home-assistant.io/docs/device_registry_index/).
* Only works when [`unique_id`](#unique_id) is set.
* At least one of identifiers or connections must be present to identify the device.
*/
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.
*/
configuration_url?: string;
/**
* 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"]]`.
*/
connections?: Array<[string, string]>;
/**
* The hardware version of the device.
*/
hw_version?: string;
/**
* A list of IDs that uniquely identify the device.
* For example a serial number.
*/
identifiers?: string[];
/**
* The manufacturer of the device.
*/
manufacturer?: string;
/**
* The model of the device.
*/
model?: string;
/**
* The model identifier of the device.
*/
model_id?: string;
/**
* The name of the device.
*/
name?: string;
/**
* The serial number of the device.
*/
serial_number?: string;
/**
* Suggest an area if the device isn’t in one yet.
*/
suggested_area?: string;
/**
* The firmware version of the device.
*/
sw_version?: string;
/**
* 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.
*/
via_device?: string;
};
}

123
futurehome/src/ha/mqtt_components/button.ts
View File

@ -38,129 +38,6 @@ export interface ButtonComponent {
*/
payload_press?: string;
/**
* A list of MQTT topics subscribed to receive availability (online/offline) updates.
* Must not be used together with `availability_topic`.
*/
availability?: Array<{
/**
* An MQTT topic subscribed to receive availability (online/offline) updates.
*/
topic: string;
/**
* The payload that represents the available state.
* Default: "online"
*/
payload_available?: string;
/**
* The payload that represents the unavailable state.
* Default: "offline"
*/
payload_not_available?: string;
/**
* Defines a [template](https://www.home-assistant.io/docs/configuration/templating/#using-value-templates-with-mqtt)
* to extract device's availability from the `topic`.
* To determine the device's availability, result of this template will be compared to `payload_available` and `payload_not_available`.
*/
value_template?: string;
}>;
/**
* When `availability` is configured, this controls the conditions needed to set the entity to `available`.
* Valid values: "all", "any", "latest".
* Default: "latest"
*/
availability_mode?: 'all' | 'any' | 'latest';
/**
* Defines a [template](https://www.home-assistant.io/docs/configuration/templating/#using-value-templates-with-mqtt)
* to extract device's availability from the `availability_topic`.
* To determine the device's availability, result of this template will be compared to `payload_available` and `payload_not_available`.
*/
availability_template?: string;
/**
* The MQTT topic subscribed to receive availability (online/offline) updates.
* Must not be used together with `availability`.
*/
availability_topic?: string;
/**
* Information about the device this button is a part of to tie it into the [device registry](https://developers.home-assistant.io/docs/en/device_registry_index.html).
* Only works when [`unique_id`](#unique_id) is set.
* At least one of identifiers or connections must be present to identify the device.
*/
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.
*/
configuration_url?: string;
/**
* 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"]]`.
*/
connections?: Array<[string, string]>;
/**
* The hardware version of the device.
*/
hw_version?: string;
/**
* A list of IDs that uniquely identify the device.
* For example a serial number.
*/
identifiers?: string[];
/**
* The manufacturer of the device.
*/
manufacturer?: string;
/**
* The model of the device.
*/
model?: string;
/**
* The model identifier of the device.
*/
model_id?: string;
/**
* The name of the device.
*/
name?: string;
/**
* The serial number of the device.
*/
serial_number?: string;
/**
* Suggest an area if the device isn’t in one yet.
*/
suggested_area?: string;
/**
* The firmware version of the device.
*/
sw_version?: string;
/**
* 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.
*/
via_device?: string;
};
/**
* The [type/class](https://www.home-assistant.io/integrations/button/#device-class) of the button to set the icon in the frontend.
* The `device_class` can be `null`.

125
futurehome/src/ha/mqtt_components/camera.ts
View File

@ -27,131 +27,6 @@ export interface CameraComponent {
*/
topic: string;
/**
* A list of MQTT topics subscribed to receive availability (online/offline) updates.
* Must not be used together with `availability_topic`.
*/
availability?: Array<{
/**
* An MQTT topic subscribed to receive availability (online/offline) updates.
*/
topic: string;
/**
* The payload that represents the available state.
* Default: "online"
*/
payload_available?: string;
/**
* The payload that represents the unavailable state.
* Default: "offline"
*/
payload_not_available?: string;
/**
* Defines a [template](https://www.home-assistant.io/docs/configuration/templating/#using-value-templates-with-mqtt)
* to extract device's availability from the `topic`.
* To determine the device's availability, result of this template will be compared to `payload_available` and `payload_not_available`.
*/
value_template?: string;
}>;
/**
* When `availability` is configured, this controls the conditions needed to set the entity to `available`.
* Valid values: "all", "any", "latest"
* Default: "latest"
*
* See https://www.home-assistant.io/integrations/mqtt/#availability_mode
*/
availability_mode?: 'all' | 'any' | 'latest';
/**
* Defines a [template](https://www.home-assistant.io/docs/configuration/templating/#using-value-templates-with-mqtt)
* to extract device's availability from the `availability_topic`.
* To determine the device's availability, result of this template will be compared to `payload_available` and `payload_not_available`.
*/
availability_template?: string;
/**
* The MQTT topic subscribed to receive availability (online/offline) updates.
* Must not be used together with `availability`.
*/
availability_topic?: string;
/**
* Information about the device this camera is a part of to tie it into the [device registry](https://developers.home-assistant.io/docs/en/device_registry_index.html).
* Only works when [`unique_id`](#unique_id) is set.
* At least one of identifiers or connections must be present to identify the device.
*/
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.
*/
configuration_url?: string;
/**
* 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"]]`.
*/
connections?: Array<[string, string]>;
/**
* The hardware version of the device.
*/
hw_version?: string;
/**
* A list of IDs that uniquely identify the device.
* For example a serial number.
*/
identifiers?: string[] | string;
/**
* The manufacturer of the device.
*/
manufacturer?: string;
/**
* The model of the device.
*/
model?: string;
/**
* The model identifier of the device.
*/
model_id?: string;
/**
* The name of the device.
*/
name?: string;
/**
* The serial number of the device.
*/
serial_number?: string;
/**
* Suggest an area if the device isn’t in one yet.
*/
suggested_area?: string;
/**
* The firmware version of the device.
*/
sw_version?: string;
/**
* 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.
*/
via_device?: string;
};
/**
* Flag which defines if the entity should be enabled when first added.
* Default: true

50
futurehome/src/ha/mqtt_components/climate.ts
View File

@ -33,56 +33,6 @@ export interface ClimateComponent {
*/
action_topic?: string;
/**
* A list of MQTT topics subscribed to receive availability (online/offline) updates.
* Must not be used together with `availability_topic`.
*/
availability?: Array<{
/**
* An MQTT topic subscribed to receive availability (online/offline) updates.
*/
topic: string;
/**
* The payload that represents the available state.
* Default: "online"
*/
payload_available?: string;
/**
* The payload that represents the unavailable state.
* Default: "offline"
*/
payload_not_available?: string;
/**
* Defines a [template](https://www.home-assistant.io/docs/configuration/templating/#using-value-templates-with-mqtt)
* to extract device's availability from the `topic`.
* To determine the device's availability, result of this template will be compared to `payload_available` and `payload_not_available`.
*/
value_template?: string;
}>;
/**
* When `availability` is configured, this controls the conditions needed to set the entity to `available`.
* Valid values: "all", "any", "latest".
* Default: "latest".
*/
availability_mode?: 'all' | 'any' | 'latest';
/**
* Defines a [template](https://www.home-assistant.io/docs/configuration/templating/#using-value-templates-with-mqtt)
* to extract device's availability from the `availability_topic`.
* To determine the device's availability, result of this template will be compared to `payload_available` and `payload_not_available`.
*/
availability_template?: string;
/**
* The MQTT topic subscribed to receive availability (online/offline) updates.
* Must not be used together with `availability`.
*/
availability_topic?: string;
/**
* A template with which the value received on `current_humidity_topic` will be rendered.
*/

138
futurehome/src/ha/mqtt_components/cover.ts
View File

@ -20,149 +20,11 @@ export interface CoverComponent {
*/
unique_id: string;
/**
* A list of MQTT topics subscribed to receive availability (online/offline) updates.
* Must not be used together with `availability_topic`.
*
* Each item describes:
* - topic: An MQTT topic subscribed to receive availability (online/offline) updates.
* - payload_available: The payload that represents the available state. Default: "online"
* - payload_not_available: The payload that represents the unavailable state. Default: "offline"
* - value_template: Defines a [template](https://www.home-assistant.io/docs/configuration/templating/#using-value-templates-with-mqtt)
* to extract device's availability from the `topic`. To determine the device's availability,
* the result of this template will be compared to `payload_available` and `payload_not_available`.
*
* See https://www.home-assistant.io/integrations/mqtt/ for more info on availability.
*/
availability?: Array<{
/**
* An MQTT topic subscribed to receive availability (online/offline) updates.
*/
topic: string;
/**
* The payload that represents the available state.
* Default: "online"
*/
payload_available?: string;
/**
* The payload that represents the unavailable state.
* Default: "offline"
*/
payload_not_available?: string;
/**
* Defines a [template](https://www.home-assistant.io/docs/configuration/templating/#using-value-templates-with-mqtt)
* to extract device's availability from the `topic`. To determine the device's availability,
* the result of this template will be compared to `payload_available` and `payload_not_available`.
*/
value_template?: string;
}>;
/**
* When `availability` is configured, this controls the conditions needed to set the entity to `available`.
* Valid values: `all`, `any`, `latest`.
* Default: "latest"
*
* - "all": `payload_available` must be received on all configured availability topics before the entity is marked as online.
* - "any": `payload_available` must be received on at least one configured availability topic before the entity is marked as online.
* - "latest": The last `payload_available` or `payload_not_available` received on any configured availability topic controls the availability.
*/
availability_mode?: 'all' | 'any' | 'latest';
/**
* Defines a [template](https://www.home-assistant.io/docs/configuration/templating/#using-value-templates-with-mqtt)
* to extract device's availability from the `availability_topic`. To determine the device's availability,
* the result of this template will be compared to `payload_available` and `payload_not_available`.
*/
availability_template?: string;
/**
* The subscribed-to MQTT topic to receive birth and LWT messages from the MQTT cover device.
* If an `availability` topic is not defined, the cover availability state will always be `available`.
* If an `availability` topic is defined, the cover availability state will be `unavailable` by default.
* Must not be used together with `availability`.
*/
availability_topic?: string;
/**
* The MQTT topic to publish commands to control the cover.
*/
command_topic?: string;
/**
* Information about the device this cover is a part of to tie it into the [device registry](https://developers.home-assistant.io/docs/en/device_registry_index.html).
* Only works when [`unique_id`](#unique_id) is set.
* At least one of identifiers or connections must be present to identify the device.
*/
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.
*/
configuration_url?: string;
/**
* 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"]]`.
*/
connections?: Array<[string, string]>;
/**
* The hardware version of the device.
*/
hw_version?: string;
/**
* A list of IDs that uniquely identify the device. For example a serial number.
*/
identifiers?: string[];
/**
* The manufacturer of the device.
*/
manufacturer?: string;
/**
* The model of the device.
*/
model?: string;
/**
* The model identifier of the device.
*/
model_id?: string;
/**
* The name of the device.
*/
name?: string;
/**
* The serial number of the device.
*/
serial_number?: string;
/**
* Suggest an area if the device isn’t in one yet.
*/
suggested_area?: string;
/**
* The firmware version of the device.
*/
sw_version?: string;
/**
* 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.
*/
via_device?: string;
};
/**
* Sets the [class of the device](https://www.home-assistant.io/integrations/cover/#device_class),
* changing the device state and icon that is displayed on the frontend.

67
futurehome/src/ha/mqtt_components/device_automation.ts
View File

@ -65,73 +65,6 @@ export interface DeviceAutomationComponent {
*/
subtype: string;
/**
* Information about the device this device trigger is a part of to tie it into the [device registry](https://developers.home-assistant.io/docs/en/device_registry_index.html).
* At least one of identifiers or connections must be present to identify the device.
*/
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.
*/
configuration_url?: string;
/**
* 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"]]`.
*/
connections?: Array<[string, string]>;
/**
* A list of IDs that uniquely identify the device.
* For example a serial number.
*/
identifiers?: string[];
/**
* The manufacturer of the device.
*/
manufacturer?: string;
/**
* The model of the device.
*/
model?: string;
/**
* The model identifier of the device.
*/
model_id?: string;
/**
* The name of the device.
*/
name?: string;
/**
* The serial number of the device.
*/
serial_number?: string;
/**
* Suggest an area if the device isn’t in one yet.
*/
suggested_area?: string;
/**
* The firmware version of the device.
*/
sw_version?: string;
/**
* 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.
*/
via_device?: string;
};
/**
* Defines a [template](https://www.home-assistant.io/docs/configuration/templating/#using-value-templates-with-mqtt) to extract the value.
*/

119
futurehome/src/ha/mqtt_components/device_tracker.ts
View File

@ -2,8 +2,7 @@
* Represents a MQTT Device Tracker component for Home Assistant MQTT Discovery.
*
* The `mqtt` device tracker platform allows tracking devices' presence and location
* through MQTT messages. It supports tracking using state topics and/or JSON attributes topics,
* with optional availability topics for device online/offline state reporting.
* through MQTT messages.
*
* For detailed documentation see:
* https://www.home-assistant.io/integrations/device_tracker.mqtt/
@ -113,122 +112,6 @@ export interface DeviceTrackerComponent {
*/
payload_not_available?: string;
/**
* The MQTT topic subscribed to receive birth and LWT messages from the MQTT device.
* If `availability` is not defined, the device tracker will always be considered `available`.
* Must not be used together with `availability`.
*/
availability_topic?: string;
/**
* A list of MQTT topics subscribed to receive availability (online/offline) updates.
* Must not be used together with `availability_topic`.
*/
availability?: Array<{
/**
* An MQTT topic subscribed to receive availability (online/offline) updates.
*/
topic: string;
/**
* The payload that represents the available state.
* Default: "online"
*/
payload_available?: string;
/**
* The payload that represents the unavailable state.
* Default: "offline"
*/
payload_not_available?: string;
/**
* Defines a [template](https://www.home-assistant.io/docs/configuration/templating/#using-value-templates-with-mqtt)
* to extract device's availability from the `topic`.
* To determine the device's availability, result of this template will be compared to `payload_available` and `payload_not_available`.
*/
value_template?: string;
}>;
/**
* When `availability` is configured, this controls the conditions needed to set the entity to `available`.
* Valid values: "all", "any", "latest".
* Default: "latest".
*
* When set to `all`, `payload_available` must be received on all configured availability topics before the entity is marked as online.
* When set to `any`, `payload_available` must be received on at least one configured availability topic before the entity is marked as online.
* When set to `latest`, the last `payload_available` or `payload_not_available` received on any configured availability topic controls the availability.
*/
availability_mode?: 'all' | 'any' | 'latest';
/**
* Information about the device this device tracker is a part of that ties it into the [device registry](https://developers.home-assistant.io/docs/en/device_registry_index.html).
* Only works when [`unique_id`](#unique_id) is set.
* At least one of identifiers or connections must be present to identify the device.
*/
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.
*/
configuration_url?: string;
/**
* 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"]]`.
*/
connections?: Array<[string, string]>;
/**
* The hardware version of the device.
*/
hw_version?: string;
/**
* A list of IDs that uniquely identify the device.
* For example a serial number.
*/
identifiers?: string[];
/**
* The manufacturer of the device.
*/
manufacturer?: string;
/**
* The model of the device.
*/
model?: string;
/**
* The model identifier of the device.
*/
model_id?: string;
/**
* The name of the device.
*/
name?: string;
/**
* Suggest an area if the device isn’t in one yet.
*/
suggested_area?: string;
/**
* The firmware version of the device.
*/
sw_version?: string;
/**
* 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.
*/
via_device?: string;
};
/**
* [Icon](https://www.home-assistant.io/docs/configuration/customizing-devices/#icon) for the entity.
*/

123
futurehome/src/ha/mqtt_components/event.ts
View File

@ -36,129 +36,6 @@ export interface EventComponent {
*/
event_types: string[];
/**
* A list of MQTT topics subscribed to receive availability (online/offline) updates.
* Must not be used together with `availability_topic`.
*/
availability?: Array<{
/**
* An MQTT topic subscribed to receive availability (online/offline) updates.
*/
topic: string;
/**
* The payload that represents the available state.
* Default: "online"
*/
payload_available?: string;
/**
* The payload that represents the unavailable state.
* Default: "offline"
*/
payload_not_available?: string;
/**
* Defines a [template](https://www.home-assistant.io/docs/configuration/templating/#using-value-templates-with-mqtt)
* to extract device's availability from the `topic`.
* To determine the device's availability, result of this template will be compared to `payload_available` and `payload_not_available`.
*/
value_template?: string;
}>;
/**
* When `availability` is configured, this controls the conditions needed to set the entity to `available`.
* Valid values: "all", "any", "latest"
* Default: "latest"
*/
availability_mode?: 'all' | 'any' | 'latest';
/**
* Defines a [template](https://www.home-assistant.io/docs/configuration/templating/#using-value-templates-with-mqtt)
* to extract device's availability from the `availability_topic`.
* To determine the device's availability, result of this template will be compared to `payload_available` and `payload_not_available`.
*/
availability_template?: string;
/**
* The MQTT topic subscribed to receive availability (online/offline) updates.
* Must not be used together with `availability`.
*/
availability_topic?: string;
/**
* Information about the device this event is a part of to tie it into the [device registry](https://developers.home-assistant.io/docs/core/device_registry_index/).
* Only works when [`unique_id`](#unique_id) is set.
* At least one of identifiers or connections must be present to identify the device.
*/
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.
*/
configuration_url?: string;
/**
* 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"]]`.
*/
connections?: Array<[string, string]>;
/**
* The hardware version of the device.
*/
hw_version?: string;
/**
* A list of IDs that uniquely identify the device.
* For example a serial number.
*/
identifiers?: string[];
/**
* The manufacturer of the device.
*/
manufacturer?: string;
/**
* The model of the device.
*/
model?: string;
/**
* The model identifier of the device.
*/
model_id?: string;
/**
* The name of the device.
*/
name?: string;
/**
* The serial number of the device.
*/
serial_number?: string;
/**
* Suggest an area if the device isn’t in one yet.
*/
suggested_area?: string;
/**
* The firmware version of the device.
*/
sw_version?: string;
/**
* 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.
*/
via_device?: string;
};
/**
* The [type/class](https://www.home-assistant.io/integrations/event/#device-class) of the event to set the icon in the frontend.
* The `device_class` can be `null`.

125
futurehome/src/ha/mqtt_components/fan.ts
View File

@ -211,58 +211,6 @@ export interface FanComponent {
*/
json_attributes_topic?: string;
/**
* The MQTT topic subscribed to receive availability (online/offline) updates.
* Must not be used together with `availability_topic`.
*/
availability?: Array<{
/**
* An MQTT topic subscribed to receive availability (online/offline) updates.
*/
topic: string;
/**
* The payload that represents the available state.
* Default: "online"
*/
payload_available?: string;
/**
* The payload that represents the unavailable state.
* Default: "offline"
*/
payload_not_available?: string;
/**
* Defines a [template](https://www.home-assistant.io/docs/configuration/templating/#using-value-templates-with-mqtt)
* to extract device's availability from the `topic`.
* To determine the device's availability, result of this template will be compared to `payload_available` and `payload_not_available`.
*/
value_template?: string;
}>;
/**
* When `availability` is configured, this controls the conditions needed to set the entity to `available`.
* Valid values: "all", "any", "latest"
* Default: "latest"
*/
availability_mode?: 'all' | 'any' | 'latest';
/**
* Defines a [template](https://www.home-assistant.io/docs/configuration/templating/#using-value-templates-with-mqtt)
* to extract device's availability from the `availability_topic`.
* To determine the device's availability, result of this template will be compared to `payload_available` and `payload_not_available`.
*/
availability_template?: string;
/**
* The MQTT topic subscribed to receive birth and LWT messages from the MQTT device.
* If `availability` is not defined, the fan will always be considered `available` and its state will be as per the last command/state.
* If `availability` is defined, the fan will be considered as `unavailable` by default.
* Must not be used together with `availability`.
*/
availability_topic?: string;
/**
* The payload that represents the available state.
* Default: "online"
@ -324,77 +272,4 @@ export interface FanComponent {
* Default: 1
*/
speed_range_min?: number;
/**
* Information about the device this fan is a part of to tie it into the [device registry](https://developers.home-assistant.io/docs/en/device_registry_index.html).
* Only works when [`unique_id`](#unique_id) is set.
* At least one of identifiers or connections must be present to identify the device.
*/
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.
*/
configuration_url?: string;
/**
* 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"]]`.
*/
connections?: Array<[string, string]>;
/**
* The hardware version of the device.
*/
hw_version?: string;
/**
* A list of IDs that uniquely identify the device.
* For example a serial number.
*/
identifiers?: string[];
/**
* The manufacturer of the device.
*/
manufacturer?: string;
/**
* The model of the device.
*/
model?: string;
/**
* The model identifier of the device.
*/
model_id?: string;
/**
* The name of the device.
*/
name?: string;
/**
* The serial number of the device.
*/
serial_number?: string;
/**
* Suggest an area if the device isn’t in one yet.
*/
suggested_area?: string;
/**
* The firmware version of the device.
*/
sw_version?: string;
/**
* 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.
*/
via_device?: string;
};
}

123
futurehome/src/ha/mqtt_components/humidifier.ts
View File

@ -166,56 +166,6 @@ export interface HumidifierComponent {
*/
min_humidity?: number;
/**
* The MQTT topic subscribed to receive availability (online/offline) updates.
* Must not be used together with `availability`.
*/
availability_topic?: string;
/**
* A list of MQTT topics subscribed to receive availability (online/offline) updates.
* Must not be used together with `availability_topic`.
*/
availability?: Array<{
/**
* An MQTT topic subscribed to receive availability (online/offline) updates.
*/
topic: string;
/**
* The payload that represents the available state.
* Default: "online"
*/
payload_available?: string;
/**
* The payload that represents the unavailable state.
* Default: "offline"
*/
payload_not_available?: string;
/**
* Defines a [template](https://www.home-assistant.io/docs/configuration/templating/#using-value-templates-with-mqtt)
* to extract device's availability from the `topic`.
* To determine the device's availability, result of this template will be compared to `payload_available` and `payload_not_available`.
*/
value_template?: string;
}>;
/**
* When `availability` is configured, this controls the conditions needed to set the entity to `available`.
* Valid values: "all", "any", "latest"
* Default: "latest"
*/
availability_mode?: 'all' | 'any' | 'latest';
/**
* Defines a [template](https://www.home-assistant.io/docs/configuration/templating/#using-value-templates-with-mqtt)
* to extract device's availability from the `availability_topic`.
* To determine the device's availability, result of this template will be compared to `payload_available` and `payload_not_available`.
*/
availability_template?: string;
/**
* The string that represents the `online` state.
* Default: `"online"`
@ -292,77 +242,4 @@ export interface HumidifierComponent {
* Default: true
*/
retain?: boolean;
/**
* Information about the device this humidifier is a part of to tie it into the [device registry](https://developers.home-assistant.io/docs/en/device_registry_index.html).
* Only works when [`unique_id`](#unique_id) is set.
* At least one of identifiers or connections must be present to identify the device.
*/
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.
*/
configuration_url?: string;
/**
* 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"]]`.
*/
connections?: Array<[string, string]>;
/**
* The hardware version of the device.
*/
hw_version?: string;
/**
* A list of IDs that uniquely identify the device.
* For example a serial number.
*/
identifiers?: string[];
/**
* The manufacturer of the device.
*/
manufacturer?: string;
/**
* The model of the device.
*/
model?: string;
/**
* The model identifier of the device.
*/
model_id?: string;
/**
* The name of the device.
*/
name?: string;
/**
* The serial number of the device.
*/
serial_number?: string;
/**
* Suggest an area if the device isn’t in one yet.
*/
suggested_area?: string;
/**
* The firmware version of the device.
*/
sw_version?: string;
/**
* 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.
*/
via_device?: string;
};
}

51
futurehome/src/ha/mqtt_components/image.ts
View File

@ -70,57 +70,6 @@ export interface ImageComponent {
*/
encoding?: string;
/**
* A list of MQTT topics subscribed to receive availability (online/offline) updates.
* Must not be used together with `availability_topic`.
*/
availability?: Array<{
/**
* An MQTT topic subscribed to receive availability (online/offline) updates.
*/
topic: string;
/**
* The payload that represents the available state.
* Default: "online"
*/
payload_available?: string;
/**
* The payload that represents the unavailable state.
* Default: "offline"
*/
payload_not_available?: string;
/**
* Defines a [template](https://www.home-assistant.io/docs/configuration/templating/#using-value-templates-with-mqtt)
* to extract device's availability from the `topic`.
* To determine the device's availability, result of this template will be compared to `payload_available` and `payload_not_available`.
*/
value_template?: string;
}>;
/**
* When `availability` is configured, this controls the conditions needed to set the entity to `available`.
* Valid values: "all", "any", "latest".
* Default: "latest"
* See https://www.home-assistant.io/integrations/mqtt/#device-discovery-payload
*/
availability_mode?: 'all' | 'any' | 'latest';
/**
* Defines a [template](https://www.home-assistant.io/docs/configuration/templating/#using-value-templates-with-mqtt)
* to extract device's availability from the `availability_topic`.
* To determine the device's availability, result of this template will be compared to `payload_available` and `payload_not_available`.
*/
availability_template?: string;
/**
* The MQTT topic subscribed to receive availability (online/offline) updates.
* Must not be used together with `availability`.
*/
availability_topic?: string;
/**
* Flag which defines if the entity should be enabled when first added.
* Default: true

126
futurehome/src/ha/mqtt_components/lawn_mower.ts
View File

@ -33,132 +33,6 @@ export interface LawnMowerComponent {
*/
activity_value_template?: string;
/**
* A list of MQTT topics subscribed to receive availability (online/offline) updates.
* Must not be used together with `availability_topic`.
*/
availability?: Array<{
/**
* An MQTT topic subscribed to receive availability (online/offline) updates.
*/
topic: string;
/**
* The payload that represents the available state.
* Default: "online"
*/
payload_available?: string;
/**
* The payload that represents the unavailable state.
* Default: "offline"
*/
payload_not_available?: string;
/**
* Defines a [template](https://www.home-assistant.io/docs/configuration/templating/#using-value-templates-with-mqtt)
* to extract the device's availability from the `topic`.
* To determine the device's availability, the result of this template will be compared to `payload_available` and `payload_not_available`.
*/
value_template?: string;
}>;
/**
* The MQTT topic subscribed to receive availability (online/offline) updates.
* Must not be used together with `availability`.
*/
availability_topic?: string;
/**
* 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.
* Default: "latest"
*/
availability_mode?: 'all' | 'any' | 'latest';
/**
* Defines a [template](https://www.home-assistant.io/docs/configuration/templating/#using-value-templates-with-mqtt)
* to extract device's availability from the `availability_topic`.
* To determine the device's availability, the result of this template will be compared to `payload_available` and `payload_not_available`.
*/
availability_template?: string;
/**
* Information about the device this lawn mower is a part of to tie it into the [device registry](https://developers.home-assistant.io/docs/en/device_registry_index.html).
* Only works when the [`unique_id`](#unique_id) is set.
* At least one of the identifiers or connections must be present to identify the device.
*/
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.
*/
configuration_url?: string;
/**
* 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"]]`.
*/
connections?: Array<[string, string]>;
/**
* The hardware version of the device.
*/
hw_version?: string;
/**
* A list of IDs that uniquely identify the device.
* For example, a serial number.
*/
identifiers?: string[];
/**
* The manufacturer of the device.
*/
manufacturer?: string;
/**
* The model of the device.
*/
model?: string;
/**
* The model identifier of the device.
*/
model_id?: string;
/**
* The name of the device.
*/
name?: string;
/**
* The serial number of the device.
*/
serial_number?: string;
/**
* Suggest an area if the device isn’t in one yet.
*/
suggested_area?: string;
/**
* The firmware version of the device.
*/
sw_version?: string;
/**
* 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 the device topology in Home Assistant.
*/
via_device?: string;
};
/**
* Defines a [template](https://www.home-assistant.io/docs/configuration/templating/#using-command-templates-with-mqtt)
* to generate the payload to send to `dock_command_topic`.

123
futurehome/src/ha/mqtt_components/light.ts
View File

@ -21,56 +21,6 @@ export interface LightComponent {
*/
unique_id?: string;
/**
* A list of MQTT topics subscribed to receive availability (online/offline) updates.
* Must not be used together with `availability_topic`.
*/
availability?: Array<{
/**
* An MQTT topic subscribed to receive availability (online/offline) updates.
*/
topic: string;
/**
* The payload that represents the available state.
* Default: "online"
*/
payload_available?: string;
/**
* The payload that represents the unavailable state.
* Default: "offline"
*/
payload_not_available?: string;
/**
* Defines a [template](https://www.home-assistant.io/docs/configuration/templating/#using-value-templates-with-mqtt)
* to extract device's availability from the `topic`.
* To determine the device's availability, result of this template will be compared to `payload_available` and `payload_not_available`.
*/
value_template?: string;
}>;
/**
* When `availability` is configured, this controls the conditions needed to set the entity to `available`.
* Valid values: "all", "any", "latest".
* Default: "latest"
*/
availability_mode?: 'all' | 'any' | 'latest';
/**
* Defines a [template](https://www.home-assistant.io/docs/configuration/templating/#using-value-templates-with-mqtt)
* to extract device's availability from the `availability_topic`.
* To determine the device's availability, result of this template will be compared to `payload_available` and `payload_not_available`.
*/
availability_template?: string;
/**
* The MQTT topic subscribed to receive availability (online/offline) updates.
* Must not be used together with `availability`.
*/
availability_topic?: string;
/**
* Flag that defines if light supports brightness when the `rgb`, `rgbw`, or `rgbww` color mode is supported.
* Only for JSON schema.
@ -460,79 +410,6 @@ export interface LightComponent {
*/
payload_on?: string;
/**
* Information about the device this light is a part of to tie it into the [device registry](https://developers.home-assistant.io/docs/device_registry_index/).
* Only works when [`unique_id`](#unique_id) is set.
* At least one of identifiers or connections must be present to identify the device.
*/
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.
*/
configuration_url?: string;
/**
* 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"]]`.
*/
connections?: Array<[string, string]>;
/**
* The hardware version of the device.
*/
hw_version?: string;
/**
* A list of IDs that uniquely identify the device.
* For example a serial number.
*/
identifiers?: string[];
/**
* The manufacturer of the device.
*/
manufacturer?: string;
/**
* The model of the device.
*/
model?: string;
/**
* The model identifier of the device.
*/
model_id?: string;
/**
* The name of the device.
*/
name?: string;
/**
* The serial number of the device.
*/
serial_number?: string;
/**
* Suggest an area if the device isn’t in one yet.
*/
suggested_area?: string;
/**
* The firmware version of the device.
*/
sw_version?: string;
/**
* 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.
*/
via_device?: string;
};
/**
* The schema to use.
* Must be one of `basic` (default), `json`, or `template`.

122
futurehome/src/ha/mqtt_components/lock.ts
View File

@ -33,56 +33,6 @@ export interface LockComponent {
*/
state_topic?: string;
/**
* A list of MQTT topics subscribed to receive availability (online/offline) updates.
* Must not be used together with `availability_topic`.
*/
availability?: Array<{
/**
* An MQTT topic subscribed to receive availability (online/offline) updates.
*/
topic: string;
/**
* The payload that represents the available state.
* Default: "online"
*/
payload_available?: string;
/**
* The payload that represents the unavailable state.
* Default: "offline"
*/
payload_not_available?: string;
/**
* Defines a [template](https://www.home-assistant.io/docs/configuration/templating/#using-value-templates-with-mqtt)
* to extract device's availability from the `topic`.
* To determine the device's availability, result of this template will be compared to `payload_available` and `payload_not_available`.
*/
value_template?: string;
}>;
/**
* When `availability` is configured, this controls the conditions needed to set the entity to `available`.
* Valid values: "all", "any", "latest"
* Default: "latest"
*/
availability_mode?: 'all' | 'any' | 'latest';
/**
* Defines a [template](https://www.home-assistant.io/docs/configuration/templating/#using-value-templates-with-mqtt)
* to extract device's availability from the `availability_topic`.
* To determine the device's availability, result of this template will be compared to `payload_available` and `payload_not_available`.
*/
availability_template?: string;
/**
* The MQTT topic subscribed to receive availability (online/offline) updates.
* Must not be used together with `availability`.
*/
availability_topic?: string;
/**
* A regular expression to validate a supplied code when it is set during the action to `open`, `lock` or `unlock` the MQTT lock.
*/
@ -97,78 +47,6 @@ export interface LockComponent {
*/
command_template?: string;
/**
* Information about the device this lock is a part of to tie it into the [device registry](https://developers.home-assistant.io/docs/en/device_registry_index.html).
* Only works when [`unique_id`](#unique_id) is set. At least one of identifiers or connections must be present to identify the device.
*/
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.
*/
configuration_url?: string;
/**
* 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"]]`.
*/
connections?: Array<[string, string]>;
/**
* The hardware version of the device.
*/
hw_version?: string;
/**
* A list of IDs that uniquely identify the device.
* For example a serial number.
*/
identifiers?: string[] | string;
/**
* The manufacturer of the device.
*/
manufacturer?: string;
/**
* The model of the device.
*/
model?: string;
/**
* The model identifier of the device.
*/
model_id?: string;
/**
* The name of the device.
*/
name?: string;
/**
* The serial number of the device.
*/
serial_number?: string;
/**
* Suggest an area if the device isn’t in one yet.
*/
suggested_area?: string;
/**
* The firmware version of the device.
*/
sw_version?: string;
/**
* 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.
*/
via_device?: string;
};
/**
* Flag which defines if the entity should be enabled when first added.
* Default: true

126
futurehome/src/ha/mqtt_components/notify.ts
View File

@ -33,59 +33,6 @@ export interface NotifyComponent {
*/
command_template?: string;
/**
* A list of MQTT topics subscribed to receive availability (online/offline) updates.
* Must not be used together with `availability_topic`.
*/
availability?: Array<{
/**
* An MQTT topic subscribed to receive availability (online/offline) updates.
*/
topic: string;
/**
* The payload that represents the available state.
* Default: "online"
*/
payload_available?: string;
/**
* The payload that represents the unavailable state.
* Default: "offline"
*/
payload_not_available?: string;
/**
* Defines a [template](https://www.home-assistant.io/docs/configuration/templating/#using-value-templates-with-mqtt)
* to extract device's availability from the `topic`.
* To determine the device's availability, result of this template will be compared to `payload_available` and `payload_not_available`.
*/
value_template?: string;
}>;
/**
* When `availability` is configured, this controls the conditions needed to set the entity to `available`.
* Valid values: "all", "any", "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.
* Default: "latest"
*/
availability_mode?: 'all' | 'any' | 'latest';
/**
* Defines a [template](https://www.home-assistant.io/docs/configuration/templating/#using-value-templates-with-mqtt)
* to extract device's availability from the `availability_topic`.
* To determine the device's availability, result of this template will be compared to `payload_available` and `payload_not_available`.
*/
availability_template?: string;
/**
* The MQTT topic subscribed to receive availability (online/offline) updates.
* Must not be used together with `availability`.
*/
availability_topic?: string;
/**
* The encoding of the published messages.
* Default: "utf-8"
@ -161,77 +108,4 @@ export interface NotifyComponent {
* Default: "offline"
*/
payload_not_available?: string;
/**
* Information about the device this notify entity is a part of to tie it into the [device registry](https://developers.home-assistant.io/docs/en/device_registry_index.html).
* Only works when [`unique_id`](#unique_id) is set.
* At least one of identifiers or connections must be present to identify the device.
*/
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.
*/
configuration_url?: string;
/**
* 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"]]`.
*/
connections?: Array<[string, string]>;
/**
* The hardware version of the device.
*/
hw_version?: string;
/**
* A list of IDs that uniquely identify the device.
* For example a serial number.
*/
identifiers?: string[];
/**
* The manufacturer of the device.
*/
manufacturer?: string;
/**
* The model of the device.
*/
model?: string;
/**
* The model identifier of the device.
*/
model_id?: string;
/**
* The name of the device.
*/
name?: string;
/**
* The serial number of the device.
*/
serial_number?: string;
/**
* Suggest an area if the device isn’t in one yet.
*/
suggested_area?: string;
/**
* The firmware version of the device.
*/
sw_version?: string;
/**
* 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.
*/
via_device?: string;
};
}

122
futurehome/src/ha/mqtt_components/number.ts
View File

@ -153,126 +153,4 @@ export interface NumberComponent {
* Used instead of `name` for automatic generation of `entity_id`.
*/
object_id?: string;
/**
* A list of MQTT topics subscribed to receive availability (online/offline) updates.
* Must not be used together with `availability_topic`.
*/
availability?: Array<{
/**
* An MQTT topic subscribed to receive availability (online/offline) updates.
*/
topic: string;
/**
* The payload that represents the available state.
* Default: "online"
*/
payload_available?: string;
/**
* The payload that represents the unavailable state.
* Default: "offline"
*/
payload_not_available?: string;
/**
* Defines a [template](https://www.home-assistant.io/docs/configuration/templating/#using-value-templates-with-mqtt)
* to extract device's availability from the `topic`.
* To determine the device's availability, result of this template will be compared to `payload_available` and `payload_not_available`.
*/
value_template?: string;
}>;
/**
* When `availability` is configured, this controls the conditions needed to set the entity to `available`.
* Valid values: "all", "any", "latest"
* Default: "latest"
*/
availability_mode?: 'all' | 'any' | 'latest';
/**
* Defines a [template](https://www.home-assistant.io/docs/configuration/templating/#using-value-templates-with-mqtt)
* to extract device's availability from the `availability_topic`.
* To determine the device's availability, result of this template will be compared to `payload_available` and `payload_not_available`.
*/
availability_template?: string;
/**
* The MQTT topic subscribed to receive availability (online/offline) updates.
* Must not be used together with `availability`.
*/
availability_topic?: string;
/**
* Information about the device this Number is a part of to tie it into the [device registry](https://developers.home-assistant.io/docs/en/device_registry_index.html).
* Only works when [`unique_id`](#unique_id) is set.
* At least one of identifiers or connections must be present to identify the device.
*/
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.
*/
configuration_url?: string;
/**
* 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"]]`.
*/
connections?: Array<[string, string]>;
/**
* The hardware version of the device.
*/
hw_version?: string;
/**
* A list of IDs that uniquely identify the device. For example a serial number.
*/
identifiers?: string[];
/**
* The manufacturer of the device.
*/
manufacturer?: string;
/**
* The model of the device.
*/
model?: string;
/**
* The model identifier of the device.
*/
model_id?: string;
/**
* The name of the device.
*/
name?: string;
/**
* The serial number of the device.
*/
serial_number?: string;
/**
* Suggest an area if the device isn’t in one yet.
*/
suggested_area?: string;
/**
* The firmware version of the device.
*/
sw_version?: string;
/**
* 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.
*/
via_device?: string;
};
}

130
futurehome/src/ha/mqtt_components/scene.ts
View File

@ -30,16 +30,6 @@ export interface SceneComponent {
*/
payload_on?: string;
/**
* A list of MQTT topics subscribed to receive availability (online/offline) updates.
* Must not be used together with `availability_topic`.
*/
availability?: Array<{
/**
* An MQTT topic subscribed to receive availability (online/offline) updates.
*/
topic: string;
/**
* The payload that represents the available state.
* Default: "online"
@ -52,126 +42,6 @@ export interface SceneComponent {
*/
payload_not_available?: string;
/**
* Defines a [template](https://www.home-assistant.io/docs/configuration/templating/#using-value-templates-with-mqtt)
* to extract device's availability from the `topic`.
* To determine the device's availability, result of this template will be compared to `payload_available` and `payload_not_available`.
*/
value_template?: string;
}>;
/**
* When `availability` is configured, this controls the conditions needed to set the entity to `available`.
* Valid values: "all", "any", "latest"
* Default: "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.
*/
availability_mode?: 'all' | 'any' | 'latest';
/**
* Defines a [template](https://www.home-assistant.io/docs/configuration/templating/#using-value-templates-with-mqtt)
* to extract device's availability from the `availability_topic`.
* To determine the device's availability, result of this template will be compared to `payload_available` and `payload_not_available`.
*/
availability_template?: string;
/**
* The MQTT topic subscribed to receive availability (online/offline) updates.
* Must not be used together with `availability`.
*/
availability_topic?: string;
/**
* The payload that represents the available state.
* Default: "online"
*/
payload_available?: string;
/**
* The payload that represents the unavailable state.
* Default: "offline"
*/
payload_not_available?: string;
/**
* Information about the device this scene is a part of to tie it into the [device registry](https://developers.home-assistant.io/docs/en/device_registry_index.html).
* Only works when [`unique_id`](#unique_id) is set.
* At least one of identifiers or connections must be present to identify the device.
*/
device?: {
/**
* A link to the webpage that can manage the configuration of this device.
* Can be either an `http://` or `https://` URL.
*/
configuration_url?: string;
/**
* 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"]]`.
*/
connections?: Array<[string, string]>;
/**
* The hardware version of the device.
*/
hw_version?: string;
/**
* A list of IDs that uniquely identify the device.
* For example a serial number.
*/
identifiers?: string[] | string;
/**
* The manufacturer of the device.
*/
manufacturer?: string;
/**
* The model of the device.
*/
model?: string;
/**
* The model identifier of the device.
*/
model_id?: string;
/**
* The name of the device.
*/
name?: string;
/**
* The serial number of the device.
*/
serial_number?: string;
/**
* Suggest an area if the device isn’t in one yet.
*/
suggested_area?: string;
/**
* The firmware version of the device.
*/
sw_version?: string;
/**
* 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.
*/
via_device?: string;
};
/**
* Flag which defines if the entity should be enabled when first added.
* Default: true

124
futurehome/src/ha/mqtt_components/select.ts
View File

@ -118,128 +118,4 @@ export interface SelectComponent {
* Used instead of `name` for automatic generation of `entity_id`.
*/
object_id?: string;
/**
* Information about the device this Select is a part of to tie it into the [device registry](https://developers.home-assistant.io/docs/en/device_registry_index.html).
* Only works when [`unique_id`](#unique_id) is set.
* At least one of identifiers or connections must be present to identify the device.
*/
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.
*/
configuration_url?: string;
/**
* 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"]]`.
*/
connections?: Array<[string, string]>;
/**
* The hardware version of the device.
*/
hw_version?: string;
/**
* A list of IDs that uniquely identify the device.
* For example a serial number.
*/
identifiers?: string[];
/**
* The manufacturer of the device.
*/
manufacturer?: string;
/**
* The model of the device.
*/
model?: string;
/**
* The model identifier of the device.
*/
model_id?: string;
/**
* The name of the device.
*/
name?: string;
/**
* The serial number of the device.
*/
serial_number?: string;
/**
* Suggest an area if the device isn’t in one yet.
*/
suggested_area?: string;
/**
* The firmware version of the device.
*/
sw_version?: string;
/**
* 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.
*/
via_device?: string;
};
/**
* A list of MQTT topics subscribed to receive availability (online/offline) updates.
* Must not be used together with `availability_topic`.
*/
availability?: Array<{
/**
* An MQTT topic subscribed to receive availability (online/offline) updates.
*/
topic: string;
/**
* The payload that represents the available state.
* Default: "online"
*/
payload_available?: string;
/**
* The payload that represents the unavailable state.
* Default: "offline"
*/
payload_not_available?: string;
/**
* Defines a [template](https://www.home-assistant.io/docs/configuration/templating/#using-value-templates-with-mqtt)
* to extract device's availability from the `topic`.
* To determine the device's availability, result of this template will be compared to `payload_available` and `payload_not_available`.
*/
value_template?: string;
}>;
/**
* When `availability` is configured, this controls the conditions needed to set the entity to `available`.
* Valid values: "all", "any", "latest"
* Default: "latest"
*/
availability_mode?: 'all' | 'any' | 'latest';
/**
* Defines a [template](https://www.home-assistant.io/docs/configuration/templating/#using-value-templates-with-mqtt)
* to extract device's availability from the `availability_topic`.
* To determine the device's availability, result of this template will be compared to `payload_available` and `payload_not_available`.
*/
availability_template?: string;
/**
* The MQTT topic subscribed to receive availability (online/offline) updates.
* If `availability` is not defined, the select will always be considered `available`.
* Must not be used together with `availability`.
*/
availability_topic?: string;
}

122
futurehome/src/ha/mqtt_components/sensor.ts
View File

@ -149,16 +149,6 @@ export interface SensorComponent {
*/
last_reset_value_template?: string;
/**
* A list of MQTT topics subscribed to receive availability (online/offline) updates.
* Must not be used together with `availability_topic`.
*/
availability?: Array<{
/**
* An MQTT topic subscribed to receive availability (online/offline) updates.
*/
topic: string;
/**
* The payload that represents the available state.
* Default: "online"
@ -170,116 +160,4 @@ export interface SensorComponent {
* Default: "offline"
*/
payload_not_available?: string;
/**
* Defines a [template](https://www.home-assistant.io/docs/configuration/templating/#using-value-templates-with-mqtt) to extract device's availability from the `topic`.
* To determine the device's availability, result of this template will be compared to `payload_available` and `payload_not_available`.
*/
value_template?: string;
}>;
/**
* When `availability` is configured, this controls the conditions needed to set the entity to `available`.
* Valid values: "all", "any", "latest"
* Default: "latest"
*/
availability_mode?: 'all' | 'any' | 'latest';
/**
* Defines a [template](https://www.home-assistant.io/docs/configuration/templating/#using-value-templates-with-mqtt) to extract device's availability from the `availability_topic`.
* To determine the device's availability, result of this template will be compared to `payload_available` and `payload_not_available`.
*/
availability_template?: string;
/**
* The MQTT topic subscribed to receive availability (online/offline) updates.
* If `availability` is not defined, the sensor will always be considered `available`.
* Must not be used together with `availability`.
*/
availability_topic?: string;
/**
* The payload that represents the available state.
* Default: "online"
*/
payload_available?: string;
/**
* The payload that represents the unavailable state.
* Default: "offline"
*/
payload_not_available?: string;
/**
* Information about the device this sensor is a part of to tie it into the [device registry](https://developers.home-assistant.io/docs/device_registry_index/).
* Only works when [`unique_id`](#unique_id) is set.
* At least one of identifiers or connections must be present to identify the device.
*/
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.
*/
configuration_url?: string;
/**
* 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"]]`.
*/
connections?: Array<[string, string]>;
/**
* The hardware version of the device.
*/
hw_version?: string;
/**
* A list of IDs that uniquely identify the device.
* For example a serial number.
*/
identifiers?: string[];
/**
* The manufacturer of the device.
*/
manufacturer?: string;
/**
* The model of the device.
*/
model?: string;
/**
* The model identifier of the device.
*/
model_id?: string;
/**
* The name of the device.
*/
name?: string;
/**
* The serial number of the device.
*/
serial_number?: string;
/**
* Suggest an area if the device isn’t in one yet.
*/
suggested_area?: string;
/**
* The firmware version of the device.
*/
sw_version?: string;
/**
* 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.
*/
via_device?: string;
};
}

107
futurehome/src/ha/mqtt_components/siren.ts
View File

@ -39,71 +39,6 @@ export interface SirenComponent {
*/
command_topic?: string;
/**
* Information about the device this siren is a part of to tie it into the [device registry](https://developers.home-assistant.io/docs/core/device_registry_index/). Only works when [`unique_id`](#unique_id) is set. At least one of identifiers or connections must be present to identify the device.
*/
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.
*/
configuration_url?: string;
/**
* 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"]]`.
*/
connections?: Array<[string, string]>;
/**
* The hardware version of the device.
*/
hw_version?: string;
/**
* A list of IDs that uniquely identify the device. For example a serial number.
*/
identifiers?: string[] | string;
/**
* The manufacturer of the device.
*/
manufacturer?: string;
/**
* The model of the device.
*/
model?: string;
/**
* The model identifier of the device.
*/
model_id?: string;
/**
* The name of the device.
*/
name?: string;
/**
* The serial number of the device.
*/
serial_number?: string;
/**
* Suggest an area if the device isn’t in one yet.
*/
suggested_area?: string;
/**
* The firmware version of the device.
*/
sw_version?: string;
/**
* 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.
*/
via_device?: string;
};
/**
* Flag which defines if the entity should be enabled when first added.
* Default: true
@ -227,46 +162,4 @@ export interface SirenComponent {
* Default: true
*/
support_volume_set?: boolean;
/**
* A list of MQTT topics subscribed to receive availability (online/offline) updates. Must not be used together with `availability_topic`.
*/
availability?: Array<{
/**
* An MQTT topic subscribed to receive availability (online/offline) updates.
*/
topic: string;
/**
* The payload that represents the available state.
* Default: "online"
*/
payload_available?: string;
/**
* The payload that represents the unavailable state.
* Default: "offline"
*/
payload_not_available?: string;
/**
* Defines a [template](https://www.home-assistant.io/docs/configuration/templating/#using-value-templates-with-mqtt) to extract device's availability from the `topic`. To determine the device's availability, result of this template will be compared to `payload_available` and `payload_not_available`.
*/
value_template?: string;
}>;
/**
* When `availability` is configured, this controls the conditions needed to set the entity to `available`. Valid values: "all", "any", "latest". Default: "latest".
*/
availability_mode?: 'all' | 'any' | 'latest';
/**
* Defines a [template](https://www.home-assistant.io/docs/configuration/templating/#using-value-templates-with-mqtt) to extract device's availability from the `availability_topic`. To determine the device's availability, result of this template will be compared to `payload_available` and `payload_not_available`.
*/
availability_template?: string;
/**
* The MQTT topic subscribed to receive availability (online/offline) updates. Must not be used together with `availability`.
*/
availability_topic?: string;
}

123
futurehome/src/ha/mqtt_components/switch.ts
View File

@ -162,127 +162,4 @@ export interface SwitchComponent {
* To determine the switch's state, the result of this template will be compared to `state_on` and `state_off`.
*/
value_template?: string;
/**
* A list of MQTT topics subscribed to receive availability (online/offline) updates.
* Must not be used together with `availability_topic`.
*/
availability?: Array<{
/**
* An MQTT topic subscribed to receive availability (online/offline) updates.
*/
topic: string;
/**
* The payload that represents the available state.
* Default: "online"
*/
payload_available?: string;
/**
* The payload that represents the unavailable state.
* Default: "offline"
*/
payload_not_available?: string;
/**
* Defines a [template](https://www.home-assistant.io/docs/configuration/templating/#using-value-templates-with-mqtt)
* to extract device's availability from the `topic`.
* To determine the device's availability, result of this template will be compared to `payload_available` and `payload_not_available`.
*/
value_template?: string;
}>;
/**
* When `availability` is configured, this controls the conditions needed to set the entity to `available`.
* Valid values: "all", "any", "latest"
* Default: "latest"
*/
availability_mode?: 'all' | 'any' | 'latest';
/**
* Defines a [template](https://www.home-assistant.io/docs/configuration/templating/#using-value-templates-with-mqtt)
* to extract device's availability from the `availability_topic`.
* To determine the device's availability, result of this template will be compared to `payload_available` and `payload_not_available`.
*/
availability_template?: string;
/**
* The MQTT topic subscribed to receive availability (online/offline) updates.
* Must not be used together with `availability`.
*/
availability_topic?: string;
/**
* Information about the device this switch is a part of to tie it into the [device registry](https://developers.home-assistant.io/docs/en/device_registry_index.html).
* Only works when [`unique_id`](#unique_id) is set.
* At least one of identifiers or connections must be present to identify the device.
*/
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.
*/
configuration_url?: string;
/**
* 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"]]`.
*/
connections?: Array<[string, string]>;
/**
* The hardware version of the device.
*/
hw_version?: string;
/**
* A list of IDs that uniquely identify the device.
* For example a serial number.
*/
identifiers?: string[];
/**
* The manufacturer of the device.
*/
manufacturer?: string;
/**
* The model of the device.
*/
model?: string;
/**
* The model identifier of the device.
*/
model_id?: string;
/**
* The name of the device.
*/
name?: string;
/**
* The serial number of the device.
*/
serial_number?: string;
/**
* Suggest an area if the device isn’t in one yet.
*/
suggested_area?: string;
/**
* The firmware version of the device.
*/
sw_version?: string;
/**
* 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.
*/
via_device?: string;
};
}

72
futurehome/src/ha/mqtt_components/tag.ts
View File

@ -29,76 +29,4 @@ export interface TagComponent {
* Defines a [template](https://www.home-assistant.io/docs/configuration/templating/#using-value-templates-with-mqtt) that returns a tag ID.
*/
value_template?: string;
/**
* Information about the device this device trigger is a part of to tie it into the [device registry](https://developers.home-assistant.io/docs/en/device_registry_index.html).
* At least one of identifiers or connections must be present to identify the device.
*/
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.
*/
configuration_url?: string;
/**
* 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"]]`.
*/
connections?: Array<[string, string]>;
/**
* The hardware version of the device.
*/
hw_version?: string;
/**
* A list of IDs that uniquely identify the device.
* For example a serial number.
*/
identifiers?: string[];
/**
* The manufacturer of the device.
*/
manufacturer?: string;
/**
* The model of the device.
*/
model?: string;
/**
* The model identifier of the device.
*/
model_id?: string;
/**
* The name of the device.
*/
name?: string;
/**
* The serial number of the device.
*/
serial_number?: string;
/**
* Suggest an area if the device isn’t in one yet.
*/
suggested_area?: string;
/**
* The firmware version of the device.
*/
sw_version?: string;
/**
* 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.
*/
via_device?: string;
};
}

123
futurehome/src/ha/mqtt_components/text.ts
View File

@ -116,56 +116,6 @@ export interface TextComponent {
*/
json_attributes_topic?: string;
/**
* A list of MQTT topics subscribed to receive availability (online/offline) updates.
* Must not be used together with `availability_topic`.
*/
availability?: Array<{
/**
* An MQTT topic subscribed to receive availability (online/offline) updates.
*/
topic: string;
/**
* The payload that represents the available state.
* Default: "online"
*/
payload_available?: string;
/**
* The payload that represents the unavailable state.
* Default: "offline"
*/
payload_not_available?: string;
/**
* Defines a [template](https://www.home-assistant.io/docs/configuration/templating/#using-value-templates-with-mqtt)
* to extract device's availability from the `topic`.
* To determine the device's availability, result of this template will be compared to `payload_available` and `payload_not_available`.
*/
value_template?: string;
}>;
/**
* When `availability` is configured, this controls the conditions needed to set the entity to `available`.
* Valid values: "all", "any", "latest"
* Default: "latest"
*/
availability_mode?: 'all' | 'any' | 'latest';
/**
* Defines a [template](https://www.home-assistant.io/docs/configuration/templating/#using-value-templates-with-mqtt)
* to extract device's availability from the `availability_topic`.
* To determine the device's availability, result of this template will be compared to `payload_available` and `payload_not_available`.
*/
availability_template?: string;
/**
* The MQTT topic subscribed to receive availability (online/offline) updates.
* Must not be used together with `availability`.
*/
availability_topic?: string;
/**
* The string that represents the `online` state.
* Default: "online"
@ -189,77 +139,4 @@ export interface TextComponent {
* Default: false
*/
retain?: boolean;
/**
* Information about the device this of text capability is a part of to tie it into the [device registry](https://developers.home-assistant.io/docs/en/device_registry_index.html).
* Only works when [`unique_id`](#unique_id) is set.
* At least one of identifiers or connections must be present to identify the device.
*/
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.
*/
configuration_url?: string;
/**
* 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"]]`.
*/
connections?: Array<[string, string]>;
/**
* The hardware version of the device.
*/
hw_version?: string;
/**
* A list of IDs that uniquely identify the device.
* For example a serial number.
*/
identifiers?: string[];
/**
* The manufacturer of the device.
*/
manufacturer?: string;
/**
* The model of the device.
*/
model?: string;
/**
* The model identifier of the device.
*/
model_id?: string;
/**
* The name of the device.
*/
name?: string;
/**
* The serial number of the device.
*/
serial_number?: string;
/**
* Suggest an area if the device isn’t in one yet.
*/
suggested_area?: string;
/**
* The firmware version of the device.
*/
sw_version?: string;
/**
* 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.
*/
via_device?: string;
};
}

118
futurehome/src/ha/mqtt_components/update.ts
View File

@ -145,55 +145,6 @@ export interface UpdateComponent {
*/
qos?: number;
/**
* A list of MQTT topics subscribed to receive availability (online/offline) updates.
* Must not be used together with `availability_topic`.
*/
availability?: Array<{
/**
* An MQTT topic subscribed to receive availability (online/offline) updates.
*/
topic: string;
/**
* The payload that represents the available state.
* Default: "online"
*/
payload_available?: string;
/**
* The payload that represents the unavailable state.
* Default: "offline"
*/
payload_not_available?: string;
/**
* Defines a [template](https://www.home-assistant.io/docs/configuration/templating/#using-value-templates-with-mqtt)
* to extract device's availability from the `topic`. Result compared to `payload_available` and `payload_not_available`.
*/
value_template?: string;
}>;
/**
* When `availability` is configured, controls the conditions needed to set the entity to `available`.
* Valid values: "all", "any", "latest"
* Default: "latest"
*/
availability_mode?: 'all' | 'any' | 'latest';
/**
* Defines a [template](https://www.home-assistant.io/docs/configuration/templating/#using-value-templates-with-mqtt)
* to extract device's availability from the `availability_topic`.
* Result compared to `payload_available` and `payload_not_available`.
*/
availability_template?: string;
/**
* The MQTT topic subscribed to receive availability (online/offline) updates.
* Must not be used together with `availability`.
*/
availability_topic?: string;
/**
* The string that represents the `online` state.
* Default: "online"
@ -205,73 +156,4 @@ export interface UpdateComponent {
* Default: "offline"
*/
payload_not_available?: string;
/**
* Information about the device this Update is a part of to tie it into the [device registry](https://developers.home-assistant.io/docs/en/device_registry_index.html).
* Only works when `unique_id` is set. At least one of identifiers or connections must be present.
*/
device?: {
/**
* A link to the webpage that can manage the configuration of this device.
* Can be `http://`, `https://` or an internal `homeassistant://` URL.
*/
configuration_url?: string;
/**
* A list of connections of the device to the outside world as a list of tuples `[connection_type, connection_identifier]`.
* Example: `[["mac", "02:5b:26:a8:dc:12"]]`.
*/
connections?: Array<[string, string]>;
/**
* The hardware version of the device.
*/
hw_version?: string;
/**
* A list of IDs that uniquely identify the device. For example a serial number.
*/
identifiers?: string[] | string;
/**
* The manufacturer of the device.
*/
manufacturer?: string;
/**
* The model of the device.
*/
model?: string;
/**
* The model identifier of the device.
*/
model_id?: string;
/**
* The name of the device.
*/
name?: string;
/**
* The serial number of the device.
*/
serial_number?: string;
/**
* Suggest an area if the device isn’t in one yet.
*/
suggested_area?: string;
/**
* The firmware version of the device.
*/
sw_version?: string;
/**
* Identifier of a device that routes messages between this device and Home Assistant.
* Examples: hubs, or parent devices of a sub-device.
*/
via_device?: string;
};
}

125
futurehome/src/ha/mqtt_components/vacuum.ts
View File

@ -20,137 +20,12 @@ export interface VacuumComponent {
* Required when used with device-based discovery.
*/
unique_id?: string;
/**
* The MQTT topic subscribed to receive availability (online/offline) updates.
* Must not be used together with `availability_topic`.
*/
availability?: Array<{
/**
* An MQTT topic subscribed to receive availability (online/offline) updates.
*/
topic: string;
/**
* The payload that represents the available state.
* Default: "online"
*/
payload_available?: string;
/**
* The payload that represents the unavailable state.
* Default: "offline"
*/
payload_not_available?: string;
/**
* Defines a [template](https://www.home-assistant.io/docs/configuration/templating/#using-value-templates-with-mqtt)
* to extract device's availability from the `topic`.
* To determine the device's availability, result of this template will be compared to `payload_available` and `payload_not_available`.
*/
value_template?: string;
}>;
/**
* When `availability` is configured, this controls the conditions needed to set the entity to `available`.
* Valid values: "all", "any", "latest".
* Default: "latest"
*
* See also:
* https://www.home-assistant.io/integrations/mqtt/#device-discovery-payload
*/
availability_mode?: 'all' | 'any' | 'latest';
/**
* Defines a [template](https://www.home-assistant.io/docs/configuration/templating/#using-value-templates-with-mqtt)
* to extract device's availability from the `availability_topic`.
* To determine the device's availability, result of this template will be compared to `payload_available` and `payload_not_available`.
*/
availability_template?: string;
/**
* The MQTT topic subscribed to receive availability (online/offline) updates.
* Must not be used together with `availability`.
*/
availability_topic?: string;
/**
* The MQTT topic to publish commands to control the vacuum.
*/
command_topic?: string;
/**
* Information about the device this vacuum is a part of to tie it into the [device registry](https://developers.home-assistant.io/docs/core/device_registry_index/).
* Only works when [`unique_id`](#unique_id) is set.
* At least one of identifiers or connections must be present to identify the device.
*/
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.
*/
configuration_url?: string;
/**
* 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"]]`.
*/
connections?: Array<[string, string]>;
/**
* The hardware version of the device.
*/
hw_version?: string;
/**
* A list of IDs that uniquely identify the device.
* For example a serial number.
*/
identifiers?: string[];
/**
* The manufacturer of the device.
*/
manufacturer?: string;
/**
* The model of the device.
*/
model?: string;
/**
* The model identifier of the device.
*/
model_id?: string;
/**
* The name of the device.
*/
name?: string;
/**
* The serial number of the device.
*/
serial_number?: string;
/**
* Suggest an area if the device isn’t in one yet.
*/
suggested_area?: string;
/**
* The firmware version of the device.
*/
sw_version?: string;
/**
* 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.
*/
via_device?: string;
};
/**
* The encoding of the payloads received and published messages.
* Set to `""` to disable decoding of incoming payload.

125
futurehome/src/ha/mqtt_components/valve.ts
View File

@ -145,58 +145,6 @@ export interface ValveComponent {
*/
json_attributes_template?: string;
/**
* A list of MQTT topics subscribed to receive availability (online/offline) updates.
* Must not be used together with `availability_topic`.
*/
availability?: Array<{
/**
* An MQTT topic subscribed to receive availability (online/offline) updates.
*/
topic: string;
/**
* The payload that represents the available state.
* Default: "online"
*/
payload_available?: string;
/**
* The payload that represents the unavailable state.
* Default: "offline"
*/
payload_not_available?: string;
/**
* Defines a [template](https://www.home-assistant.io/docs/configuration/templating/#using-value-templates-with-mqtt)
* to extract the device's availability from the `topic`.
* To determine the device's availability, result of this template will be compared to `payload_available` and `payload_not_available`.
*/
value_template?: string;
}>;
/**
* When `availability` is configured, this controls the conditions needed to set the entity to `available`.
* Valid values: "all", "any", "latest"
* Default: "latest"
*/
availability_mode?: 'all' | 'any' | 'latest';
/**
* Defines a [template](https://www.home-assistant.io/docs/configuration/templating/#using-value-templates-with-mqtt)
* to extract device's availability from the `availability_topic`.
* To determine the device's availability, result of this template will be compared to `payload_available` and `payload_not_available`.
*/
availability_template?: string;
/**
* The MQTT topic subscribed to receive birth and LWT messages from the MQTT valve device.
* If an `availability` topic is not defined, the valve availability state will always be `available`.
* If an `availability` topic is defined, the valve availability state will be `unavailable` by default.
* Must not be used together with `availability`.
*/
availability_topic?: string;
/**
* The payload that represents the online state.
* Default: "online"
@ -267,77 +215,4 @@ export interface ValveComponent {
* The `device_class` can be `null`.
*/
device_class?: string | null;
/**
* Information about the device this valve is a part of to tie it into the [device registry](https://developers.home-assistant.io/docs/en/device_registry_index.html).
* Only works when [`unique_id`](#unique_id) is set.
* At least one of identifiers or connections must be present to identify the device.
*/
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.
*/
configuration_url?: string;
/**
* 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"]]`.
*/
connections?: Array<[string, string]>;
/**
* The hardware version of the device.
*/
hw_version?: string;
/**
* A list of IDs that uniquely identify the device.
* For example a serial number.
*/
identifiers?: string[];
/**
* The manufacturer of the device.
*/
manufacturer?: string;
/**
* The model of the device.
*/
model?: string;
/**
* The model identifier of the device.
*/
model_id?: string;
/**
* The name of the device.
*/
name?: string;
/**
* The serial number of the device.
*/
serial_number?: string;
/**
* Suggest an area if the device isn’t in one yet.
*/
suggested_area?: string;
/**
* The firmware version of the device.
*/
sw_version?: string;
/**
* 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.
*/
via_device?: string;
};
}

122
futurehome/src/ha/mqtt_components/water_heater.ts
View File

@ -60,128 +60,6 @@ export interface WaterHeaterComponent {
*/
icon?: string;
/**
* Information about the device this water heater device is a part of to tie it into the [device registry](https://developers.home-assistant.io/docs/en/device_registry_index.html).
* Only works through [MQTT discovery](https://www.home-assistant.io/integrations/mqtt/#mqtt-discovery) and when [`unique_id`](#unique_id) is set.
* At least one of identifiers or connections must be present to identify the device.
*/
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.
*/
configuration_url?: string;
/**
* 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"]]`.
*/
connections?: Array<[string, string]>;
/**
* The hardware version of the device.
*/
hw_version?: string;
/**
* A list of IDs that uniquely identify the device. For example a serial number.
*/
identifiers?: string[];
/**
* The manufacturer of the device.
*/
manufacturer?: string;
/**
* The model of the device.
*/
model?: string;
/**
* The model identifier of the device.
*/
model_id?: string;
/**
* The name of the device.
*/
name?: string;
/**
* The serial number of the device.
*/
serial_number?: string;
/**
* Suggest an area if the device isn’t in one yet.
*/
suggested_area?: string;
/**
* The firmware version of the device.
*/
sw_version?: string;
/**
* 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.
*/
via_device?: string;
};
/**
* A list of MQTT topics subscribed to receive availability (online/offline) updates.
* Must not be used together with `availability_topic`.
*/
availability?: Array<{
/**
* An MQTT topic subscribed to receive availability (online/offline) updates.
*/
topic: string;
/**
* The payload that represents the available state.
* Default: "online"
*/
payload_available?: string;
/**
* The payload that represents the unavailable state.
* Default: "offline"
*/
payload_not_available?: string;
/**
* Defines a [template](https://www.home-assistant.io/docs/configuration/templating/#using-value-templates-with-mqtt)
* to extract device's availability from the `topic`.
* To determine the device's availability, result of this template is compared to `payload_available` and `payload_not_available`.
*/
value_template?: string;
}>;
/**
* When `availability` is configured, this controls the conditions needed to set the entity to `available`.
* Valid values: "all", "any", "latest"
* Default: "latest"
*/
availability_mode?: 'all' | 'any' | 'latest';
/**
* Defines a [template](https://www.home-assistant.io/docs/configuration/templating/#using-value-templates-with-mqtt)
* to extract device's availability from the `availability_topic`.
* To determine the device's availability, result of this template is compared to `payload_available` and `payload_not_available`.
*/
availability_template?: string;
/**
* The MQTT topic subscribed to receive availability (online/offline) updates.
* Must not be used together with `availability`.
*/
availability_topic?: string;
/**
* The payload that represents the available state.
* Default: "online"