forked from home-assistant/home-assistant.io
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
RSS feed template documentation (home-assistant#2411)
* RSS feed template documentation * Small fixes * Change release version * Update rss_feed_template.markdown Added missing `the` * Option 'requires_api_password', default is True
- Loading branch information
Showing
1 changed file
with
37 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,37 @@ | ||
--- | ||
layout: page | ||
title: "RSS feed template" | ||
description: "Instructions how to setup an RSS feed for sensor information and other." | ||
date: 2017-04-11 20:42 | ||
sidebar: true | ||
comments: false | ||
sharing: true | ||
footer: true | ||
ha_category: Front end | ||
ha_release: 0.43 | ||
--- | ||
|
||
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. | ||
|
||
|
||
```yaml | ||
# Example configuration.yml entry | ||
rss_feed_template: | ||
garden: | ||
requires_api_password: False | ||
title: "Garden {{ as_timestamp(now())|timestamp_custom('%H:%m', True) }}" | ||
items: | ||
- title: "Outside temperature" | ||
description: "{% if is_state('sensor.temp_outside','unknown') %}---{% else %}{{states.sensor.temp_outside.state}} °C{% endif %}" | ||
``` | ||
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](/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/). |