Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
mdhelp: complete(?) tv adapters docs and added more screenshots
  • Loading branch information
Mark Clarkstone authored and perexg committed Apr 26, 2016
1 parent 2c2486c commit 6cb1e81
Show file tree
Hide file tree
Showing 14 changed files with 190 additions and 7 deletions.
6 changes: 6 additions & 0 deletions docs/class/linuxdvb_frontend.md
@@ -0,0 +1,6 @@
This is the list of available parameters for the linuxdvb frontend. It
is used as a base for other frontends.

See [TV Adapters](tv_adapters).

---
25 changes: 25 additions & 0 deletions docs/class/linuxdvb_frontend_dvbc.md
@@ -0,0 +1,25 @@
This panel lists all the available Cable (DVB-C/C2/ISDB-C/ATSC-C) frontend
parameters.

!['DVB-C frontend parameters'](docresources/dvbcfrontendparams.png)

---

* Other Frontends
- [DVB-C](class/linuxdvb_frontend_dvbc)
- [ATSC-C](class/linuxdvb_frontend_atsc_c)
- [ISDB-C](class/linuxdvb_frontend_isdb_c)
* Back to [TV Adapters](tv_adapters)

---

###Buttons

The following buttons are available:

Button | Function
---------------|---------
**Save** | Save the current configuration.
**Help** | Display this help page.

---
25 changes: 25 additions & 0 deletions docs/class/linuxdvb_frontend_dvbs.md
@@ -0,0 +1,25 @@
This panel lists all the available satellite (DVB-S/ISDB-S) frontend
parameters.

!['DVB-S frontend parameters'](docresources/dvbsfrontendparams.png)

---

* Other Frontends
- [Master](class/linuxdvb_frontend_dvbs)
- [Slave](class/linuxdvb_frontend_dvbs_slave)
- [Master (ISDB-S)](class/linuxdvb_frontend_isdb_s)
* Back to [TV Adapters](tv_adapters)

---

###Buttons

The following buttons are available:

Button | Function
---------------|---------
**Save** | Save the current configuration.
**Help** | Display this help page.

---
25 changes: 25 additions & 0 deletions docs/class/linuxdvb_frontend_dvbt.md
@@ -0,0 +1,25 @@
This panel lists all the available Terrestrial (DVB-T/T2/ISDB-T/ATSC-T) frontend
parameters.

!['DVB-T frontend parameters'](docresources/dvbtfrontendparams.png)

---

* Other Frontends
- [DVB-T/DVB-T2](class/linuxdvb_frontend_dvbt)
- [ATSC-T](class/linuxdvb_frontend_atsc_t)
- [ISDB-T](class/linuxdvb_frontend_isdb_t)
* Back to [TV Adapters](tv_adapters)

---

###Buttons

The following buttons are available:

Button | Function
---------------|---------
**Save** | Save the current configuration.
**Help** | Display this help page.

---
32 changes: 32 additions & 0 deletions docs/class/linuxdvb_satconf.md
@@ -0,0 +1,32 @@
This tab lists all the available satellite (DVB-S/ISDB-S) configuration
parameters.

!['Example Configuration'](docresources/dvbsatconf.png)

---

###Buttons

The following buttons are available:

Button | Function
---------------|---------
**Save** | Save the current configuration.
**Help** | Display this help page.

---

* Satellite Configuration
- [Universal LNB](class/linuxdvb_satconf_lnbonly)
- [2 Port](class/linuxdvb_satconf_2port)
- [4 Port](class/linuxdvb_satconf_4port)
* Satellite Configuration (Advanced)
- [Advanced LNB](class/linuxdvb_satconf_advanced)
- [Unicable EN50494 (experimental)](class/linuxdvb_satconf_en50494)
- [DiseqC Rotor](class/linuxdvb_rotor)
- [DiSEqC Switch](class/linuxdvb_switch)
- [Rotor (GOTOX)](class/linuxdvb_rotor_gotox)
- [Rotor (USALS)](class/linuxdvb_rotor_usals)
* Back to [TV Adapters](tv_adapters)

---
Binary file added docs/docresources/dvbcfrontendparams.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/docresources/dvbsatconf.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/docresources/dvbsfrontendparams.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/docresources/dvbtfrontendparams.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
52 changes: 45 additions & 7 deletions docs/markdown/tv_adapters.md
Expand Up @@ -8,34 +8,72 @@ The adapters and tuners are listed and edited in a tree.

###Buttons

The following functions are available:
The following buttons are available:

Button | Function
---------------|---------
**Save** | Save the current TV adapter configuration.
**Save** | Save the current configuration.
**Help** | Display this help page.

---

###Device Tree

The device tree lists the available frontends, LNB configuration and
so on related to your device in sections. Clicking on these sections
will display all available parameters.
so on related to your device(s) in sections. Clicking on these sections
will display all available parameters and various device information.

!['TV Adapter params'](docresources/tvadapterparams.png)

**Tip**: Remember to save your changes *before* switching panels.

---

##DVB-S
##Device Configuration Options

You will generally see the following parameters for your device(s), however
there are device-specific parameters too, see
[Device-specific Parameters](#device-specific-parameters) for a full
list.

<tvh_class_items>linuxdvb_frontend</tvh_class_items>

---

##Device-specific Parameters

###Satellite (DVB-S/ISDB-S)

* Frontend
- [Master](class/linuxdvb_frontend_dvbs)
- [Slave](class/linuxdvb_frontend_dvbs_slave)
* SatConf
- [Basic LNB](class/linuxdvb_satconf)
- [Master (ISDB-S)](class/linuxdvb_frontend_isdb_s)
* Satellite Configuration
- [Universal LNB](class/linuxdvb_satconf_lnbonly)
- [2 Port](class/linuxdvb_satconf_2port)
- [4 Port](class/linuxdvb_satconf_4port)
* Satellite Configuration (Advanced)
- [Advanced LNB](class/linuxdvb_satconf_advanced)
- [Unicable EN50494 (experimental)](class/linuxdvb_satconf_en50494)
- [DiseqC Rotor](class/linuxdvb_rotor)
- [DiSEqC Switch](class/linuxdvb_switch)
- [Rotor (GOTOX)](class/linuxdvb_rotor_gotox)
- [Rotor (USALS)](class/linuxdvb_rotor_usals)

---

###Terrestrial (DVB-T/ATSC-T/ISDB-T)

* Frontend
- [DVB-T/DVB-T2](class/linuxdvb_frontend_dvbt)
- [ATSC-T](class/linuxdvb_frontend_atsc_t)
- [ISDB-T](class/linuxdvb_frontend_isdb_t)

---

###Cable (DVB-C/ATSC-C/ISDB-C)

* Frontend
- [DVB-C](class/linuxdvb_frontend_dvbc)
- [ATSC-C](class/linuxdvb_frontend_atsc_c)
- [ISDB-C](class/linuxdvb_frontend_isdb_c)
15 changes: 15 additions & 0 deletions src/input/mpegts/linuxdvb/linuxdvb_frontend.c
Expand Up @@ -51,11 +51,17 @@ linuxdvb_frontend_class_changed ( idnode_t *in )
linuxdvb_adapter_changed(la);
}

CLASS_DOC(linuxdvb_frontend)
CLASS_DOC(linuxdvb_frontend_dvbs)
CLASS_DOC(linuxdvb_frontend_dvbt)
CLASS_DOC(linuxdvb_frontend_dvbc)

const idclass_t linuxdvb_frontend_class =
{
.ic_super = &mpegts_input_class,
.ic_class = "linuxdvb_frontend",
.ic_caption = N_("Linux DVB frontend"),
.ic_doc = tvh_doc_linuxdvb_frontend_class,
.ic_changed = linuxdvb_frontend_class_changed,
.ic_properties = (const property_t[]) {
{
Expand Down Expand Up @@ -175,6 +181,7 @@ const idclass_t linuxdvb_frontend_dvbt_class =
{
.ic_super = &linuxdvb_frontend_class,
.ic_class = "linuxdvb_frontend_dvbt",
.ic_doc = tvh_doc_linuxdvb_frontend_dvbt_class,
.ic_caption = N_("Linux DVB-T frontend"),
.ic_properties = (const property_t[]){
{
Expand Down Expand Up @@ -258,6 +265,7 @@ const idclass_t linuxdvb_frontend_dvbs_class =
{
.ic_super = &linuxdvb_frontend_class,
.ic_class = "linuxdvb_frontend_dvbs",
.ic_doc = tvh_doc_linuxdvb_frontend_dvbs_class,
.ic_caption = N_("Linux DVB-S frontend"),
.ic_get_childs = linuxdvb_frontend_dvbs_class_get_childs,
.ic_properties = (const property_t[]){
Expand Down Expand Up @@ -300,6 +308,7 @@ const idclass_t linuxdvb_frontend_dvbs_slave_class =
{
.ic_super = &linuxdvb_frontend_class,
.ic_class = "linuxdvb_frontend_dvbs_slave",
.ic_doc = tvh_doc_linuxdvb_frontend_dvbs_class,
.ic_caption = N_("Linux DVB-S slave frontend"),
.ic_properties = (const property_t[]){
{
Expand Down Expand Up @@ -330,6 +339,7 @@ const idclass_t linuxdvb_frontend_dvbc_class =
{
.ic_super = &linuxdvb_frontend_class,
.ic_class = "linuxdvb_frontend_dvbc",
.ic_doc = tvh_doc_linuxdvb_frontend_dvbc_class,
.ic_caption = N_("Linux DVB-C frontend"),
.ic_properties = (const property_t[]){
{}
Expand All @@ -340,6 +350,7 @@ const idclass_t linuxdvb_frontend_atsc_t_class =
{
.ic_super = &linuxdvb_frontend_class,
.ic_class = "linuxdvb_frontend_atsc_t",
.ic_doc = tvh_doc_linuxdvb_frontend_dvbt_class,
.ic_caption = N_("Linux ATSC-T frontend"),
.ic_properties = (const property_t[]){
{}
Expand All @@ -350,6 +361,7 @@ const idclass_t linuxdvb_frontend_atsc_c_class =
{
.ic_super = &linuxdvb_frontend_class,
.ic_class = "linuxdvb_frontend_atsc_c",
.ic_doc = tvh_doc_linuxdvb_frontend_dvbc_class,
.ic_caption = N_("Linux ATSC-C frontend"),
.ic_properties = (const property_t[]){
{}
Expand All @@ -360,6 +372,7 @@ const idclass_t linuxdvb_frontend_isdb_t_class =
{
.ic_super = &linuxdvb_frontend_class,
.ic_class = "linuxdvb_frontend_isdb_t",
.ic_doc = tvh_doc_linuxdvb_frontend_dvbt_class,
.ic_caption = N_("Linux ISDB-T frontend"),
.ic_properties = (const property_t[]){
{}
Expand All @@ -370,6 +383,7 @@ const idclass_t linuxdvb_frontend_isdb_c_class =
{
.ic_super = &linuxdvb_frontend_class,
.ic_class = "linuxdvb_frontend_isdb_c",
.ic_doc = tvh_doc_linuxdvb_frontend_dvbc_class,
.ic_caption = N_("Linux ISDB-C frontend"),
.ic_properties = (const property_t[]){
{}
Expand All @@ -380,6 +394,7 @@ const idclass_t linuxdvb_frontend_isdb_s_class =
{
.ic_super = &linuxdvb_frontend_class,
.ic_class = "linuxdvb_frontend_isdb_s",
.ic_doc = tvh_doc_linuxdvb_frontend_dvbs_class,
.ic_caption = N_("Linux ISDB-S frontend"),
.ic_properties = (const property_t[]){
{}
Expand Down
3 changes: 3 additions & 0 deletions src/input/mpegts/linuxdvb/linuxdvb_rotor.c
Expand Up @@ -86,9 +86,12 @@ linuxdvb_rotor_class_get_title ( idnode_t *o, const char *lang )

extern const idclass_t linuxdvb_diseqc_class;

CLASS_DOC(linuxdvb_satconf)

const idclass_t linuxdvb_rotor_class = {
.ic_super = &linuxdvb_diseqc_class,
.ic_class = "linuxdvb_rotor",
.ic_doc = tvh_doc_linuxdvb_satconf_class,
.ic_caption = N_("DiseqC rotor"),
.ic_get_title = linuxdvb_rotor_class_get_title,
.ic_properties = (const property_t[]) {
Expand Down
11 changes: 11 additions & 0 deletions src/input/mpegts/linuxdvb/linuxdvb_satconf.c
Expand Up @@ -208,12 +208,16 @@ linuxdvb_satconf_class_get_childs ( idnode_t *o )
/*
* Generic satconf
*/

CLASS_DOC(linuxdvb_satconf) /* Referenced by multiple classes. */

const idclass_t linuxdvb_satconf_class =
{
.ic_class = "linuxdvb_satconf",
.ic_caption = N_("DVB-S satellite configuration"),
.ic_event = "linuxdvb_satconf",
.ic_get_title = linuxdvb_satconf_class_get_title,
.ic_doc = tvh_doc_linuxdvb_satconf_class,
.ic_changed = linuxdvb_satconf_class_changed,
.ic_properties = (const property_t[]) {
{
Expand Down Expand Up @@ -276,12 +280,14 @@ const idclass_t linuxdvb_satconf_lnbonly_class =
{
.ic_super = &linuxdvb_satconf_class,
.ic_class = "linuxdvb_satconf_lnbonly",
.ic_doc = tvh_doc_linuxdvb_satconf_class,
.ic_caption = N_("DVB-S simple"),
.ic_properties = (const property_t[]) {
{
.type = PT_STR,
.id = "networks",
.name = N_("Networks"),
.desc = N_("The networks assigned to the device."),
.islist = 1,
.get = linuxdvb_satconf_class_network_get0,
.set = linuxdvb_satconf_class_network_set0,
Expand All @@ -300,6 +306,7 @@ const idclass_t linuxdvb_satconf_2port_class =
{
.ic_super = &linuxdvb_satconf_class,
.ic_class = "linuxdvb_satconf_2port",
.ic_doc = tvh_doc_linuxdvb_satconf_class,
.ic_caption = N_("DVB-S tone burst"),
.ic_properties = (const property_t[]) {
{
Expand Down Expand Up @@ -337,6 +344,7 @@ const idclass_t linuxdvb_satconf_4port_class =
{
.ic_super = &linuxdvb_satconf_class,
.ic_class = "linuxdvb_satconf_4port",
.ic_doc = tvh_doc_linuxdvb_satconf_class,
.ic_caption = N_("DVB-S 4-port"),
.ic_properties = (const property_t[]) {
{
Expand Down Expand Up @@ -455,6 +463,7 @@ const idclass_t linuxdvb_satconf_en50494_class =
{
.ic_super = &linuxdvb_satconf_class,
.ic_class = "linuxdvb_satconf_en50494",
.ic_doc = tvh_doc_linuxdvb_satconf_class,
.ic_caption = N_("DVB-S EN50494 (UniCable, experimental)"),
.ic_properties = (const property_t[]) {
{
Expand Down Expand Up @@ -521,6 +530,7 @@ const idclass_t linuxdvb_satconf_advanced_class =
{
.ic_super = &linuxdvb_satconf_class,
.ic_class = "linuxdvb_satconf_advanced",
.ic_doc = tvh_doc_linuxdvb_satconf_class,
.ic_caption = N_("DVB-S advanced"),
.ic_get_childs = linuxdvb_satconf_class_get_childs,
.ic_properties = (const property_t[]) {
Expand Down Expand Up @@ -1313,6 +1323,7 @@ const idclass_t linuxdvb_satconf_ele_class =
{
.ic_class = "linuxdvb_satconf_ele",
.ic_caption = N_("Satconf"),
.ic_doc = tvh_doc_linuxdvb_satconf_class,
.ic_event = "linuxdvb_satconf_ele",
.ic_get_title = linuxdvb_satconf_ele_class_get_title,
.ic_get_childs = linuxdvb_satconf_ele_class_get_childs,
Expand Down
3 changes: 3 additions & 0 deletions src/input/mpegts/linuxdvb/linuxdvb_switch.c
Expand Up @@ -109,11 +109,14 @@ linuxdvb_switch_class_get_title ( idnode_t *o, const char *lang )

extern const idclass_t linuxdvb_diseqc_class;

CLASS_DOC(linuxdvb_satconf)

const idclass_t linuxdvb_switch_class =
{
.ic_super = &linuxdvb_diseqc_class,
.ic_class = "linuxdvb_switch",
.ic_caption = N_("DiseqC switch"),
.ic_doc = tvh_doc_linuxdvb_satconf_class,
.ic_get_title = linuxdvb_switch_class_get_title,
.ic_properties = (const property_t[]) {
{
Expand Down

0 comments on commit 6cb1e81

Please sign in to comment.