Enigma2 WebInterface API

class controllers.web.WebController(session, path='')[source]

Controller implementing Enigma2 WebInterface API as described in e.g. https://dream.reichholf.net/e2web/.

P_about(request)[source]

Request handler for the about endpoint.

See also

https://dream.reichholf.net/e2web/#about

Parameters:request (twisted.web.server.Request) – HTTP request object
Returns:HTTP response with headers
P_addlocation(request)[source]

Request handler for the addlocation endpoint. Add a path to the list of paths where video files are stored.

See also

https://dream.reichholf.net/e2web/#addlocation

Parameters:request (twisted.web.server.Request) – HTTP request object
Returns:HTTP response with headers
P_bouquets(request)[source]

Request handler for the boquets endpoint. Get list of tuples (bouquet reference, bouquet name) for available bouquets.

Note

Not available in Enigma2 WebInterface API.

Parameters:request (twisted.web.server.Request) – HTTP request object
Returns:HTTP response with headers
P_currenttime(request)[source]

Request handler for the currenttime endpoint.

See also

https://dream.reichholf.net/e2web/#currenttime

Parameters:request (twisted.web.server.Request) – HTTP request object
Returns:HTTP response with headers
P_deviceinfo(request)[source]

Request handler for the deviceinfo endpoint.

See also

https://dream.reichholf.net/e2web/#deviceinfo

Parameters:request (twisted.web.server.Request) – HTTP request object
Returns:HTTP response with headers
P_epgmulti(request)[source]

Request handler for the epgmulti endpoint.

Note

Not available in Enigma2 WebInterface API.

Parameters:request (twisted.web.server.Request) – HTTP request object
Returns:HTTP response with headers
P_epgmultigz(request)[source]

Request handler for the epgmultigz endpoint.

Note

Not available in Enigma2 WebInterface API.

Parameters:request (twisted.web.server.Request) – HTTP request object
Returns:HTTP response with headers
P_epgsearch(request)[source]

EPG event search and lookup handler.

Note

One may use controllers.events.EventsController.lookup_event() for looking up events. One may use controllers.events.EventsController.search() for searching events.

See also

https://dream.reichholf.net/e2web/#epgsearch

Deprecated since version 0.34: This implementation cowardly mixes search and lookup. Lookup feature is not available in Enigma2 WebInterface API thus this crap will be removed some day :)

Parameters:request (twisted.web.server.Request) – HTTP request object
Returns:HTTP response with headers
P_external(request)[source]

Request handler for the external endpoint.

See also

https://dream.reichholf.net/e2web/#external

Parameters:request (twisted.web.server.Request) – HTTP request object
Returns:HTTP response with headers
P_getallservices(request)[source]

Request handler for the getallservices endpoint. Retrieve list of services in bouquets.

See also

https://dream.reichholf.net/e2web/#getallservices

Parameters:request (twisted.web.server.Request) – HTTP request object
Returns:HTTP response with headers
P_getaudiotracks(request)[source]

Request handler for the /getaudiotracks endpoint.

See also

https://dream.reichholf.net/e2web/#getaudiotracks

Parameters:request (twisted.web.server.Request) – HTTP request object
Returns:HTTP response with headers
P_getcurrent(request)[source]

Request handler for the getcurrent endpoint.

See also

https://dream.reichholf.net/e2web/#getcurrent

Parameters:request (twisted.web.server.Request) – HTTP request object
Returns:HTTP response with headers
GET /web/getcurrent
P_getcurrlocation(request)[source]

Request handler for the getcurrlocation endpoint. Get currently selected path where video files are to be stored.

See also

https://dream.reichholf.net/e2web/#getcurrlocation

Parameters:request (twisted.web.server.Request) – HTTP request object
Returns:HTTP response with headers
P_getlocations(request)[source]

Request handler for the getlocations endpoint. Retrieve paths where video files are stored.

See also

https://dream.reichholf.net/e2web/#getlocations

Parameters:request (twisted.web.server.Request) – HTTP request object
Returns:HTTP response with headers
P_getpid(request)[source]

Request handler for the getpid endpoint.

See also

https://dream.reichholf.net/e2web/#getpid

Parameters:request (twisted.web.server.Request) – HTTP request object
Returns:HTTP response with headers
P_getservices(request)[source]

Request handler for the getservices endpoint. Retrieve list of bouquets.

See also

https://dream.reichholf.net/e2web/#getservices

Parameters:request (twisted.web.server.Request) – HTTP request object
Returns:HTTP response with headers
P_getsubtitles(request)[source]

Request handler for the getsubtitles endpoint.

Note

Not available in Enigma2 WebInterface API.

Parameters:request (twisted.web.server.Request) – HTTP request object
Returns:HTTP response with headers
P_gettags(request)[source]

Request handler for the gettags endpoint. Get tags of movie file (?).

See also

https://dream.reichholf.net/e2web/#gettags

Parameters:request (twisted.web.server.Request) – HTTP request object
Returns:HTTP response with headers
P_loadepg(request)[source]

Request handler for the loadepg endpoint.

Note

Not available in Enigma2 WebInterface API.

Parameters:request (twisted.web.server.Request) – HTTP request object
Returns:HTTP response with headers
P_message(request)[source]

Request handler for the message endpoint. Display a message on the screen attached to enigma2 device.

See also

https://dream.reichholf.net/e2web/#message

Parameters:request (twisted.web.server.Request) – HTTP request object
Returns:HTTP response with headers
P_messageanswer(request)[source]

Request handler for the messageanswer endpoint.

See also

https://dream.reichholf.net/e2web/#messageanswer

Parameters:request (twisted.web.server.Request) – HTTP request object
Returns:HTTP response with headers
P_moviedelete(request)[source]

Request handler for the moviedelete endpoint. Delete movie file.

See also

https://dream.reichholf.net/e2web/#moviedelete

Parameters:request (twisted.web.server.Request) – HTTP request object
Returns:HTTP response with headers
P_movielist(request)[source]

Request handler for the movielist endpoint. Retrieve list of movie items. (alternative implementation)

See also

https://dream.reichholf.net/e2web/#movielist

Parameters:request (twisted.web.server.Request) – HTTP request object
Returns:HTTP response with headers
P_movielisthtml(request)[source]

Request handler for the movielisthtml endpoint. Retrieve list of movie items in HTML format.

See also

https://dream.reichholf.net/e2web/#movielist.html

Parameters:request (twisted.web.server.Request) – HTTP request object
Returns:HTTP response with headers
P_movielistm3u(request)[source]

Request handler for the movielistm3u endpoint. Retrieve list of movie items in M3U format.

See also

https://dream.reichholf.net/e2web/#movielist.m3u

Parameters:request (twisted.web.server.Request) – HTTP request object
Returns:HTTP response with headers
P_movielistrss(request)[source]

Request handler for the movielistrss endpoint. Retrieve list of movie items in RSS format.

See also

https://dream.reichholf.net/e2web/#movielist.rss

Parameters:request (twisted.web.server.Request) – HTTP request object
Returns:HTTP response with headers
P_moviemove(request)[source]

Request handler for the moviemove endpoint. Move movie file.

See also

https://dream.reichholf.net/e2web/#moviemove

Parameters:request (twisted.web.server.Request) – HTTP request object
Returns:HTTP response with headers
P_movierename(request)[source]

Request handler for the movierename endpoint. Rename movie file.

See also

https://dream.reichholf.net/e2web/#movierename

Parameters:request (twisted.web.server.Request) – HTTP request object
Returns:HTTP response with headers
P_movietags(request)[source]

Request handler for the movietags endpoint. Add/Remove tags to movie file.

See also

https://dream.reichholf.net/e2web/#movietags

Parameters:request (twisted.web.server.Request) – HTTP request object
Returns:HTTP response with headers
P_parentcontrollist(request)[source]

Request handler for the parentcontrollist endpoint.

See also

https://dream.reichholf.net/e2web/#parentcontrollist

Parameters:request (twisted.web.server.Request) – HTTP request object
Returns:HTTP response with headers
P_pluginlistread(request)[source]

Request handler for the pluginlistread endpoint.

See also

https://dream.reichholf.net/e2web/#pluginlistread

Parameters:request (twisted.web.server.Request) – HTTP request object
Returns:HTTP response with headers
P_powerstate(request)[source]

Request handler for the powerstate endpoint. Get/set power state of enigma2 device.

See also

https://dream.reichholf.net/e2web/#powerstate

Parameters:request (twisted.web.server.Request) – HTTP request object
Returns:HTTP response with headers
P_recordnow(request)[source]

Request handler for the recordnow endpoint.

See also

https://dream.reichholf.net/e2web/#recordnow

Parameters:request (twisted.web.server.Request) – HTTP request object
Returns:HTTP response with headers
P_remotecontrol(request)[source]

Request handler for the remotecontrol endpoint. Send remote control codes.

See also

https://dream.reichholf.net/e2web/#remotecontrol

Parameters:request (twisted.web.server.Request) – HTTP request object
Returns:HTTP response with headers
P_removelocation(request)[source]

Request handler for the removelocation endpoint. Remove a path from the list of paths where video files are stored.

See also

https://dream.reichholf.net/e2web/#removelocation

Parameters:request (twisted.web.server.Request) – HTTP request object
Returns:HTTP response with headers
P_restarttwisted(request)[source]

Request handler for the restarttwisted endpoint.

See also

https://dream.reichholf.net/e2web/#restarttwisted

Parameters:request (twisted.web.server.Request) – HTTP request object
Returns:HTTP response with headers
P_saveconfig(request)[source]

Request handler for the saveconfig endpoint.

Note

Not available in Enigma2 WebInterface API.

Parameters:request (twisted.web.server.Request) – HTTP request object
Returns:HTTP response with headers
POST /web/saveconfig
Query Parameters:
 
  • key (string) – configuration key
  • value (string) – configuration value
P_saveepg(request)[source]

Request handler for the saveepg endpoint.

Note

Not available in Enigma2 WebInterface API.

Parameters:request (twisted.web.server.Request) – HTTP request object
Returns:HTTP response with headers
P_selectaudiotrack(request)[source]

Request handler for the /selectaudiotrack endpoint.

See also

https://dream.reichholf.net/e2web/#selectaudiotrack

Parameters:request (twisted.web.server.Request) – HTTP request object
Returns:HTTP response with headers
GET /web/signal
Query Parameters:
 
  • id (int) – audio track ID
P_servicelistplayable(request)[source]

Request handler for the servicelistplayable endpoint. Retrieve list of ‘playable’ bouquets.

See also

https://dream.reichholf.net/e2web/#servicelistplayable

Parameters:request (twisted.web.server.Request) – HTTP request object
Returns:HTTP response with headers
P_servicelistreload(request)[source]

Reload service lists, transponders, parental control black-/white lists or/and lamedb.

See also

https://dream.reichholf.net/e2web/#servicelistreload

Parameters:request (twisted.web.server.Request) – HTTP request object
Returns:HTTP response with headers
P_serviceplayable(request)[source]

Request handler for the serviceplayable endpoint. Check if referenced service is ‘playable’.

See also

https://dream.reichholf.net/e2web/#serviceplayable

Parameters:request (twisted.web.server.Request) – HTTP request object
Returns:HTTP response with headers
P_servicesm3u(request)[source]

Request handler for the servicesm3u endpoint. Retrieve list of bouquets(?) in M3U format.

See also

https://dream.reichholf.net/e2web/#services.m3u

Parameters:request (twisted.web.server.Request) – HTTP request object
Returns:HTTP response with headers
GET /web/services.m3u
Query Parameters:
 
  • bRef (string) – bouquet reference
P_set_powerup_without_waking_tv(request)[source]

Request handler for the set_powerup_without_waking_tv endpoint. Mark ‘powerup without waking TV’ being available.

Note

Not available in Enigma2 WebInterface API.

Deprecated since version 0.46: To be dropped.

Parameters:request (twisted.web.server.Request) – HTTP request object
Returns:HTTP response with headers
P_settings(request)[source]

Request handler for the settings endpoint. Retrieve list of key/kalue pairs of device configuration.

See also

https://dream.reichholf.net/e2web/#settings

Parameters:request (twisted.web.server.Request) – HTTP request object
Returns:HTTP response with headers
P_showchannelpicon(request)[source]

Request handler for the showchannelpicon endpoint.

Note

Not available in Enigma2 WebInterface API.

Deprecated since version 0.46: To be dropped.

Parameters:request (twisted.web.server.Request) – HTTP request object
Returns:HTTP response with headers
P_signal(request)[source]

Request handler for the tunersignal endpoint. Get tuner signal status(?)

See also

Probably https://dream.reichholf.net/e2web/#signal

Parameters:request (twisted.web.server.Request) – HTTP request object
Returns:HTTP response with headers
GET /web/signal
P_sleeptimer(request)[source]

Request handler for the sleeptimer endpoint.

See also

https://dream.reichholf.net/e2web/#sleeptimer

Parameters:request (twisted.web.server.Request) – HTTP request object
Returns:HTTP response with headers
GET /web/sleeptimer
Query Parameters:
 
  • cmd (string) – command (get or set)
  • time (int) – time in minutes (0 – 999)
  • action (string) – action (standby or shutdown)
  • enabled (string) – enabled (True or False)
  • confirmed (string) – confirmed (supported?)
P_streamcurrentm3u(request)[source]

Request handler for the streamcurrentm3u endpoint.

See also

https://dream.reichholf.net/e2web/#streamcurrent.m3u

Parameters:request (twisted.web.server.Request) – HTTP request object
Returns:HTTP response with headers
GET /web/streamcurrent.m3u
P_streamm3u(request)[source]

Request handler for the streamm3u endpoint.

See also

https://dream.reichholf.net/e2web/#stream.m3u

Note

Parameters Not available in Enigma2 WebInterface API.

Parameters:request (twisted.web.server.Request) – HTTP request object
Returns:HTTP response with headers
GET /web/stream.m3u
Query Parameters:
 
  • ref (string) – service reference
  • name (string) – service name
P_streamsubservices(request)[source]

Request handler for the streamsubservices endpoint.

See also

https://dream.reichholf.net/e2web/#streamsubservices

Parameters:request (twisted.web.server.Request) – HTTP request object
Returns:HTTP response with headers
GET /web/streamsubservices
Query Parameters:
 
  • sRef (string) – service reference
P_subservices(request)[source]

Request handler for the subservices endpoint.

See also

https://dream.reichholf.net/e2web/#subservices

Parameters:request (twisted.web.server.Request) – HTTP request object
Returns:HTTP response with headers
P_supports_powerup_without_waking_tv(request)[source]

Request handler for the supports_powerup_without_waking_tv endpoint. Check if ‘powerup without waking TV’ is available.

Note

Not available in Enigma2 WebInterface API.

Deprecated since version 0.46: To be dropped.

Parameters:request (twisted.web.server.Request) – HTTP request object
Returns:HTTP response with headers
P_timeradd(request)[source]

Request handler for the timeradd endpoint. Add timer

See also

https://dream.reichholf.net/e2web/#timeradd

Parameters:request (twisted.web.server.Request) – HTTP request object
Returns:HTTP response with headers
P_timeraddbyeventid(request)[source]

Request handler for the timeraddbyeventid endpoint. Add timer by event ID

See also

https://dream.reichholf.net/e2web/#timeraddbyeventid

Parameters:request (twisted.web.server.Request) – HTTP request object
Returns:HTTP response with headers
GET /web/timeraddbyeventid
Query Parameters:
 
  • sRef (string) – service reference
  • eventid (int) – Event ID
  • justplay (int) – Just Play indicator
  • dirname (string) – target path(?)
  • tags (string) – tags to add(?)
  • always_zap (int) – always zap first(?)
P_timerchange(request)[source]

Request handler for the timerchange endpoint. Change timer

See also

https://dream.reichholf.net/e2web/#timerchange

Parameters:request (twisted.web.server.Request) – HTTP request object
Returns:HTTP response with headers
GET /web/timerchange
Query Parameters:
 
  • sRef (string) – service reference
  • begin (int) – begin timestamp
  • end (int) – end timestamp
  • name (string) – name
  • description (string) – description
  • channelOld (string) – old channel(?)
  • beginOld (int) – old begin timestamp(?)
  • endOld (int) – old end timestamp(?)
  • justplay (int) – Just Play indicator
  • dirname (string) – target path(?)
  • tags (string) – tags to add(?)
  • always_zap (int) – always zap first(?)
  • disabled (int) – disabled state
  • afterevent (int) – afterevent state
P_timercleanup(request)[source]

Request handler for the timercleanup endpoint.

See also

https://dream.reichholf.net/e2web/#timercleanup

Parameters:request (twisted.web.server.Request) – HTTP request object
Returns:HTTP response with headers
P_timerdelete(request)[source]

Request handler for the timerdelete endpoint. Delete timer

See also

https://dream.reichholf.net/e2web/#timerdelete

Parameters:request (twisted.web.server.Request) – HTTP request object
Returns:HTTP response with headers
P_timerlist(request)[source]

Request handler for the timerlist endpoint. Retrieve list of timers.

See also

https://dream.reichholf.net/e2web/#timerlist

Parameters:request (twisted.web.server.Request) – HTTP request object
Returns:HTTP response with headers
P_timerlistwrite(request)[source]

Request handler for the timerlistwrite endpoint.

See also

https://dream.reichholf.net/e2web/#timerlistwrite

Parameters:request (twisted.web.server.Request) – HTTP request object
Returns:HTTP response with headers
P_timertogglestatus(request)[source]

Request handler for the timertogglestatus endpoint.

Note

Not available in Enigma2 WebInterface API.

Parameters:request (twisted.web.server.Request) – HTTP request object
Returns:HTTP response with headers
P_tsm3u(request)[source]

Request handler for the tsm3u endpoint.

See also

https://dream.reichholf.net/e2web/#ts.m3u

Parameters:request (twisted.web.server.Request) – HTTP request object
Returns:HTTP response with headers
GET /web/ts.m3u
P_tsstart(request)[source]

Request handler for the tsstart endpoint. Start timeshift (?).

Note

Not available in Enigma2 WebInterface API.

Parameters:request (twisted.web.server.Request) – HTTP request object
Returns:HTTP response with headers
P_tsstate(request, success=True)[source]

Request handler for the tsstate endpoint. Retrieve timeshift status(?).

Note

Not available in Enigma2 WebInterface API.

Parameters:request (twisted.web.server.Request) – HTTP request object
Returns:HTTP response with headers
P_tsstop(request)[source]

Request handler for the tsstop endpoint. Stop timeshift (?).

Note

Not available in Enigma2 WebInterface API.

TODO: improve after action / save , save+record , nothing config.timeshift.favoriteSaveAction ….

Parameters:request (twisted.web.server.Request) – HTTP request object
Returns:HTTP response with headers
P_tvbrowser(request)[source]

Request handler for the tvbrowser endpoint.

See also

https://dream.reichholf.net/e2web/#tvbrowser

Parameters:request (twisted.web.server.Request) – HTTP request object
Returns:HTTP response with headers
P_vol(request)[source]

Request handler for the vol endpoint. Get/Set current volume setting.

See also

https://dream.reichholf.net/e2web/#vol

Parameters:request (twisted.web.server.Request) – HTTP request object
Returns:HTTP response with headers
P_vpschannels(request)[source]

Request handler for the vpschannels endpoint.

Note

Not available in Enigma2 WebInterface API.

Deprecated since version 0.46: To be dropped.

Parameters:request (twisted.web.server.Request) – HTTP request object
Returns:HTTP response with headers
P_zap(request)[source]

Request handler for the /zap endpoint. Zap to requested service_reference.

See also

https://dream.reichholf.net/e2web/#zap

Parameters:request (twisted.web.server.Request) – HTTP request object
Returns:HTTP response with headers
GET /web/services.m3u
Query Parameters:
 
  • sRef (string) – service reference
  • title (string) – service title
P_zapstream(request)[source]

Request handler for the zapstream endpoint.

Note

Not available in Enigma2 WebInterface API.

Parameters:request (twisted.web.server.Request) – HTTP request object
Returns:HTTP response with headers
vpsparams(request)[source]

VPS related helper function(?)

Parameters:request (twisted.web.server.Request) – HTTP request object
Returns:HTTP response with headers
controllers.web.get_recordings(encoding=None)[source]

Retrieve a list of dict items containing recording’s information.

Parameters:encoding (basestring) – output encoding or None (default = utf-8)
Returns:movie items
Return type:list
controllers.web.get_recordings_m3u(request, encoding=None)[source]

Create M3U contents for serving recordings.

Returns:M3U contents