media.controllers package

Submodules

media.controllers.brightnesscontroller module

Controller for Media output brightness requests

class media.controllers.brightnesscontroller.BrightnessController(manager: MediaManager)

Bases: Controller

Controller for brightness requests

add_rules(app)

Add brightness rule at /brightness uri

brightness()

Callback for brightness request

get_brightness()

Get the current service output brightness

Returns:

json string representing the current brightness

Return type:

str

put_brightness()

Set given brightness to service output stream

Returns:

json string with the command status

Return type:

str

media.controllers.configurationcontroller module

Controller for Media configuration requests

class media.controllers.configurationcontroller.ConfigurationController(manager: MediaManager)

Bases: Controller

Controller for configuration requests

add_rules(app)

Add configuration rule at /configuration uri

configuration()

Callback for configuration request

get_configuration()

Get the current service configuration

Returns:

json string representing the current configuration

Return type:

str

put_configuration()

Set given configuration to service

Returns:

json string with the command status

Return type:

str

media.controllers.controller module

Base controller

class media.controllers.controller.Controller

Bases: ABC

Flask server method controller

abstractmethod add_rules(app)

Add rules to flask server

response(data, code: int = 200, mimetype: str = 'application/json')

Builds and returns Response for a request

Parameters:
  • data – the data to be sent

  • code (int, optional) – HTTPStatus code. Defaults to 200.

  • mimetype (str, optional) – Response mimetype. Defaults to “application/json”.

Returns:

A Flask Response object with the given data.

Return type:

Flask.Response

Module contents