mirror of
https://github.com/MickMake/GoSungrow.git
synced 2025-03-24 00:21:44 +01:00
127 lines
6.2 KiB
Plaintext
127 lines
6.2 KiB
Plaintext
|
availability list (optional)
|
|||
|
|
A list of MQTT topics subscribed to receive availability (online/offline) updates. Must not be used together with availability_topic.
|
|||
|
|
|
|||
|
|
payload_available string (optional, default: online)
|
|||
|
|
The payload that represents the available state.
|
|||
|
|
|
|||
|
|
payload_not_available string (optional, default: offline)
|
|||
|
|
The payload that represents the unavailable state.
|
|||
|
|
|
|||
|
|
topic string REQUIRED
|
|||
|
|
An MQTT topic subscribed to receive availability (online/offline) updates.
|
|||
|
|
|
|||
|
|
value_template template (optional)
|
|||
|
|
Defines a template to extract device’s availability from the topic. To determine the devices’s availability result of this template will be compared to payload_available and payload_not_available.
|
|||
|
|
|
|||
|
|
availability_mode string (optional, default: latest)
|
|||
|
|
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.
|
|||
|
|
|
|||
|
|
availability_template template (optional)
|
|||
|
|
Defines a template to extract device’s availability from the availability_topic. To determine the devices’s availability result of this template will be compared to payload_available and payload_not_available.
|
|||
|
|
|
|||
|
|
availability_topic string (optional)
|
|||
|
|
The MQTT topic subscribed to receive availability (online/offline) updates. Must not be used together with availability.
|
|||
|
|
|
|||
|
|
command_topic string (optional)
|
|||
|
|
The MQTT topic to publish commands to change the switch state.
|
|||
|
|
|
|||
|
|
device map (optional)
|
|||
|
|
Information about the device this switch is a part of to tie it into the device registry. Only works through MQTT discovery and when unique_id is set. At least one of identifiers or connections must be present to identify the device.
|
|||
|
|
|
|||
|
|
configuration_url string (optional)
|
|||
|
|
A link to the webpage that can manage the configuration of this device. Can be either an HTTP or HTTPS link.
|
|||
|
|
|
|||
|
|
connections list (optional)
|
|||
|
|
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"]].
|
|||
|
|
|
|||
|
|
hw_version string (optional)
|
|||
|
|
The hardware version of the device.
|
|||
|
|
|
|||
|
|
identifiers string | list (optional)
|
|||
|
|
A list of IDs that uniquely identify the device. For example a serial number.
|
|||
|
|
|
|||
|
|
manufacturer string (optional)
|
|||
|
|
The manufacturer of the device.
|
|||
|
|
|
|||
|
|
model string (optional)
|
|||
|
|
The model of the device.
|
|||
|
|
|
|||
|
|
name string (optional)
|
|||
|
|
The name of the device.
|
|||
|
|
|
|||
|
|
suggested_area string (optional)
|
|||
|
|
Suggest an area if the device isn’t in one yet.
|
|||
|
|
|
|||
|
|
sw_version string (optional)
|
|||
|
|
The firmware version of the device.
|
|||
|
|
|
|||
|
|
via_device string (optional)
|
|||
|
|
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.
|
|||
|
|
|
|||
|
|
device_class device_class (optional, default: None)
|
|||
|
|
The type/class of the switch to set the icon in the frontend.
|
|||
|
|
|
|||
|
|
enabled_by_default boolean (optional, default: true)
|
|||
|
|
Flag which defines if the entity should be enabled when first added.
|
|||
|
|
|
|||
|
|
encoding string (optional, default: utf-8)
|
|||
|
|
The encoding of the payloads received and published messages. Set to "" to disable decoding of incoming payload.
|
|||
|
|
|
|||
|
|
entity_category string (optional, default: None)
|
|||
|
|
The category of the entity.
|
|||
|
|
|
|||
|
|
icon icon (optional)
|
|||
|
|
Icon for the entity.
|
|||
|
|
|
|||
|
|
json_attributes_template template (optional)
|
|||
|
|
Defines a template to extract the JSON dictionary from messages received on the json_attributes_topic. Usage example can be found in MQTT sensor documentation.
|
|||
|
|
|
|||
|
|
json_attributes_topic string (optional)
|
|||
|
|
The MQTT topic subscribed to receive a JSON dictionary payload and then set as sensor attributes. Usage example can be found in MQTT sensor documentation.
|
|||
|
|
|
|||
|
|
name string (optional, default: MQTT Switch)
|
|||
|
|
The name to use when displaying this switch.
|
|||
|
|
|
|||
|
|
object_id string (optional)
|
|||
|
|
Used instead of name for automatic generation of entity_id
|
|||
|
|
|
|||
|
|
optimistic boolean (optional)
|
|||
|
|
Flag that defines if switch works in optimistic mode.
|
|||
|
|
|
|||
|
|
Default: true if no state_topic defined, else false.
|
|||
|
|
payload_available string (optional, default: online)
|
|||
|
|
The payload that represents the available state.
|
|||
|
|
|
|||
|
|
payload_not_available string (optional, default: offline)
|
|||
|
|
The payload that represents the unavailable state.
|
|||
|
|
|
|||
|
|
payload_off string (optional, default: OFF)
|
|||
|
|
The payload that represents off state. If specified, will be used for both comparing to the value in the state_topic (see value_template and state_off for details) and sending as off command to the command_topic.
|
|||
|
|
|
|||
|
|
payload_on string (optional, default: ON)
|
|||
|
|
The payload that represents on state. If specified, will be used for both comparing to the value in the state_topic (see value_template and state_on for details) and sending as on command to the command_topic.
|
|||
|
|
|
|||
|
|
qos integer (optional, default: 0)
|
|||
|
|
The maximum QoS level of the state topic. Default is 0 and will also be used to publishing messages.
|
|||
|
|
|
|||
|
|
retain boolean (optional, default: false)
|
|||
|
|
If the published message should have the retain flag on or not.
|
|||
|
|
|
|||
|
|
state_off string (optional)
|
|||
|
|
The payload that represents the off state. Used when value that represents off state in the state_topic is different from value that should be sent to the command_topic to turn the device off.
|
|||
|
|
|
|||
|
|
Default: payload_off if defined, else OFF
|
|||
|
|
state_on string (optional)
|
|||
|
|
The payload that represents the on state. Used when value that represents on state in the state_topic is different from value that should be sent to the command_topic to turn the device on.
|
|||
|
|
|
|||
|
|
Default: payload_on if defined, else ON
|
|||
|
|
state_topic string (optional)
|
|||
|
|
The MQTT topic subscribed to receive state updates.
|
|||
|
|
|
|||
|
|
unique_id string (optional)
|
|||
|
|
An ID that uniquely identifies this switch device. If two switches have the same unique ID, Home Assistant will raise an exception.
|
|||
|
|
|
|||
|
|
value_template string (optional)
|
|||
|
|
Defines a template to extract device’s state from the state_topic. To determine the switches’s state result of this template will be compared to state_on and state_off.
|
|||
|
|
|