jeans/home-assistant.io
jeans/home-assistant.io
1
0
Fork 0
mirror of https://github.com/home-assistant/home-assistant.io.git synced 2025-07-21 08:16:53 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update rss_feed_template component configuration (#7415)

Browse Source
This commit is contained in:
Klaas Schoute 2018-11-08 09:30:31 +01:00 committed by Fabian Affolter
parent eb19c4a934
commit fb4d4c8716
1 changed files with 28 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

36
source/_components/rss_feed_template.markdown
View File

@ -30,11 +30,31 @@ rss_feed_template:
description: "{% raw %}{% if is_state('sensor.temp_outside','unknown') %}---{% else %}{{states.sensor.temp_outside.state}} °C{% endif %}{% endraw %}"
```
Configuration variables:
- **requires_api_password:** (*Optional*): If true and an API password is set, the password must be passed via '?api_password=...' parameter (Default: True)
- **feed_id** (*Required*): The key is used as the ID of the feed. The feed can be accessed at /api/rss_template/feed_id (example: 'garden')
- **title** (*Optional*): The title of the feed, which is parsed as [template](/topics/templating/).
- **items** (*Required*): A list of feed items.
- **items/title** (*Optional*): The title of the item, which is parsed as [template](/topics/templating/).
- **items/description** (*Optional*): The description of the item, which is parsed as [template](/topics/templating/).
{% configuration %}
requires_api_password:
description: If true and an API password is set, the password must be passed via '?api_password=...' parameter.
required: false
default: true
type: boolean
feed_id:
description: "The key is used as the ID of the feed. The feed can be accessed at /api/rss_template/feed_id (example: 'garden')."
required: true
type: string
title:
description: The title of the feed, which is parsed as [template](/topics/templating/).
required: false
type: template
items:
description: A list of feed items.
required: true
type: list
keys:
title:
description: The title of the item, which is parsed as [template](/topics/templating/).
required: false
type: template
description:
description: The description of the item, which is parsed as [template](/topics/templating/).
required: false
type: template
{% endconfiguration %}