Add selectors to MQTT service definitions (#46738)

This commit is contained in:
Franck Nijhof 2021-02-18 16:37:15 +01:00 committed by GitHub
parent 3f96ebeae5
commit cd6a83f009
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -1,40 +1,76 @@
# Describes the format for available MQTT services # Describes the format for available MQTT services
publish: publish:
description: Publish a message to an MQTT topic. description: Publish a message to an MQTT topic
fields: fields:
topic: topic:
name: Topic
description: Topic to publish payload. description: Topic to publish payload.
required: true
example: /homeassistant/hello example: /homeassistant/hello
selector:
text:
payload: payload:
name: Payload
description: Payload to publish. description: Payload to publish.
example: This is great example: This is great
selector:
text:
payload_template: payload_template:
description: Template to render as payload value. Ignored if payload given. name: Payload Template
description:
Template to render as payload value. Ignored if payload given.
advanced: true
example: "{{ states('sensor.temperature') }}" example: "{{ states('sensor.temperature') }}"
selector:
object:
qos: qos:
name: QoS
description: Quality of Service to use. description: Quality of Service to use.
advanced: true
example: 2 example: 2
values: values:
- 0 - 0
- 1 - 1
- 2 - 2
default: 0 default: 0
selector:
select:
options:
- "0"
- "1"
- "2"
retain: retain:
name: Retain
description: If message should have the retain flag set. description: If message should have the retain flag set.
example: true
default: false default: false
example: true
selector:
boolean:
dump: dump:
description: Dump messages on a topic selector to the 'mqtt_dump.txt' file in your config folder. description:
Dump messages on a topic selector to the 'mqtt_dump.txt' file in your config
folder
fields: fields:
topic: topic:
name: Topic
description: topic to listen to description: topic to listen to
example: "OpenZWave/#" example: "OpenZWave/#"
selector:
text:
duration: duration:
name: Duration
description: how long we should listen for messages in seconds description: how long we should listen for messages in seconds
example: 5 example: 5
default: 5 default: 5
selector:
number:
min: 1
max: 300
step: 1
unit_of_measurement: "seconds"
mode: slider
reload: reload:
description: Reload all MQTT entities from YAML. description: Reload all MQTT entities from YAML