Add config flow to Feedreader (#32947)

This commit is contained in:
Michael 2024-06-21 20:24:02 +02:00 committed by GitHub
parent 29c66e8ecb
commit 6b66251406
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194

View File

@ -6,6 +6,7 @@ ha_category:
ha_release: 0.18
ha_iot_class: Cloud Polling
ha_domain: feedreader
ha_config_flow: true
ha_integration_type: integration
related:
- docs: /docs/configuration/
@ -14,48 +15,9 @@ related:
Add an RSS/Atom feed reader that polls feeds every hour and sends new entries into the event bus.
To use RSS feeds in your installation, add the following to your {% term "`configuration.yaml`" %} file.
{% include integrations/restart_ha_after_config_inclusion.md %}
{% include integrations/config_flow.md %}
```yaml
# Example configuration.yaml entry
feedreader:
urls:
- https://www.home-assistant.io/atom.xml
- https://github.com/blog.atom
- https://hasspodcast.io/feed/podcast
```
{% configuration %}
urls:
description: List of URLs for your feeds.
required: true
type: list
scan_interval:
description: Defines the update interval of the feeds.
required: false
default: 1 hour
type: time
max_entries:
description: The maximum number of entries to extract from each feed.
required: false
default: 20
type: integer
{% endconfiguration %}
The following configuration example shows how to configure update interval and maximum number of entries:
```yaml
# Example configuration.yaml entry with optional parameters
feedreader:
urls:
- https://www.home-assistant.io/atom.xml
- https://github.com/blog.atom
- https://hasspodcast.io/feed/podcast
scan_interval:
minutes: 30
max_entries: 5
```
## Usage
Feedreader events can be used out of the box to trigger automation actions, e.g.: