feedparser's Introduction

sensor.feedparser

RSS feed custom component for Home Assistant which can be used in conjunction with the custom Lovelace list-card

Support

Hey dude! Help me out for a couple of 🍻 or a ☕!

To get started put /custom_components/feedparser/ here: <config directory>/custom_components/feedparser/

Example configuration.yaml:

sensor:
  platform: feedparser
  name: Engineering Feed
  feed_url: 'https://www.sciencedaily.com/rss/matter_energy/engineering.xml'
  date_format: '%a, %b %d %I:%M %p'
  remove_image_from_summary: true
  inclusions:
    - title
    - link
    - description
    - image
    - language
    - pubDate
  exclusions:
    - language

Configuration variables:

key	description
platform (Required)	The platform name
name (Required)	Name your feed
feed_url (Required)	The RSS feed URL
date_format (Optional)	strftime date format for date strings Default `%a, %b %d %I:%M %p`
filter (Optional)	`topn/hours/time` select how to filter entries. `topn` returns n number of entries. `hours` returns entries published after number of hours back. `time` allows for templating a date/time to return entries after.
filter_value (Optional)	used with filter to set the value
inclusions (Optional)	List of fields to include from populating the list
exclusions (Optional)	List of fields to exclude from populating the list
remove_image_from_summary (Optional)	`true/false` Remove the image tag from the summary

Note: Will return all fields if no inclusions or exclusions are specified

Due to how custom_components are loaded, it is normal to see a ModuleNotFoundError error on first boot after adding this, to resolve it, restart Home-Assistant.

Recommend Projects