Add help text for DVB configuration

This commit is contained in:
Andreas Öman 2009-07-18 20:54:58 +00:00
parent 0b6f394f3b
commit 9ad9b550a1
2 changed files with 155 additions and 84 deletions

View file

@ -1,96 +1,162 @@
<div class="hts-doc-text">
<img src="docresources/configdvbtab.png">
<p>
This tab is split in two panes. To the left is a tree which, at root level,
contains all DVB adapters found by Tvheadend during startup.
<dl>
<dt>General tab</dt>
The general tab contains information and some per-adapter global
configuration.
<dl>
<dt>Step by step configuration of DVB
<dt>Add DVB Network by location...
<dd>
The DVB configuration is perhaps the most tricky part to configure
in Tvheadend. Therefore, this section begins with a step-by-step
guide.
<ul>
<li>Click on an adapter in the left pane.
<li>Click on 'Add mux(es)'. A popup window will appear:
<br>
<img src="docresources/muxbylocation.png">
<br>
For DVB-T and DVB-C adapters, expand appropriate country.
DVB-S adapters only have one folder to expand called 'Geosynchronous Orbit'.
In these folders you find a list of available networks.
Select the appropriate network and press the 'Add' button.
<li>
Tvheadend will now immediately start to probe each mux for available
services. Expand the DVB adapter in the tree
and wait until all muxes has been visisted
at least once (Status of all multiplexes should change from 'Unknown'
when a mux has been visited).
Pressing this button will popup a window that allows the user to select
a DVB network based on location. The adapter will be populated with
multiplexes from these networks and immediately start to scan for services.
<li>
You can now, if you want, verify that the mux scanner has found
services by expanding the mux nodes.
<li>
Select the adapters again and press 'Probe services'.
A popup will ask you to confirm this action. Press 'Yes'.
The Service probe will scan through all services on all muxes on the
adapter and map them to channels with the corresponding name.
Progress and result for each service is displayed in the 'System Log'
at the bottom of the application. Wait until the probing is completed.
<li>
Done! You can click over to the 'Channels' configuration tab and
inspect all working channels.
</ul>
<dt>DVB Adapters
<dt>Map DVB services to channels...
<dd>
A DVB adapter represents a piece of hardware attached to the system.
DVB receivers with dual tuners will present themself as two adapters
to the Tvheadend application. Tvheadend support DVB-T, DVB-C and DVB-S
adapters.
<p>
When an adapter is selected, the right pane displays configurable items
for the adapter. Also available in the right toolbar is a set of operations
that can be performed on the adapter.
<p>
Underneath each adapter in the tree is a list of DVB muxes.
For more information about muxes, see further down.
<p>
There is currently no way of adding a new adapter to Tvheadend when running.
If a new adapter is plugged into the system Tvheadend needs to be restarted
in order to detect it.
<p>
If Tvheadend has configuration for an adapter and the adapter is missing
upon startup the configuration will be left untouched in case the adapter
will be back in the future. There is currently no way to remove configuration
for a no longer present adapter.
<p>
Warning: Unplugging an DVB adapter (USB, etc) during operation (i.e when
Tvheadend is running) can result in deadlocking the kernel USB subsystem,
most likely requiring a system restart.
<p>
Warning2: Suspending a system is (from a USB driver perspective) equivalent
to a unplug/insert event. Thus, suspending a system running Tvheadend
with USB adapters is not recommented at the moment.
Pressing this button will start a process that scans all services on all
multiplexes and tries to verify if the service is actually a working
TV channel. If so, the channel will be created and mapped to this service.
<dt>DVB Multiplexes
<dt>Adapter name
<dd>
To put it simply, a DVB multiplex is a digital signal modulated
at a specific frequency that carries a number of servies (where a
service could be, but is not limited to, a TV channel).
<p>
There are currently no operations that can be performed on a single mux.
You can change the displayname for the adapter.
<dt>DVB Services
<dt>Autodetect muxes
<dd>
A service is equivivalent to a TV channel.
<p>
There are currently no operations that can be performed on a single service.
The DVB transmissions contains information about other muxes available
on the same network. If this checkbox is enabled, Tvheadend will
automatically create new muxes as it receives configuration for them
via the DVB networks.
<dt>Idle scanning
<dd>
When nothing else happens Tvheadend will continously rotate among all
muxes and tune to them to verify that they are still working.
If your adapter have problems with lots of tuning, try to disable this.
<dt>Detailed logging
<dd>
If this is enabled, Tvheadend will log more information related to
this specific adapter. You might wanna enable this if you have some
kind of issues in order to better diagnose the problems.
</dl>
</dl>
<dl>
<dt>Multiplexes tab</dt>
All multiplexes on the currently selected adapter are listed and can be
edited in a grid.
<ul>
<li>To edit a cell, double-click on it. After a cell is changed it
will flags one of its corner to red to indicated that it has been
changed. To commit these changes back to Tvheadend press the
'Save changes' button. In order to change a Checkbox cell you only
have to click once in it.
<li>To delete one or more entries, select the lines (by clicking once on
them), and press the 'Delete selected' button. A popup
will ask you to confirm your request. Note, that if you have
automatic mux discovery enabled the mux will probably come back
quite soon.
</ul>
The columns have the following functions:
<dl>
<dt>Enabled
<dd>Uncheck this if a multiplex is of no interest to you or otherwise
temporary broken
<dt>Network
<dd>Network name as given in the DVB stream. Can not be changed
<dt>Frequency
<dd>Center frequency for the mux. Can not be changed
<dt>Modulation
<dd>Information about the modulation used on the mux. Can not be changed
<dt>Mux id
<dd>Unique ID for this mux in the dvb network. Can not be changed
<dt>Quality
<dd>Tvheadend's estimated quality for the mux.
</dl>
</dl>
<dl>
<dt>Services tab</dt>
All services on the currently selected adapter are listed and can be
edited in a grid.
<ul>
<li>To edit a cell, double-click on it. After a cell is changed it
will flags one of its corner to red to indicated that it has been
changed. To commit these changes back to Tvheadend press the
'Save changes' button. In order to change a Checkbox cell you only
have to click once in it.
<li>Service can not be deleted since they are directly inherited /
discovered from a mux they will reapper in just a few seconds
should one delete them.
</ul>
<p>
The columns have the following functions:
<dl>
<dt>Enabled
<dd>Uncheck this if a service is of no interest to you or otherwise
temporary broken
<dt>Service name
<dd>Service name as given in the DVB stream. Can not be changed
<dt>Channel name
<dd>Double-click on this column to map the service to a channel.
<dt>Type
<dd>Type of service. Can not be changed
<dt>Provider
<dd>Provider as given in the DVB stream. Can not be changed
<dt>Network
<dd>Network name for the mux this service resides on
<dt>Multiplex
<dd>Center frequency for the multiplex this service resides on
<dt>Information button
<dd>Press this to get a popup with more information about the service
</dl>
<p>
A word about DVB adapters
<p>
A DVB adapter represents a piece of hardware attached to the system.
DVB receivers with dual tuners will present themself as two adapters
to the Tvheadend application. Tvheadend support DVB-T, DVB-C and DVB-S
adapters.
<p>
There is currently no way of adding a new adapter to Tvheadend when running.
If a new adapter is plugged into the system Tvheadend needs to be restarted
in order to detect it.
<p>
If Tvheadend has configuration for an adapter and the adapter is missing
upon startup the configuration will be left untouched in case the adapter
will be back in the future. There is currently no way to remove configuration
for a no longer present adapter.
<p>
Warning: Unplugging an DVB adapter (USB, etc) during operation (i.e when
Tvheadend is running) can result in deadlocking the kernel USB subsystem,
most likely requiring a system restart.
<p>
Warning2: Suspending a system is (from a USB driver perspective) equivalent
to a unplug/insert event. Thus, suspending a system running Tvheadend
with USB adapters is not recommented at the moment.
</dl>
</div>

View file

@ -1182,7 +1182,12 @@ tvheadend.dvb = function()
iconCls: 'hardware',
layout:'fit',
tbar: [
adapterSelection
adapterSelection, '->', {
text: 'Help',
handler: function() {
new tvheadend.help('DVB', 'config_dvb.html');
}
}
],
items: [