EPG Collector Files

EPG Collector Version 3.0
=========================

1. Introduction
===============

1.1 Overview
============

EPG Collector is a Windows package for collecting DVB EPG data. It can retrieve and process EIT, MHEG5, OpenTV, MediaHighway1 
and 2 and FreeSat format EPG data and produce an XMLTV compliant file. It can be used on all versions of Windows from Win XP
onwards.

It can use terrestrial (DVB-T), satellite (DVB-S) or cable (DVB-C) tuners and has facilities for DiSEqC switching.

There are 2 distinct parts to the Collector package. The first part, EPG Centre, is responsible for maintaining collection 
initialization parameters and the data files that are used to support collection. In addition it has facilities for viewing 
collection logs and the xmltv output file.

The second part, EPG Collector, is the collection program itself. This is a command line program that can be run from
EPG Centre, run manually or run from a scheduled task.

There is also a plugin available that can be used with the DVBLogic TVSource software to enable seamless collection of EPG data 
from within TVSource. This uses exactly the same processes as the normal collection program.

The remainder of this document describes EPG Collector and the DVBLogic plugin. A full description of all the elements can be found 
via the Help menu available within EPG Centre.

1.2 Application Data Directory
==============================

Throughout this document reference is made to the application data directory. This varies depending on the version of Windows 
and whether or not the user running the software has Administrator privileges or not. The various locations are as follows:

	Administrator:
	
	Windows XP:	C:\Documents and Setting\All Users\Application Data\Geekzone\EPG Collector
	Vista/W7:	C:\ProgramData\Geekzone\EPG Collector

	User:
	
	Windows XP:	C:\Documents and Setting\%user%\Local Settings\Application Data\Geekzone\EPG Collector
	Vista/W7:	C:\Users\%user%\AppData\Local\Geekzone\EPG Collector

Note that parts of these paths are normally hidden. EPG Centre will list the location of the directories it uses in the 
log on loading. These are visible using the General log view.

1.3 Acknowledgements
====================

This project was not possible without the help and encouragement of many people. It was initially inspired and supported by 
forum members at Geekzone where the enthusiasm shown got the project started.

There are some individuals who need special mention though having provided outstanding support to the developers.

musicman352000, New Zealand
ideasman69, Australia
Tony B, Australia
Ben Ryder, UK
Ozgur Altun, Turkey
Paul White, UK
Mark Frankland, UK

2. EPG Collector
================

2.1 Running EPG Collector
=========================

The collection process is controlled by an initialization file. The initialization file can be created and subsequently changed 
by using EPG Centre and is specified to the collection process via an optional command line parameter (/ini=filename).

If it is not specified, the default file name of "EPG Collector.ini" will be used and the file must be located in the application
data directory. If the filename contains spaces it must be enclosed in quotes (eg /ini="a file name.ini").   

An initialization parameter (Tuner) specifies which tuners are to be used by the collection process Any combination of tuners 
that are available can be used except for DVBLink virtual tuners. If you select 'Any Tuner' when creating the initialization 
file in a configuration that has multiple tuners the program will use the first one that is available that is appropriate 
for the frequency it is attempting to tune.

Note that the program requires exclusive access to any tuner that it uses.

Each frequency defined in the initialization file is scanned until all data is collected or the timeout period defined in 
the initialization file expires. The XMLTV file contains the aggregation of all the data collected. For most situations only one 
frequency is required. EIT and MHEG5 data is normally the same on every frequency for a particular broadcaster and OpenTV is 
normally broadcast on a single 'base' frequency'. If the 'base' frequency is not known run the program with all possible 
frequencies and the log produced by the program will show which frequencies contain OpenTV data. 

A number of initialization files are supplied in the 'Samples' directory as examples covering various combinations of data.
These are presented as tasks when you use EPG Centre to create a new initialization file.
 
In many cases a sample file will be sufficient to run a successful collection but for satellite collections especially it may be 
necessary to change the dish parameters to match your hardware. 

The output file is created each time the utility is run. The full name of the file can be specified in the initialization file. The 
default name if one is not specified in the initialization file is TVGuide.xml created in the application data directory.

Extensive logging information is output to the console window and a log file (EPG Collector.log). The log rolls round when it 
reaches 8MB and is written to the same sub-directory of the Windows application data directory as the default output file. 
Other log files may be created by the different protocols using options in the initialization file.

The program can be abandoned at any time by pressing the 'Q' key. No output file will be produced.

An exit code is set prior to terminating which can be tested for in a command file. The values are as follows:

	0 = run successful, all data collected
	1 = no DVB tuners detected
	2 = failed to open the initialization file
	3 = the initialization parameters are incorrect
	4 = the command line is incorrect
	5 = a program exception has occurred
	6 = run completed but data incomplete
	7 = cancelled by user
	8 = the initialization parameters do not match the tuner configuration or there is a parameter conflict.
	9 = cannot write log file
	10 = some frequencies could not be processed
	11 = the output file could not be created

2.2 Installation
================

The package is available as a Windows Installer file (msi) or as a zipped collection of files. Both formats have the same contents. 
The package does not install any drivers or DirectShow filters, nor does it store or alter any registry settings.

It is not necessary to uninstall any old version before installing a new version. If you have changed any of the standard
data files that come with the installation make sure you back them up or they will be overwritten by the new install.

2.3 Initialization Parameters
=============================

Each collection requires a parameter set that is created and maintained by EPG Centre.

If you have parameters that were created for earlier versions of the package prior to 3.0 you can use the EPG Centre to
convert them to the format described here by choosing to change a parameter file and then saving it. It will be saved in
the new format.

2.4 Notes on Tuners
===================

Many of the issues that users have with getting EPG Collector to work surround tuners. This section lists issues that have been encountered
for specific tuners


2.4.1 DVBLogic virtual tuners
=============================

EPG Collector cannot use DVBLink virtual tuners. These have been specifically designed to work with other elements of DVBLogic software and will
not interface to software such as the Collector.

2.4.2 TechniSat (all tuners)
============================

TechniSat tuners can be supplied with 2 separate tuner drivers. If the default installation of the TechniSat driver software is carried out a
non-BDA compliant driver will be installed and the Collector will not work with it. It will appear to acquire a signal but no data will be received.

The TechniSat BDA compliant tuner driver is in the BDA subdirectory of the driver software. It must be installed by responding to the Windows 
'New Hardware Found' message and pointing the Windows installation process at the BDA directory.

2.4.3 TechniSat Mantis
======================

If you are using a DiSEqC switch with this tuner do not select the option on the Advanced tab to repeat the DiSEqC command in the event of an error.
The Mantis tuner returns an error even though the DiSEqC command succeeds and repeating the command causes it to not pass any data to the Collector.

2.4.4 HD HomeRun
================

The HD HomeRun is a network tuner. The Collector can use the virtual tuners set up by this device but it must be given security clearance to
access the network first or it will silently fail. 

This is due to an apparent fault in the Windows OS in that the security failure message is not displayed when the Collector tries to use
the virtual tuner.

2.4.5 Pinnacle
==============

There is a new option on the EPG Centre Advanced tab labelled 'Repeat DiSEqC command if first attempt failed'. Users of Pinnacle tuners must
set this option or DiSEqC switching will not work.

2.4.6 TBS
=========

There is a new option on the EPG Centre Advanced tab labelled 'Check tuner in use before changing DiSEqC switch'. Users of TBS tuners must
NOT set this option or channel scanning or EPG collection will fail. The signal will lock but no data will be received. 

3. DVBLink Plugin
=================

3.1 Overview
============

The DVBLink plugin provides seamless collection of EPG data within a TV Source environment. The plugin will collect all the 
types of EPG data spported by the stand-alone collection process except MHEG5.

The TV Source software takes care of all aspects of the hardware and the tuning process. The plugin receives data once a frequency
is tuned successfully. 

Each frequency that is scanned has a matching parameter file that specifies the type of data to collect along with the 
relevant parameters and options already described for the stand-alone collection process. Nearly all the options and settings
available to the stand-alone collection are relevant to the plugin.

The EPG data collected can be passed directly to TV Source by the plugin or it can be written to an xmltv compliant file
if it is to be processed further.

3.2 Installation
================

The plugin is released as part of the normal package. When plugin parameter files are created or updated using the EPG Centre, as
well as writing the parameter file to the TV Source directory, the plugin module is automatically installed in the same directory.

There is also a menu option in EPG Centre to update the plugin in the TV Source directory. This option will be needed if the
EPG Collector package is updated or a fix is released for the plugin.

Because of this procedure the plugin will not appear in the list of available EPG sources in TV Source until either a parameter 
file is created or the plugin update option is chosen in the EPG Centre.

3.3 Parameter Files
===================

The EPG Centre must be used to create a parameter file for each frequency that is to be scanned for EPG data. The parameter
file will contain parameters and options that control the plugin collection process in the same way as the stand-alone process.

It is highly recommended that these files are not edited manually.

3.4 Log Files
=============

The plugin outputs logging information to the normal EPG Collector log, not to the TV Source log. The contents can be viewed
using the EPG Centre.

Appendix 1 Areas and regions
============================


1.1 New Zealand Freeview (EIT and MHEG5)
========================================

Channel:4096	 	// Auckland
Channel:4352	 	// Waikato
Channel:4608	 	// North Island Central
Channel:4864	 	// Wellington
Channel:5120	 	// Christchurch
Channel:5376	 	// Dunedin

1.2 UK (OpenTV)
===============

Channel:4097,14		// England (BBC) - Border & NW (ITV)
Channel:4097,12		// England (BBC) - Border (ITV)
Channel:4097,29		// England (BBC) - E Mid & Yorkshire (ITV)
Channel:4097,27		// England (BBC) - E London & Midlands (ITV)
Channel:4097,18		// England (BBC) - East London & SE (ITV)
Channel:4097,25		// England (BBC) - East & Midlands (ITV)
Channel:4097,21		// England (BBC) - East & Yorkshire (ITV)
Channel:4097,2		// England (BBC) - East (ITV)
Channel:4097,11		// England (BBC) - London & SE (ITV)
Channel:4097,9		// England (BBC) - London & South (ITV)
Channel:4097,1		// England (BBC) - London (ITV)
Channel:4097,19		// England (BBC) - Midlands & NW (ITV)
Channel:4097,24		// England (BBC) - Midlands & West (ITV)
Channel:4097,3		// England (BBC) - Midlands (ITV)
Channel:4097,20		// England (BBC) - Midlands & Yorkshire (ITV)
Channel:4097,26		// England (BBC) - NE & Yorkshire (ITV)
Channel:4097,17		// England (BBC) - NW & Wales (ITV)
Channel:4097,13		// England (BBC) - North East (ITV)
Channel:4097,7		// England (BBC) - North West (ITV)
Channel:4097,5		// England (BBC) - South (ITV)
Channel:4097,10		// England (BBC) - South East (ITV)
Channel:4097,6		// England (BBC) - South West (ITV)
Channel:4097,4		// England (BBC) - West (ITV)
Channel:4097,8		// England (BBC) - Yorkshire (ITV)
Channel:4099,73		// England 2 - Isle Of Man
Channel:4099,65		// England 2 - Brighton
Channel:4099,63		// England 2 - HTV W/Thames Valley
Channel:4099,70		// England 2 - Henley On Thames
Channel:4099,66		// England 2 - London / Thames Valley
Channel:4099,64		// England 2 - London Kent
Channel:4099,68		// England 2 - Meridian North
Channel:4099,62		// England 2 - North East Midlands
Channel:4099,71		// England 2 - Oxford
Channel:4099,61		// England 2 - Scarborough (bc)
Channel:4099,60		// England 2 - Sheffield (au)
Channel:4099,72		// England 2 - South Yorkshire
Channel:4099,69		// England 2 - Tees
Channel:4099,67		// England 2 - West Dorset
Channel:4099,41		// Wales (BBC) - Midlands (ITV)
Channel:4099,42		// Wales (BBC) - North West (ITV)
Channel:4099,43		// Wales (BBC) - Wales (ITV)
Channel:4099,45		// Wales (BBC) - NW & Wales (ITV)
Channel:4100,33		// Northern Ireland(BBC & ITV)
Channel:4100,34		// Channel Isles(ITV)
Channel:4100,50		// Republic of Ireland 4100
Channel:4098,36		// Scotland (BBC) - Border (ITV)
Channel:4098,38		// Scotland (BBC) - C Scot & N Scot (ITV)
Channel:4098,37		// Scotland (BBC) - Central Scotland (ITV)
Channel:4098,35		// Scotland (BBC) - North Scotland (ITV)

1.3 Australia Foxtel Satellite (OpenTV)
=======================================

Channel:25184,1	 	// Adelaide
Channel:25184,2	 	// Brisbane
Channel:25184,6	 	// Melbourne
Channel:25184,10 	// Sydney
Channel:25184,12 	// Perth

Please not that this list is incomplete. There are other areas and regions that have not yet been identified.

1.4 Australia Foxtel Cable (OpenTV)
===================================

Channel:25184,21 	// Adelaide
Channel:25184,22 	// Brisbane
Channel:25184,26 	// Melbourne
Channel:25184,31	// Gold Coast
Channel:25184,33 	// Perth
Channel:25184,37 	// Sydney

Please not that this list is incomplete. There are other areas and regions that have yet not been identified.

============================================================ End Of ReadMe ============================================================