Controller

enigma2_http_api.controller.ENIGMA2_URL_FMT = '{scheme}://{remote_addr}/{path}'

enigma2 web interface URL format string

class enigma2_http_api.controller.Enigma2APIController(*args, **kwargs)[source]

Enigma2 Web API Consuming Controller Class

get_about()[source]

Retrieve information about enigma2 device.

Returns:Enigma2 device information
Return type:dict
get_epgbouquet(bouquet_ref, filter_func=None)[source]

Get EPG datasets for bouquet_ref. (currently running subservices’ EPG datasets)

Parameters:
  • bouquet_ref – bouquet reference
  • filter_func – filter function
Returns:

EPG datasets of current subservice
Return type:

list
get_epgservice(service_ref, filter_func=None)[source]

Get EPG datasets for service_ref.

Parameters:
  • service_ref – service reference
  • filter_func – filter function
Returns:

EPG datasets of given service
Return type:

list
get_getallservices()[source]

Get all services.

Returns:
get_message(messagetext, timeout=10, messagetype=1)[source]

Display a message on enigma2’s attached screen.

Parameters:
  • messagetext – message
  • timeout – timeout
  • messagetype – message type
Returns:
get_messageanswer(messagetext, timeout=10)[source]

Display a message and wait for user selection. (SEEMS TO BE NON-WORKING)

Parameters:
  • messagetext – message
  • timeout – timeout
Returns:
get_moviedelete(service_ref)[source]

Delete a movie item.

Parameters:service_ref – service reference
Returns:
get_movielist()[source]

Get list of movie items available on self.remote_addr.

Returns:
get_powerstate(new_state)[source]

Change Power State

Parameters:new_state – Desired Power State
Returns:

Search EPG for what. Will filter results if filter_func is given.

Parameters:
  • what – Search string
  • filter_func – result filtering function
Returns:
get_services()[source]

Get services (bouquets).

Returns:list containing service name and reference
Return type:list
get_subservices()[source]

Get subservices for current service

Returns:subservices of current service
Return type:list
get_timeradd(service_ref, params)[source]

Add a new timer

/web/timeradd?sRef=&repeated=&begin=&end=&name=&description=&dirname=&tags=&eit=&disabled=&justplay=&afterevent=

Parameters:
  • service_ref – service reference
  • params – timer parameters
Returns:
get_timeraddbyeventid(service_ref, event_id)[source]

Add a new timer by ID.

Parameters:
  • service_ref – service reference
  • event_id – ID of the event to be recorded
Returns:
get_timerdelete(service_ref, begin, end)[source]

Delete an existing timer.

Parameters:
  • service_ref – service reference
  • begin – start time
  • end – end time
Returns:
get_timerlist()[source]

Get list of timers.

Returns:
get_zap(service_ref)[source]

Try to zap to given service.

Parameters:service_ref – service reference
Returns:
update_movielist_map()[source]

Update internal movie list map self.movielist_map by retrieving the current list of movie items on Enigma2 box.