Difference between revisions of "Epgsearch-plugin"

From VDR Wiki
Jump to: navigation, search
m
(Description)
 
(31 intermediate revisions by 12 users not shown)
Line 1: Line 1:
 
==Description==
 
==Description==
[[Image:Epgsearch-plugin.jpg|thumb|Screenshot]]
 
The '''EPGSearch plugin''' shows reruns of television shows and allows searching the [[EPG]] data. The search setting are stored for later reuse.
 
  
==Hardware requirements==
+
'''Author:''' Christian Wieninger
  
==Software requirements==
+
'''EPG Search''' can be used a replacement [[EPG]] view. It extends the standard EPG view (ie. search for rebroadcasts), a command menu for epg events and a search function for EPG. The search may create automatically timers.
* [[VDR]] >= 1.3.7
+
* [[Vdradmin|VDRAdmin]] (optional)
+
  
==Installation==
+
This 'search timers', search for broadcasts in the background and add a timer if one matches (similar to VDRAdmin's auto-timers) or simply announce it via OSD. Once you have created your searches, any programme(s) matching your criteria (Programme title/description; start/end time; channel etc.), it will be recorded. So you can record every episode of a series automatically.
See [[plugin installation]]
+
 
 +
A timer-conflict-check checks in the background for overlapping timers and if one cannot be record it informs the user via OSD. The conflict can then be resolved with an easy to handle OSD menu.
 +
 
 +
Epgsearch can inform you with an email at timer-updates and/or at timer-conflicts and you can use user defined variables for use in searchtimers and for calling external scripts to influence timer creation.
 +
 
 +
===Status===
 +
 
 +
Last Update 09/2011
 +
 
 +
==Images==
 +
<gallery>
 +
Image:epgsearch-plugin-00.jpg|''Overview - Now''
 +
Image:epgsearch-plugin-01.png|''Overview  - Now''
 +
Image:epgsearch-plugin-02.jpg|''example notification email''
 +
</gallery>
 +
 
 +
==Usage==
 +
There are too much features to describe them all here. You can read the plugins manpages online:
 +
# [http://winni.vdr-developer.org/epgsearch/en/epgsearch.1.html README]
 +
# [http://winni.vdr-developer.org/epgsearch/en/epgsearch.4.html MANUAL]
  
 
==Configuration==
 
==Configuration==
This plugin can be used as standard schedule viewer. therefor the '''/etc/vdr/[[keymacros.conf]]''' file has to altered
+
This plugin can be used as standard schedule viewer. therefore the '''/etc/vdr/[[keymacros.conf]]''' file has to altered
 
  # Remote control key macros for VDR
 
  # Remote control key macros for VDR
 
  #
 
  #
Line 29: Line 44:
 
  Yellow    @prefermenu
 
  Yellow    @prefermenu
  
==Problems==
+
===[[SVDRP]] commands===
 +
{| class="wikitable"
 +
|-
 +
!Parameter
 +
!Description
 +
|-
 +
| LSTS [ID]      || Lists all searches, or the search with the given ID [ID].
 +
The output is the same as the contents of epgsearch.conf.
 +
|-
 +
| NEWS&nbsp;<settings> || Adds a new search. <settings> is formatted as epgsearch.conf. Hint: ID needs to be given, but is ignored and a new ID is generated.
 +
|-
 +
| DELS <ID>      || Deletes search with given ID <ID>.
 +
|-
 +
| EDIS <settings> || modifies a a search.
 +
|-
 +
| UPDS [OSD]      || Trigger update of search timers. If OSD is given, a message appears on OSD as soon as update is finished.
 +
|-
 +
| UPDD            || re-read epgsearchdone.data after file change with external tool.
 +
|-
 +
| SETS <nowiki><ON|OFF></nowiki>  || de-/activate thread for search timers.
 +
|-
 +
| FIND <settings> || find EPG events matching to &lt;settings&gt;
 +
|}
  
==Links==
+
There are more [[SVDRP]] commands. For a complete list, read the [http://winni.vdr-developer.org/epgsearch/en/epgsearch.4.html#9__svdrp_interface MANUAL].
{|
+
 
| [1]
+
==Installation==
| http://www.cwieninger.de.vu/html/vdr-epg-search.html
+
===Makefile options===
| Plugin homepage
+
{| class="wikitable"
 +
|-
 +
| bgcolor=#efefef | #WITHOUT_EPGSEARCHONLY = 1
 +
| uncomment if mini plugin epgsearchonly should not be build.  
 +
epgsearchonly generates a main menue entry "Search" and is a shortcut for search timers.  
 +
|-
 +
| bgcolor=#efefef | #WITHOUT_CONFLICTCHECKONLY = 1
 +
| uncomment if mini plugin conflictcheckonly should not be build.
 +
conflictcheckonly generates a main menue entry "Timer conflicts" and is a shortcut for "Search timer/Actions/Check timer conflicts".
 +
|-
 +
| bgcolor=#efefef | #WITHOUT_QUICKSEARCH = 1
 +
| uncomment if mini plugin quicksearch should not be build.
 +
quicksearch generates a main menue entry "fast search" and serves as a fast EPG search without need to create a search timer.
 +
|-
 +
| bgcolor=#efefef | #HAVE_PCREPOSIX = 1
 +
| uncomment, if PERL compat regExp (Perl compatible regular expressions, PCRE) should be used.
 +
|-
 +
| bgcolor=#efefef | #HAVE_LIBTRE = 1
 +
| uncomment, if libtre is installed
 
|}
 
|}
 +
 +
==Software Requirements==
 +
* (P)erl-(c)ompatible (r)egular (e)xpression library, PCRE (optional)
 +
* TRE library (optional)
 +
 +
==Version History==
 +
{| width=100% class="wikitable"
 +
|-
 +
! Version
 +
! Date
 +
! Description
 +
! Link
 +
|-
 +
| 1.0.1.beta5
 +
| 29.03.2013
 +
|
 +
| [http://winni.vdr-developer.org/epgsearch/downloads/beta/vdr-epgsearch-1.0.1.beta5.tgz 1.0.1.beta5]
 +
|-
 +
| 1.0.0 (Current Version)
 +
| 11.09.2011
 +
|
 +
| [http://winni.vdr-developer.org/epgsearch/downloads/vdr-epgsearch-1.0.0.tgz 1.0.0]
 +
|}
 +
 +
==Bugs and wish list==
 +
* [http://projects.vdr-developer.org/projects/plg-epgsearch Bug Tracker]
 +
* [http://www.vdr-developer.org/mailman/listinfo/epgsearch Mailing list]
 +
 +
==CurrentVersion==
 +
[http://winni.vdr-developer.org/epgsearch/downloads/vdr-epgsearch-1.0.0.tgz Version 1.0.0]
 +
 +
==Links==
 +
# [http://winni.vdr-developer.org/epgsearch Plugins Homepage]
 +
# [http://www.pcre.org Perl-compatible regular expression library]
 +
# [http://projects.vdr-developer.org/git/?p=vdr-plugin-epgsearch.git GIT-Repository]
  
 
[[Category:Plugins]]
 
[[Category:Plugins]]
 +
[[Category:EPG_and_Co]]
 +
[[Category:Timer- and recordings plugins]]
  
<!-- Link to german wiki page -->
+
{{i18n|epgsearch-plugin}}
[[de:Epgsearch-plugin]]
+

Latest revision as of 17:02, 3 December 2013

Description

Author: Christian Wieninger

EPG Search can be used a replacement EPG view. It extends the standard EPG view (ie. search for rebroadcasts), a command menu for epg events and a search function for EPG. The search may create automatically timers.

This 'search timers', search for broadcasts in the background and add a timer if one matches (similar to VDRAdmin's auto-timers) or simply announce it via OSD. Once you have created your searches, any programme(s) matching your criteria (Programme title/description; start/end time; channel etc.), it will be recorded. So you can record every episode of a series automatically.

A timer-conflict-check checks in the background for overlapping timers and if one cannot be record it informs the user via OSD. The conflict can then be resolved with an easy to handle OSD menu.

Epgsearch can inform you with an email at timer-updates and/or at timer-conflicts and you can use user defined variables for use in searchtimers and for calling external scripts to influence timer creation.

Status

Last Update 09/2011

Images

Usage

There are too much features to describe them all here. You can read the plugins manpages online:

  1. README
  2. MANUAL

Configuration

This plugin can be used as standard schedule viewer. therefore the /etc/vdr/keymacros.conf file has to altered

# Remote control key macros for VDR
#
# Format:
#
# macrokey  key1 key2 key3...
# macrokey  @plugin key1 key2 key3...
#
# See man vdr(5)

Red       @pilot
Green     @epgsearch
^^^^^^^^^^^^^^^^^^^^^
Blue      Timers
Yellow    @prefermenu

SVDRP commands

Parameter Description
LSTS [ID] Lists all searches, or the search with the given ID [ID].

The output is the same as the contents of epgsearch.conf.

NEWS <settings> Adds a new search. <settings> is formatted as epgsearch.conf. Hint: ID needs to be given, but is ignored and a new ID is generated.
DELS <ID> Deletes search with given ID <ID>.
EDIS <settings> modifies a a search.
UPDS [OSD] Trigger update of search timers. If OSD is given, a message appears on OSD as soon as update is finished.
UPDD re-read epgsearchdone.data after file change with external tool.
SETS <ON|OFF> de-/activate thread for search timers.
FIND <settings> find EPG events matching to <settings>

There are more SVDRP commands. For a complete list, read the MANUAL.

Installation

Makefile options

#WITHOUT_EPGSEARCHONLY = 1 uncomment if mini plugin epgsearchonly should not be build.

epgsearchonly generates a main menue entry "Search" and is a shortcut for search timers.

#WITHOUT_CONFLICTCHECKONLY = 1 uncomment if mini plugin conflictcheckonly should not be build.

conflictcheckonly generates a main menue entry "Timer conflicts" and is a shortcut for "Search timer/Actions/Check timer conflicts".

#WITHOUT_QUICKSEARCH = 1 uncomment if mini plugin quicksearch should not be build.

quicksearch generates a main menue entry "fast search" and serves as a fast EPG search without need to create a search timer.

#HAVE_PCREPOSIX = 1 uncomment, if PERL compat regExp (Perl compatible regular expressions, PCRE) should be used.
#HAVE_LIBTRE = 1 uncomment, if libtre is installed

Software Requirements

  • (P)erl-(c)ompatible (r)egular (e)xpression library, PCRE (optional)
  • TRE library (optional)

Version History

Version Date Description Link
1.0.1.beta5 29.03.2013 1.0.1.beta5
1.0.0 (Current Version) 11.09.2011 1.0.0

Bugs and wish list

CurrentVersion

Version 1.0.0

Links

  1. Plugins Homepage
  2. Perl-compatible regular expression library
  3. GIT-Repository