mirror of
https://github.com/MickMake/GoSungrow.git
synced 2025-03-19 06:11:51 +01:00
91 lines
4.4 KiB
Plaintext
91 lines
4.4 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.
|
||
|
||
device map (optional)
|
||
Information about the device this camera 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 list | string (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.
|
||
|
||
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. Set to "" to disable decoding of incoming payload. Use image_encoding to enable Base64 decoding on topic.
|
||
|
||
entity_category string (optional, default: None)
|
||
The category of the entity.
|
||
|
||
icon icon (optional)
|
||
Icon for the entity.
|
||
|
||
image_encoding string (optional, default: None)
|
||
The encoding of the image payloads received. Set to "b64" to enable base64 decoding of image payload. If not set, the image payload must be raw binary data.
|
||
|
||
json_attributes_template template (optional)
|
||
Defines a template to extract the JSON dictionary from messages received on the json_attributes_topic.
|
||
|
||
json_attributes_topic string (optional)
|
||
The MQTT topic subscribed to receive a JSON dictionary payload and then set as sensor attributes. Implies force_update of the current sensor state when a message is received on this topic.
|
||
|
||
name string (optional)
|
||
The name of the camera.
|
||
|
||
object_id string (optional)
|
||
Used instead of name for automatic generation of entity_id
|
||
|
||
topic string REQUIRED
|
||
The MQTT topic to subscribe to.
|
||
|
||
unique_id string (optional)
|
||
An ID that uniquely identifies this camera. If two cameras have the same unique ID Home Assistant will raise an exception.
|
||
|