Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
mdhelp: add more details to the caclient, add screenshot
  • Loading branch information
Mark Clarkstone authored and perexg committed May 4, 2016
1 parent da5924a commit 02ebe2d
Show file tree
Hide file tree
Showing 2 changed files with 42 additions and 7 deletions.
49 changes: 42 additions & 7 deletions docs/class/caclient.md
@@ -1,9 +1,11 @@
Tvheadend supports connecting to card clients via the cwc (newcamd) and
capmt (linux network dvbapi) protocols for so-called 'softcam' descrambling.

!['CA Client Configuration Example'](docresources/caclientconfig.png)

---

####Menu Bar/Buttons
###Menu Bar/Buttons

The following functions are available:

Expand All @@ -13,19 +15,18 @@ Button | Function
**Undo** | Undo any changes made to the CA client configuration since the last save.
**Add** | Add a new CA client configuration.
**Delete** | Delete an existing CA client configuration.
**Clone** | Clone the currently selected configuration.
**Move Up** | Move the selected CA client configuration up in the list.
**Move Down** | Move the selected CA client configuration down in the list.
**Show Passwords** | Reveals any stored CA client passwords.
**View Level**| Change the interface view level to show/hide more advanced options.
**Show/Hide Passwords** | Reveal/Hide any stored CA client passwords.
**Help** | Display this help page.

---

####Available CA types
###Available CA types

New CA configurations are created with the _Add_ button, with subsequent
editing done within the grid. The following configuration parameters are
used, depending on the type of CA access:
The following configuration parameters are used, depending on the type
of CA access:

* List of types

Expand All @@ -35,3 +36,37 @@ used, depending on the type of CA access:
- [AES constant code word client](class/caclient_ccw_aes)

---

###Connection Status

The icon next to each entry within the grid indicates the client's
connection status.

Icon | Description
---------------------------------------------|------------
!['Accept/OK Icon'](icons/accept.png) | The client is connected.
!['Error Icon'](icons/exclamation.png) | There was an error connecting to the client.
!['Stop/Disabled Icon'](icons/stop.png) | The client is disabled.

---

###Adding/Editing a CA Configuration

New CA configurations are created with the *[Add]* button. To edit an
existing configuration, click on it from within the grid, the
*Parameters* panel should then appear on the right hand side.

**Tips**:
* Remember to *[Save]* your changes before selecting another config
from within the grid.
* You can clone an existing config by clicking the *[Clone]*
button.

---

###Deleting a CA Configuration

Highlight (select) the desired entry from the grid, then press the
*[Delete]* button from the menu bar.

---
Binary file added docs/docresources/caclientconfig.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 02ebe2d

Please sign in to comment.