Difference between revisions of "Enigma2 Backend"

From Official Kodi Wiki
Jump to navigation Jump to search
m (Text replacement - "{{mininav|PVR|PVR_recording_software}}" to "{{mininav|PVR}}")
Line 2: Line 2:
{{mininav|[[PVR]]}}
{{mininav|[[PVR]]}}


<section begin="intro" />Enigma2 is a framebuffer-based zapping application (GUI) that is primarly targeted to physicial set-top-boxes running embedded Linux ([http://www.openembedded.org/wiki/Main_Page OpenEmbedded] based firmware distrobutions), however Enigma2 can technically also run on regular PCs, but it is not common.  
<section begin="intro" />Enigma2 is a framebuffer-based zapping application (GUI) that is primarily targeted to physical set-top-boxes running embedded Linux ([http://www.openembedded.org/wiki/Main_Page OpenEmbedded] based firmware distributions), however Enigma2 can technically also run on regular PCs, but it is not common.  


While the Enigma2 software was originally developed by Dream Multimedia for their [[w:Dreambox|Dreambox]] series, the [http://opendreambox.org opendreambox.org] has made Enigma2 into an popular open source based firmware platform for set-top boxes and it is used by a number of differet set-top box manufacturers, including the most commonly known are [[w:Dreambox|Dreambox]], [[w:DBox2|DBox2]], and [[w:Vu+|Vu+ (VuPlus)]], which all use Enigma2 based firmware images. Most of these Enigma2 based set-top boxes falls under the catagory of Linux-powered satellite, terrestrial and cable digital television receivers.
While the Enigma2 software was originally developed by Dream Multimedia for their [[w:Dreambox|Dreambox]] series, the [http://opendreambox.org opendreambox.org] has made Enigma2 into an popular open source based firmware platform for set-top boxes and it is used by a number of different set-top box manufacturers, including the most commonly known are [[w:Dreambox|Dreambox]], [[w:DBox2|DBox2]], and [[w:Vu+|Vu+ (VuPlus)]], which all use Enigma2 based firmware images. Most of these Enigma2 based set-top boxes falls under the category of Linux-powered satellite, terrestrial and cable digital television receivers.


With the VU+ (VuPlus) PVR add-on Kodi PVR can be used also with a connected VU+ or any other Enigma2 based set-top boxes, and in general all Enigma2 based settop boxes should be supported.
With the Enigma2 PVR add-on Kodi PVR can be used also with any Enigma2 based set-top boxes running OpenWebIf. Other WebIfs are supported with a subset of the original functionality.


__TOC__
__TOC__
Line 13: Line 13:
Enigma2 frontend code is based on the Python Script language with a PVR backend software for tuning and recording written in C++ programming language. The PVR backend side uses the [http://www.linuxtv.org LinuxTV DVB API], which is part of a standard Linux kernel.<section end="intro" />
Enigma2 frontend code is based on the Python Script language with a PVR backend software for tuning and recording written in C++ programming language. The PVR backend side uses the [http://www.linuxtv.org LinuxTV DVB API], which is part of a standard Linux kernel.<section end="intro" />


== VU+ Client unofficial PVR add-on (C/C++ based)==
== Enigma2 Client PVR add-on (C/C++ based)==
{{main|Add-on:Enigma2_Client}}
{{main|Add-on:Enigma2_Client}}


The VU+ Client PVR addon is a unofficial native PVR client made by the Kodi community for all Enigma2 based set-top boxes. This unofficial PVR C/C++ binary addon for Enigma2 is an [https://github.com/kodi-pvr/pvr.vuplus open source code] community project.
The Enigma2 Client PVR add-on is a native PVR client made by the Kodi community for all Enigma2 based set-top boxes. This PVR C/C++ binary add-on for Enigma2 is an [https://github.com/kodi-pvr/pvr.vuplus open source code] community project.


=== Connecting Kodi to a Enigma2 box ===
=== Connecting Kodi to a Enigma2 box ===
{{PVR repo notice}}
{{PVR repo notice}}
# Go to {{highlight|Settings -> Add-ons -> Enabled add-ons -> PVR Clients}} and select the VuPlus PVR add-on
# Go to {{highlight|Settings -> Add-ons -> Enabled add-ons -> PVR Clients}} and select the Enigma2 PVR add-on
# Select "Configure"
# Select "Configure"


=== Setting up the VuPlus addon===
=== Setting up the Enigma2 add-on===


=== Supported settop boxes ===
=== Supported set top boxes ===
In general all Enigma2 based settop boxes should be supported, the following are known to work. If you can confirm that the addon works with a settop box not listed below, please take a moment and post this into the PVR support forum thread for this addon.
In general all Enigma2 based set top boxes should be supported, once they run OpenWebIf (full feature set) or a different WebIf (original feature set only).


Known to work:
Some features that may not work on other WebIfs:
* VU+Uno
 
* VU+Duo
* Autotimers
* VU+Ultimo
* Drive Space Reporting
* DM800 HD (with Gemini image & OpenPLI)
* Embedded EPG Genre IDs
* DM8000 (OpenPLI image)
* Full Tuner Signal Support (Including Service Providers)
* Timer and Recording descriptions: If your provider only uses short description (plot outline) instead of long description (plot) then info will not be displayed pertaining to the shows in question. For OpenWebIf clients a JSON API is available to populate the missing data.
* Edit recording name, last played position and play count for recordings
* Bouquet (and group specific) Backend Channel Numbers


=== Support ===
=== Support ===
If you have problems using this addon you should try and contact the author via the Kodi [http://forum.kodi.tv/forumdisplay.php?fid=167 PVR Support forum].
If you have problems using this add-on you should try and contact the author via the Kodi [http://forum.kodi.tv/forumdisplay.php?fid=226 Enigma2 PVR Support forum].


== Connecting Kodi to VUPlus ==
== Connecting Kodi to Enigma2 backend ==
{{PVR repo notice}}
{{PVR repo notice}}
# Go to {{highlight|Settings -> Add-ons -> Enabled add-ons -> PVR Clients}} and select the VUPlus add-on
# Go to {{highlight|Settings -> Add-ons -> Enabled add-ons -> PVR Clients}} and select the Enigma2 add-on
# Select "Configure"
# Select "Configure"


<section begin="Settings" />
=== General ===
=== General ===


Within this tab the mandatory addon options need to be configured before it can be successfully enabled.
Within this tab the mandatory add-on options need to be configured before it can be successfully enabled. If your device is using a default setup on your local network only the following setting should need to be changed.
 
* '''VU+ hostname or IP address''': Please enter the IP address or hostname of your enigma2 based settop box.
* '''Icon Path''': In order to have Kodi display channel logos you have to copy the picons from your settop box onto your OpenELEC machine. You then need to specify this path in this property.
* '''Update Interval in minutes''': As the settop box can also be used to modify timers, delete recordings etc. and the settop box does not notify the Kodi installation, the addon needs to regularly check for updates (new channels, new/changed/deletes timers, deleted recordings, etc.) This property defines how often the addon checks for updates.
{{-}}
 
=== Channels ===
 
Within this tab options that refer to channel data can be set.
 
* '''Folder for channeldata''': Retrieving the channel data from the backend can take quite long. To avoid that the user has to wait a long time before the addon starts it stores the information about the available channels in a separate XML file. Instead of quering the backend the addon then tries to load the channels from this XML file during addon startup. This property defines into which directory this XML file will be put. The filename is "channeldata.xml". Also, the last played position of the recordings will be saved into this directory, so that the user can resume the playback of a previously stopped recording. The recording data is stored into the file "recordings.xml".
* '''Fetch only one TV bouquet''': If this option is set than only the channels that are in one specified TV bouquet will be loaded, instead of fetching all available channels in all available bouquets.
* '''TV-Bouquet''': If the previous option has been enabled you need to specify the TV bouquet to be fetched from the settop box. Please not that this is the bouquet-name as shown on the settop box (i.e. "Favourites (TV)"). This setting is case-sensitive.
* '''Check for bouquet updates''': If this option is set the addon will check for bouquet updates after the initial addon startup. If this option is disabled it will only use the bouquets stored in the channeldata.xml file.
* '''Check for channel updates''': If this option is set the addon will check for channel updates after the initial addon startup. If this option is disabled it will only use the channels stored in the channeldata.xml file.
* '''Zap before channelswitch (i.e. for Single Tuner boxes)''': When using the addon with a single tuner box it may be necessary that the addon needs to be able to zap to another channel on the settop box. If this option is enabled each channel switch in Kodi will also result in a channel switch on the settop box. Please note that "allow channel switching" needs to be enabled in the webinterface on the settop box.
{{-}}
 
=== Advanced ===
 
Within this tab more uncommon and advanced options can be configured.
 
* '''Streaming Port''': This option defines the streaming port the settop box uses to stream live tv. The default is 8001 which should be fine if the user did not define a custom port within the webinterface.
* '''Webinterface Port''': This option defines the port that should be used to access the webinterface of the settop box.
* '''Username''': If the webinterface of the settop box is protected with a username / password combination this needs to be set in this option.
* '''Password''': If the webinterface of the settop box is protected with a username / password combination this needs to be set in this option.
* '''Recording folder on receiver''': Per default the addon does not specify the recording folder in newly created timers, so the default set in the settop box will be used. If you want to specify a different folder (i.e. because you want all recordings scheduled via Kodi to be stored in a separate folder), then you need to set this option.
* '''Use only the DVB boxes' current recording path''': If this option is not set the addon will fetch all available recordings from all configured pathes from the settop box. If this option is set then it will only list recordings that are stored within the "current recording path" on the settop box.
* '''Automatic Timerlist Cleanup''': If this option is set then the addon will send the command to delete completed timers from the settop box after each update interval.
* '''Send DeepStandby-Command''': If this option is set then the addon will send the DeepStandby-Command to the settop box when Kodi will be closed (or the addon will be deactivated), causing the settop box to shutdown into DeepStandby.
{{-}}
<section end="Settings" />


* '''Enigma2 hostname or IP address''': Please enter the IP address or hostname of your enigma2 based set top box.


 
For all other settings please see [https://github.com/kodi-pvr/pvr.vuplus#configuring-the-addon Configuring the addon]
<!--Keep at bottom of this section--><!--Keep at bottom of this section-->


== Changelog ==
== Changelog ==
{{hidden|Change log|
{{hidden|Change log|
0.3.4:
:* fix: several crashes on win32 due to missing locks / invalid memory access
:* fix: do not report connection problems when there is an empty TV-channel bouquet
0.3.3:
:* add: support for storing the last played positions for recordings. These will be stored in the file recordings.xml
:* fix: if the webinterface cannot be loaded, deactivate the addon
0.3.2:
:* fix: continue to load channels even if we do not have any radio channels
0.3.1:
:* change: remove XMLParser- change: add enigma2 to the displayname 
0.3.0:
:* change: remove curl dependancy
:* change: adjust to new PVR API
0.2.8:
:* add: option to only fetch one TV bouquet which can be specified via the addon settings
0.2.7:
:* fix: fix incorrect escape character for & (use '&amp;' instead of '"'). Thx to 'hani' for pointing this out.
0.2.6:
:* cosmetic: remove unnecessary '/' in recording-stream url
:* cosmetic: inprove log output- change: get the proper device info from the reveiver box instead of just setting dummy values
:* change: change the buildzip.bat to include version string in the name of the zip-file
:* change: introduce a version string for the channeldata xml file so that we can invalidate old channeldata files if necessary
0.2.5:
:* fix: cleanup the service reference in the streaming url
0.2.4
:* fix: put username & password into the streaming url0.2.3
:* fix: put username & password into recording-url
0.2.2:
:* fix: escape xml entities in the stream-url before saving to channeldata.xml
:* fix: fetch the version string from configure.in not the ChangeLog (thanks to 'trans')
:* fix: rename changelog in addon-directory to changelog.txt
0.2.1:
:* fix: encode the stream-url properly. Please remove your channeldata.xml file after updating
:* change: add proper version string to the addon.xml generated by buildzip.bat (thanks to 'trans')
0.2.0:
:* change: Complete rework of timer handling. Now it will only show notifications for changed items
:* fix: Update / Add / Delete Timers. Note that the timer names in the Kodi are sometimes not updated properly (in the dialog it is OK)
:* fix: Instant Recordings do now work again- fix: timer status is now shown correctly (completed, recording, disabled)
:* fix: enabling / disabling timers do now work- change: removed "show completed timers" option (they are now always be shown)
:* add: added buildzip.bat & xbmc-addon-vuplus.sln (thanks to 'trans')
:* fix: Channel numbering / incorrect picons due to the change introduced in 0.1.15
0.1.15
:* fix: when using the channeldata-store option not all channel groups (bouquets) were loaded due to a nulled counter variable
0.1.14
:* change: change .gitignores and copy current changelog into the addon folder. This will enable the user to view the changelog in the addon settings window
0.1.13
:* add: option to set deepstandby powerstate on the DVB box on PVR-addon shutdown
:* fix: error in settings.xml, causing crashes on linux
0.1.12
:* add: support to specify the folder for storing recordings
0.1.11
:* fix: some unicode string errors in german language file
:* change: add categories to addon settings0.1.10
:* add: support for using only the recording path currently active on the DVB box
0.1.9
:* change: add addon icon (copyied from the openelec guys, thanks!)
:* fix: win32 release target (thanks to 'trans' for patch)
0.1.8
:* change: fetch the recording locations and use these locations when querying the recordings
:* fix: Stop update thread when destroying the PVR addon - fixes shutdown issues
0.1.7
:* fix: Copy & Paste error                       
0.1.6
:* fix: Change the logic to determine the picon file name from the service reference.
0.1.5
:* fix: Fix access violation errors on windows (thanks to 'trans' for finding the correct compiler / linker settings)
:* fix: do not return out of scope local variable for the streaming URL
:* fix: remove the last '_' character from the filename (if applicable). Should finally fix the picon path errors.
0.1.4
:* fix: limit length of the service reference part of the Icon-Path to 30 characters.
:* fix: Escape "&", "<" and ">" characters in XML channeldata file.
:* add: support to disable all bouquet or channel updates
0.1.3
:* fix: order of timerlist cleanup and timerlist updates
0.1.2
:* add: support for storing channel data into a file
0.1.1
:* fix: URLEncode the service reference when fetching EPG


0.1.0
* [https://github.com/kodi-pvr/pvr.vuplus/blob/Matrix/pvr.vuplus/changelog.txt Enigma2 PVR changelog]
:* Iniital Version
}}


== Additional guides and links ==
== Additional guides and links ==
* VU+ website - http://vuplus.com
* [http://forum.kodi.tv/forumdisplay.php?fid=226 Enigma2 PVR for Kodi support forum]
** [http://www2.vuplus.com/manual Documentation]
* Backend for Kodi support forum - http://forum.kodi.tv/forumdisplay.php?fid=173


[[Category:PVR|*]]
[[Category:PVR|*]]

Revision as of 11:38, 26 November 2020

Live TV, PVR & Radio Contents

PVR main page

1. Tuner Cards
2. Backends
3. Setup
4. Live TV Artwork

Related Pages:

All PVR Pages
All PVR Add-on Pages

Home icon grey.png   ▶ PVR ▶ Enigma2 Backend

Enigma2 is a framebuffer-based zapping application (GUI) that is primarily targeted to physical set-top-boxes running embedded Linux (OpenEmbedded based firmware distributions), however Enigma2 can technically also run on regular PCs, but it is not common.

While the Enigma2 software was originally developed by Dream Multimedia for their Dreambox series, the opendreambox.org has made Enigma2 into an popular open source based firmware platform for set-top boxes and it is used by a number of different set-top box manufacturers, including the most commonly known are Dreambox, DBox2, and Vu+ (VuPlus), which all use Enigma2 based firmware images. Most of these Enigma2 based set-top boxes falls under the category of Linux-powered satellite, terrestrial and cable digital television receivers.

With the Enigma2 PVR add-on Kodi PVR can be used also with any Enigma2 based set-top boxes running OpenWebIf. Other WebIfs are supported with a subset of the original functionality.


1 Enigma2 technical overview

Enigma2 frontend code is based on the Python Script language with a PVR backend software for tuning and recording written in C++ programming language. The PVR backend side uses the LinuxTV DVB API, which is part of a standard Linux kernel.

2 Enigma2 Client PVR add-on (C/C++ based)

The Enigma2 Client PVR add-on is a native PVR client made by the Kodi community for all Enigma2 based set-top boxes. This PVR C/C++ binary add-on for Enigma2 is an open source code community project.

2.1 Connecting Kodi to a Enigma2 box

Template:PVR repo notice

  1. Go to Settings -> Add-ons -> Enabled add-ons -> PVR Clients and select the Enigma2 PVR add-on
  2. Select "Configure"

2.2 Setting up the Enigma2 add-on

2.3 Supported set top boxes

In general all Enigma2 based set top boxes should be supported, once they run OpenWebIf (full feature set) or a different WebIf (original feature set only).

Some features that may not work on other WebIfs:

  • Autotimers
  • Drive Space Reporting
  • Embedded EPG Genre IDs
  • Full Tuner Signal Support (Including Service Providers)
  • Timer and Recording descriptions: If your provider only uses short description (plot outline) instead of long description (plot) then info will not be displayed pertaining to the shows in question. For OpenWebIf clients a JSON API is available to populate the missing data.
  • Edit recording name, last played position and play count for recordings
  • Bouquet (and group specific) Backend Channel Numbers

2.4 Support

If you have problems using this add-on you should try and contact the author via the Kodi Enigma2 PVR Support forum.

3 Connecting Kodi to Enigma2 backend

Template:PVR repo notice

  1. Go to Settings -> Add-ons -> Enabled add-ons -> PVR Clients and select the Enigma2 add-on
  2. Select "Configure"

3.1 General

Within this tab the mandatory add-on options need to be configured before it can be successfully enabled. If your device is using a default setup on your local network only the following setting should need to be changed.

  • Enigma2 hostname or IP address: Please enter the IP address or hostname of your enigma2 based set top box.

For all other settings please see Configuring the addon

4 Changelog

{{hidden|Change log|

5 Additional guides and links