Skip to content

dcmartin/feedparser

 
 

Repository files navigation

sensor.feedparser

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

GitHub Release License

Project Maintenance GitHub Activity

Discord Community Forum

Support

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

coffee

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, %d %b %Y %H:%M:%S %Z'
  scan_interval:
    hours: 3
  inclusions:
    - title
    - link
    - description
    - image
    - 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
local_time (Optional) Whether to convert date into local time Default false
show_topn (Optional) fetch how many entres from rss source,if not set then fetch all
inclusions (Optional) List of fields to include from populating the list
exclusions (Optional) List of fields to exclude from populating the list
scan_interval (Optional) Update interval in hours

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.

About

📰 RSS Feed Integration

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Python 98.0%
  • Shell 2.0%