home-assistant.io/source/_integrations/feedreader.markdown
2024-10-15 08:25:34 +02:00

2.5 KiB

title description ha_category ha_release ha_iot_class ha_domain ha_config_flow ha_platforms ha_integration_type related ha_codeowners
Feedreader Instructions on how to integrate RSS feeds into Home Assistant.
Event
Other
0.18 Cloud Polling feedreader true
event
integration
docs title
/docs/configuration/ Configuration file
@mib1185

Add an RSS/Atom feed reader that polls feeds every hour and sends new entries into the event bus.

{% include integrations/config_flow.md %}

Usage

Feedreader events can be used out of the box to trigger automation actions, e.g.:

automation:
  - alias: "Trigger action when new element(s) in RSS feed"
    triggers:
      - trigger: event
        event_type: feedreader
    actions:
      - action: script.turn_on
        target:
          entity_id: script.my_action

{% raw %}

automation:
  - alias: "Send notification of RSS feed title when updated"
    triggers:
      - trigger: event
        event_type: feedreader
        event_data:
          feed_url: "https://hasspodcast.io/feed/podcast"
    actions:
      - action: persistent_notification.create
        data:
          title: "New HA Podcast available"
          message: "New Podcast available - {{ as_timestamp(now()) | timestamp_custom('%I:%M:%S %p %d%b%Y', true) }}"
          notification_id: "{{ trigger.event.data.title }}"

{% endraw %}

Any field under the <entry> tag in the feed can be used for example trigger.event.data.content will get the body of the feed entry.

Event

An event entity will be created for each configured feed which always represents the latest entry of the feed.

Video tutorial

This video tutorial explains how to set up the feedreader and show the latest news feed item on your dashboard in Home Assistant.

For more advanced use cases, a custom integration registering to the feedreader event type could be used instead:

EVENT_FEEDREADER = "feedreader"
hass.bus.listen(EVENT_FEEDREADER, event_listener)

To get started developing custom integrations, please refer to the developers documentation

For a drop in packaged complete example of Feedreader, you can use the PodCast notifier.