iobroker.rssfeed
Advanced tools
Tests: 
Adapter to request and show RSS Feeds of different standards (Atom, RSS, RDF). You can customize the output of the feed with a template system. In the templates you can include HTML, CSS and Javascript.
Important: Only the english translation is valid due to bugs in automatic translations into other languages made by iobroker
After Installation the adapter should then be displayed in the adapter section in the iobroker. Sometimes it happens that the changes are not visible, especially with web changes (widgets / configuration dialog), the following command may have to be executed on the command line:
iobroker upload rssfeed
In the right area in the line of the adapter, an instance can be added using the plus button
The configuration is easy. There are only a few fields
| Setting | description |
|---|---|
| Default Refresh (min) | is the general specification of how often the feed should be called up again in minutes. The default is 60 minutes |
| Max Artikel (Standard) | The total amount of data to be processed can be limited here. |
Then for each new feed:
| Setting | description |
|---|---|
| Name | A name for the datapoint. Inside a folder a name must not appear twice. |
| Category | Name for a subfolder there the datapoint should appear. The category must be unique |
| Url | The full address of the feed (with http: // or https: //, see examples below) |
| Refresh (min) | A different value can be specified for this feed. Otherwise the general specification is taken |
| Max Articles | A different value can be specified for this feed. Otherwise the general specification is taken |
If you saved and closed the configuration, the feed-data can be found as a JSON data point in the object tree. If you delete an entry, the datapoints aren't deleted.
The following widgets actually exists
RSS Feed widget 2 - to show a single feedRSS Feed Multi widget 3 - to show several aggregated feeds in one widget.RSS Feed Meta Helper - a helper widget to inspect the metadata of a feedRSS Feed Article Helper 2 - a helper widget to inspect the article data of a feedRSS Feed Title marquee 3 - a widget to show the Headlines of a feed as a marqueeJSON Template - a widget that have nothing todo with RSS Feeds, but uses the same technology, and you can define a custom template to show any JSON-Data in vis.This widget can be used to display the RSS feeds subscribed to in the adapter's configuration dialog. A template system was chosen to ensure the best possible display. Descriptions of the formatting and syntax can be found on the following pages.
Selecting the data point with the corresponding RSS feed.
The template determines the appearance of the RSS feed. All valid HTML tags (including CSS attributes in style tags) can be used in the template. In addition, there are special tags within which the feed data is displayed and JavaScript instructions can be executed. In order to better identify the data and the attribute names used, there are two widgets, rssfeed Meta helper and rssfeed Article helper.
Availability of variable:
For more details about these variables, see chapter Available variables
For details on the template system, see chapter Template based on examples
The maximum number of individual articles displayed from the RSS feed
For the filter function, one or more filter criteria can be entered in the field, separated by semicolons (;). The following article attributes are searched for the search: title, description, categories. Only articles that contain one of these terms are displayed.
With this widget, several feeds can be aggregated in one feed. Due to the multiple feeds, there are a few differences in the data availability in the template compared to the normal RSS feed widget. The meta variable is not available in the template. However, 3 meta attributes title and description are available in each individual article under the names meta_title and meta_description. In addition, a general name can be assigned to each feed in the settings, which is available within the template under the name meta_name in each article so that the origin of an article can be identified. Otherwise, the same rules apply to the template as for the RSS feed widget.
Here you can set the number of feeds to be configured. A separate group for configuration is created in vis for each feed.
The template determines the appearance of the RSS feed. All valid HTML tags (including CSS attributes in style tags) can be used in the template. In addition, there are special tags within which the feed data is displayed and JavaScript instructions can be executed. In order to better identify the data and the attribute names used, there are two widgets, rssfeed Meta helper and rssfeed Article helper.
For details on the template system, see chapter Template based on examples
Availability of variable:
rss.articles: an array of all articles.
A subset of the the meta information of an item is available in the article as meta_name, meta_title and meta_description
dp[] as array, if you configure additional datapoints
widgetid: the widgetID of the widget
style: the style object if you configure additional style information
For more details on these variables, see chapter Available variables
Here you can specify the number of additional data points that should be made available within the template.
Here you can select the respective data point. The data point is available within the template under the variable dp. This means that a data point can be retrieved within the template as follows
For details on these variables, see chapter Available variables
Selection of the data point with the corresponding RSS feed.
Here you can enter a name that will be made available in the template for each article under the attribute name meta_name.
The maximum number of individual articles displayed from the RSS feed
For the filter function, one or more filter criteria can be entered in the field, separated by semicolons (;). The following article attributes are searched for the search: title, description, categories. Only articles that contain one of these terms are displayed.
This widget can be used to display the meta attributes of a specific feed. It is simply used as an help widget for creating a template to quickly and easily display the contents of the RSS feed data. Attributes
Selection of the data point with the corresponding RSS feed.
This widget can be used to display the article attributes of a specific feed. It is simply used as an help widget for creating a template to quickly and easily display the contents of the RSS feed data.
Selection of the data point with the corresponding RSS feed.
To make it easier to use the attribute names via copy/paste, the variable name used in the template for an article can be specified here.
This attribute can be used to switch between the various existing articles in the RSS feed.
With this widget, all title attributes will be displayed as a scrolling text. As part of the change from marquee widget 2 to 3, this widget is now a multi widget in which you can aggregate more than one RSS feed.
Here you can set the number of feeds to be configured. A separate group is created in vis for each feed to be configured.
The scrolling speed of the scrolling text Attribute rss_divider - General group Here you can enter the characters used to separate the headlines. The default value is +++.
If this option is switched on, the scrolling text stops as soon as you hover the mouse over the text.
If this option is switched on, the headlines are displayed as a link. If you click or touch a headline, the link to the article opens in a new window or tab.
If this option is switched on, the time is displayed before the respective headline. Attribute rss_withdate - General group If this option is enabled, the date without the year and the time are displayed before the respective headline.
If this option is enabled, the date with the year and the time are displayed before the respective headline.
Select the data point with the corresponding RSS feed.
The maximum number of individual articles displayed from the RSS feed
For the filter function, one or more filter criteria can be entered in the field, separated by semicolons (;). The following article attributes are searched for the search: title, description, categories. Only articles that contain one of these terms are displayed.
Using this widget, any data point with JSON data can be displayed as desired. The display is done using a template format, which can be thought of as a combined form of HTML code + JavaScript + special tags that control the display of the JSON attributes.
Selection of the data point with the corresponding JSON data.
The template can be used to determine the appearance of the JSON data. All valid HTML tags (including CSS attributes in style tags) can be used in the template. There are also special tags within which the JSON data is displayed and JavaScript instructions can be executed.
For details on the template system, see chapter Template based on examples
The JSON data is passed to the template with the prefix data. In addition, the current widgetID is also available as a variable so that it can be specified in individual CSS instructions.
Example object
{
"onearray": [
"one",
"two"
],
"oneobject": {
"attribute1": 1,
"attribute2": 2
},
"onenumber": 123,
"onetext": "onetwothree"
}
With the above example, attributes could be output as follows
<%- data.onenumber %>
<%- data.onetext %>
Result
123 onetwothree
Arrays can be accessed via an index. The index always starts with 0. However, there are also fake arrays where the index does not start with 0 or even consists of text. Here the rules for objects apply. In the example above, this would be
<%- data.onearray[0] %>
<%- data.onearray[1] %>
Result
one two
If you try to output an array directly without an index, the template outputs all elements separated by commas
<%- data.onearray %>
Result
one,two
Arrays can also consist of a collection of objects. The example here contains only a simple array. An example of arrays with objects will be given later.
<% for (var i = 0; i < data.onearray.length ; i++ ) { %>
<%- data.onearray[i] %>
<% } %>
Result
one two
Objects can contain individual attributes, arrays or objects again. This means that JSON data can be nested to any depth.
Attributes of an object can be addressed using dot notation or bracket notation. The dot notation only works if the attribute conforms to certain naming conventions (first character must be a letter, rest numbers or letters or underscore). The bracket notation also works for attributes that do not conform to the naming convention.
Dot notation
<%- data.oneobject.attribute1 %>
Bracket notation
<%- data.oneobject["attribute1"] %>
Result for both examples
1
Loop over the attributes of an object
<% for (var prop in data.oneobject) { %>
<%- "data.oneobject." + prop + " = " + data.oneobject[prop] %>
<% } %>
Result
data.oneobject.attribute1 = 1
data.oneobject.attribute2 = 2
Advanced use case
In the examples above, only the pure output was covered. The template can now also be enriched with HTML tags to achieve a specific layout. Here is an example:
<h3>Output</h3>
<style>
.mycssclassproperty {
color:green;
}
.mycssclassdata {
color:red;
}
</style>
<% for (var prop in data.oneobject) { %>
<div>
<span class="mycssclassproperty"><%- "data.oneobject." + prop + " = " %></span>
<span class="mycssclassdata"><%- data.oneobject[prop] %></span>
</div>
<% } %>
Result
data.oneobject.attribute1 = 1
data.oneobject.attribute2 = 2
(In Markdown colors arent visible)
rss.metaThis contains all meta information about the feed. The following content is available. I think the identifiers are self-explanatory. In the help I will describe them in more detail. or specify the content (some are arrays) Only in Rss Feed widget 2, a complete set of the meta information is available
The usage in the template see in Template based on example
meta.titlemeta.descriptionmeta.linkmeta.xmlurlmeta.datemeta.pubdatemeta.authormeta.languagemeta.imagemeta.faviconmeta.copyrightmeta.generatormeta.categoriesrss.articles or articlesIs an array with individual elements (javascript array). Each element has the following properties. So that it fits, for example, I will do the prefix item in front of it. But if you want you can choose that yourself. It only has to be named accordingly in the loop (forEach). Here, too, the identifiers are self-explanatory. Not all attributes are filled in every feed. The most important ones are already included in the template above.
The articles are available as rss.articles in RSS feed widget 2 and as articles in RSS feed multi widget 3
The usage in the template see in Template based on example
item.titleitem.descriptionitem.summaryitem.linkitem.origlinkitem.permalinkitem.dateitem.pubdateitem.authoritem.guiditem.commentsitem.imageitem.categoriesitem.sourceitem.enclosuresThe following template is currently used as standard in the RSS feed widget 2. It has been tested with the following feeds
<!--
available variables:
widgetid -> id of the widget
rss.meta -> all meta informations of an feed, details see Meta Helper widget
rss.articles -> all articles as array, details see Article Helper widget
style -> all style settings for the widget
all variables are read only
-->
<style>
#<%- widgetid %> img {
width: calc(<%- style.width %> - 15px);
height: auto;
}
#<%- widgetid %> img.rssfeed {
width: auto;
height: auto;
}
</style>
<p><%- rss.meta.title %></p>
<% rss.articles.forEach(function(item){ %>
<div class="article">
<p><small><%- vis.formatDate(item.pubdate, "TT.MM.JJJJ SS:mm") %></small></p>
<h3><%- item.title %></h3>
<p><%- item.description %></p>
<div style="clear:both;"></div>
</div>
<% }); %>
The following template is currently used as standard in the RSS feed multi widget 3. Please note little differences in the usage of the variables It has been tested with the following feeds
<!--
available variables:
widgetid -> id of the widget
articles -> all articles as array, details see Article Helper widget
only subset of meta information of the feed is available as
articles[0].meta_name
articles[0].meta_title
articles[0].meta_description
style -> all style settings for the widget
dp[] -> array of addition configured datapoints
all variables are read only
-->
<style>
#<%- widgetid %> img {
width: calc(<%- style.width || "230px" %> - 15px);
height: auto;
}
#<%- widgetid %> img.rssfeed {
width: auto;
height: auto;
}
</style>
<% rss.articles.forEach(function(item){ %>
<p><%- item.meta_name || item.meta_title || '' %></p>
<p><small><%- vis.formatDate(item.pubdate, "TT.MM.JJJJ SS:mm") %></small></p>
<h3><%- item.title %></h3>
<p><%- item.description %></p>
<div style="clear:both;" />
<% }); %>
<!--
available variables:
widgetid -> id of the widget
rss.articles -> all articles as array, details see Article Helper widget
style -> all style settings for the widget
all variables are read only
-->
<style>
#<%- widgetid %> img {
width: calc(<%- style.width || "230px" %> - 15px);
height: auto;
}
#<%- widgetid %> img.rssfeed {
width: auto;
height: auto;
}
.container {
overflow: hidden;
height: 100%;
}
.content {
position: relative;
border: 1px solid #ccc;
overflow: scroll;
height: 90%;
}
.slide {
position: absolute;
display: none;
}
.slide.active {
display: contents;
}
.controls {
margin-top: 10px;
}
</style>
<div class="container">
<div class="content">
<% rss.articles.forEach(function(item){ %>
<div class="article slide">
<p><small><%- vis.formatDate(item.pubdate, "TT.MM.JJJJ SS:mm") %></small></p>
<h3><%- item.title %></h3>
<p><%- item.description %></p>
<div style="clear:both;"></div>
</div>
<% }); %>
</div>
<div class="controls">
<button onclick="prevSlide()">Zurück</button>
<button onclick="nextSlide()">Weiter</button>
</div>
</div>
<script>
currentSlide = 0;
slides = document.querySelectorAll('.slide');
function showSlide(index) {
slides.forEach((slide, i) => {
if (i === index) {
slide.classList.add('active');
} else {
slide.classList.remove('active');
}
});
}
function prevSlide() {
currentSlide = (currentSlide > 0) ? currentSlide - 1 : slides.length - 1;
showSlide(currentSlide);
}
function nextSlide() {
currentSlide = (currentSlide < slides.length - 1) ? currentSlide + 1 : 0;
showSlide(currentSlide);
}
showSlide(currentSlide);
</script>
The template system works with certain tags. The tags used mean the following
tag | description |
|---|---|
| <%= | The content of the contained expression / variable will be escaped. |
| <%- | The content of the contained expression / variable is unescaped. |
| <% | No output, is used for enclosed javascript instructions |
| %> | is generally a closing tag to complete one of the previous ones |
Everything that is outside of these tags is displayed exactly as it is or if it is HTML interpreted as HTML. (see e.g. the p-tag, div-tag, small-tag Within the template you have 2 predefined variables available
<%= meta.title %> <% articles.forEach(function(item){ %>
<p><small><%- vis.formatDate(item.pubdate, "TT.MM.JJJJ SS:mm") %></small></p>
<h3><%- item.title %></h3>
<p><%- item.description %></p>
<div style="clear:both;" />
<% }); %>
Brief description of what happens in the individual lines
Z1: The output of the feed title
Z2: Without output. Javascript command to loop over all articles, with each turn the current element is assigned to the variable item.
Z3: Output of date and time is. It is enclosed with a p / small tag for formatting. The vis-own date format function is used for formatting. Description can be found in the adapter vis.
Z4: The output of the article title. A Header 3 - tag is used for formatting.
Z5: Output of the content of the article. It is enclosed with a p-tag. Here, at least in the two examples, HTML code is included, which usually comes with an image and descriptive text
Z6: Output a div tag that clears special formatting in the feed-html (in both examples for tagesschau and bild it is needed. Other feed maybe didn't need it.
Z7: Without output. This line closed the javascript loop . Everything that was defined between Z2 and Z7 is repeated for every single article.
MIT License
Copyright (c) 2021-2024 oweitman oweitman@gmx.de
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
FAQs
Adapter and vis widget for rss feeds
We found that iobroker.rssfeed demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 0 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Research
An advanced npm supply chain attack is leveraging Ethereum smart contracts for decentralized, persistent malware control, evading traditional defenses.
Security News
Research
Attackers are impersonating Sindre Sorhus on npm with a fake 'chalk-node' package containing a malicious backdoor to compromise developers' projects.
Security News
The npm package for the LottieFiles Player web component was hit with a supply chain attack after a software engineer's npmjs credentials were compromised.