home-assistant.io/source/_components/rss_feed_template.markdown
2017-05-06 19:31:47 -07:00

1.7 KiB

layout, title, description, date, sidebar, comments, sharing, footer, ha_category, ha_release
layout title description date sidebar comments sharing footer ha_category ha_release
page RSS feed template Instructions how to setup an RSS feed for sensor information and other. 2017-04-11 20:42 true false true true Front end 0.44

The rss_feed_template component can export any information from Home Assistant as static RSS feed. This can be used to display those information on several devices using RSS readers. While native apps for Home Assistant are not widely available, native RSS readers exists for almost any platform.

E.g. on android, the app "Simple RSS Widget" can be used to display temperatures on the home screen.

# Example configuration.yml entry
rss_feed_template:
  garden:
    requires_api_password: False
    title: "Garden {% raw %}{{ as_timestamp(now())|timestamp_custom('%H:%m', True) }}{% endraw %}"
    items:
    - title: "Outside temperature"
      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 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.
  • items (Required): A list of feed items
  • items/title (Optional): The title of the item, which is parsed as template.
  • items/description (Optional): The description of the item, which is parsed as template.