Xmltv2vdr-plugin: Difference between revisions

From VDR Wiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 32: Line 32:
===For the developers of the third-party software providing EPG-Data===
===For the developers of the third-party software providing EPG-Data===
The interface between the xmltv2vdr plugin and the third-party software providing the EPG-Data has been defined like this:
The interface between the xmltv2vdr plugin and the third-party software providing the EPG-Data has been defined like this:
* Every source must have a '''control file''' in the '''/var/lib/epgsources''' directory. This control file is a text file that contains information to control the xmltv2vdr plugin and a list of the channels offered by the source. The name of the control file can be chosen freely, but must not have an extension. The control file on the VDR must be readable by the vdr-user.
* Every source must have a '''control file''' in the '''/var/lib/epgsources''' directory. This control file is a text file that contains information to control the xmltv2vdr plugin and a list of the channels offered by the source. The name of the control file can be chosen freely, but must not have an extension. The control file on the VDR must be readable by the vdr-user. (Please, have a look below for examples of valid control files.)
* Every source must have an '''executable file''' that offers the EPG-Data in the appropriate format to the xmltv2vdr plugin. The binary file has to be in the path of the executables of the VDR. The binary file must have the same name as the control file, to which it corresponds. The executable is called with the following parameters: Number of days, Pin, Channelnames (example: 5 ‘‘ ard.de zdf.de)
* Every source must have an '''executable file''' that offers the EPG-Data in the appropriate format to the xmltv2vdr plugin. The binary file has to be in the path of the executables of the VDR. The binary file must have the same name as the control file, to which it corresponds. The executable is called with the following parameters: Number of days, Pin, Channelnames (example: 5 ‘‘ ard.de zdf.de)
* The EPG-Data has to be a valid xmltv format and is passed to the xmltv2vdr plugin by using a pipe or a file. (Please, have a look below for an example of a valid xmltv file.)
*

Revision as of 13:32, 15 May 2012

This page is a loose translation of the page about the xmltv2vdr-plugin available in the german wiki.

Current Version

Version 0.1.1

Description

xmltv2vdr is a plugin for the VDR that imports EPG-Data into the VDR. By itself, it does not fetch any EPG-Data; the EPG-Data has to be supplied by third-party software to xmltv2vdr in xmltv format.

The third-party software to fetch the EPG-Data is not part of xmltv2vdr because of legal issues (cf VG_Media).

Software Requirements

libxml2, libsqlite3, libpcre

VDR >= 1.6.0

Configuration

Assuming that the xmltv2vdr plugin has been installed on the VDR in conjunction to third-party software that uses the xmltv2vdr plugin to get the EPG-Data into the VDR, the configuration about

  • what EPG-Data sources to use
  • what channels of the source correspond to what channels of the VDR
  • other configurations like frequency of updates, etc.

is completely done in the OSD of the VDR.

The OSD of the xmltv2vdr plugin can be accessed under the plugins settings.

Third-party EPG-Data Sources

For the end-user

The configuration and usage of the third-party EPG-Data sources will not be discussed here.

The third-party software to fetch the EPG-Data is not part of xmltv2vdr because of legal issues (cf VG_Media).

For the developers of the third-party software providing EPG-Data

The interface between the xmltv2vdr plugin and the third-party software providing the EPG-Data has been defined like this:

  • Every source must have a control file in the /var/lib/epgsources directory. This control file is a text file that contains information to control the xmltv2vdr plugin and a list of the channels offered by the source. The name of the control file can be chosen freely, but must not have an extension. The control file on the VDR must be readable by the vdr-user. (Please, have a look below for examples of valid control files.)
  • Every source must have an executable file that offers the EPG-Data in the appropriate format to the xmltv2vdr plugin. The binary file has to be in the path of the executables of the VDR. The binary file must have the same name as the control file, to which it corresponds. The executable is called with the following parameters: Number of days, Pin, Channelnames (example: 5 ‘‘ ard.de zdf.de)
  • The EPG-Data has to be a valid xmltv format and is passed to the xmltv2vdr plugin by using a pipe or a file. (Please, have a look below for an example of a valid xmltv file.)