class platypush.backend.http.HttpBackend(port=8008, websocket_port=8009, bind_address='', disable_websocket=False, resource_dirs=None, ssl_cert=None, ssl_key=None, ssl_cafile=None, ssl_capath=None, maps=None, run_externally=False, uwsgi_args=None, **kwargs)[source]

The HTTP backend is a general-purpose web server.

Example configuration:

    # Default HTTP listen port
    port: 8008
    # Default websocket port
    websocket_port: 8009
    # External folders that will be exposed over `/resources/<name>`
        photos: /mnt/hd/photos
        videos: /mnt/hd/videos
        music: /mnt/hd/music

You can leverage this backend:

  • To execute Platypush commands via HTTP calls. In order to do so:

    • Register a user to Platypush through the web panel (usually served on http://host:8008/).

    • Generate a token for your user, either through the web panel (Settings -> Generate Token) or via API:

      curl -XPOST -H 'Content-Type: application/json' -d '
          "username": "$YOUR_USER",
          "password": "$YOUR_PASSWORD"
        }' http://host:8008/auth
    • Execute actions through the /execute endpoint:

      curl -XPOST -H 'Content-Type: application/json' -H "Authorization: Bearer $YOUR_TOKEN" -d '
          "type": "request",
          "action": "tts.say",
          "args": {
            "text": "This is a test"
        }' http://host:8008/execute
  • To interact with your system (and control plugins and backends) through the Platypush web panel, by default available on http://host:8008/. Any configured plugin that has an available panel plugin will be automatically added to the web panel.

  • To display a fullscreen dashboard with custom widgets.

    • Widgets are available as Vue.js components under platypush/backend/http/webapp/src/components/widgets.

    • Explore their options (some may require some plugins or backends to be configured in order to work) and create a new dashboard template under ~/.config/platypush/dashboards- e.g. main.xml:

          <!-- Display the following widgets on the same row. Each row consists of 12 columns.
               You can specify the width of each widget either through class name (e.g. col-6 means
               6 columns out of 12, e.g. half the size of the row) or inline style
               (e.g. `style="width: 50%"`). -->
              <!-- Show a calendar widget with the upcoming events. It requires the `calendar` plugin to
                   be enabled and configured. -->
              <Calendar class="col-6" />
              <!-- Show the current track and other playback info. It requires `music.mpd` plugin or any
                   other music plugin enabled. -->
              <Music class="col-3" />
              <!-- Show current date, time and weather.
                   It requires a `weather` plugin or backend enabled -->
              <DateTimeWeather class="col-3" />
          <!-- Display the following widgets on a second row -->
              <!-- Show a carousel of images from a local folder. For security reasons, the folder must be
                   explicitly exposed as an HTTP resource through the backend
                   `resource_dirs` attribute. -->
              <ImageCarousel class="col-6" img-dir="/mnt/hd/photos/carousel" />
              <!-- Show the news headlines parsed from a list of RSS feed and stored locally through the
                   `http.poll` backend -->
              <RssNews class="col-6" db="sqlite:////path/to/your/rss.db" />
    • The dashboard will be accessible under http://host:8008/dashboard/<name>, where name=main if for example you stored your template under ~/.config/platypush/dashboards/main.xml.

  • To expose custom endpoints that can be called as web hooks by other applications and run some custom logic. All you have to do in this case is to create a hook on a platypush.message.event.http.hook.WebhookEvent with the endpoint that you want to expose and store it under e.g. ~/.config/platypush/scripts/

    from platypush.context import get_plugin
    from platypush.event.hook import hook
    from platypush.message.event.http.hook import WebhookEvent
    hook_token = 'abcdefabcdef'
    # Expose the hook under the /hook/lights_toggle endpoint
    @hook(WebhookEvent, hook='lights_toggle')
    def lights_toggle(event, **context):
        # Do any checks on the request
        assert event.headers.get('X-Token') == hook_token, 'Unauthorized'
        # Run some actions
        lights = get_plugin('light.hue')

Any plugin can register custom routes under platypush/backend/http/app/routes/plugins. Any additional route is managed as a Flask blueprint template and the .py module can expose lists of routes to the main webapp through the __routes__ object (a list of Flask blueprints).

Security: Access to the endpoints requires at least one user to be registered. Access to the endpoints is regulated in the following ways (with the exception of event hooks, whose logic is up to the user):

  • Simple authentication - i.e. registered username and password.

  • JWT token provided either over as Authorization: Bearer header or GET ?token=<TOKEN> parameter. A JWT token can be generated either through the web panel or over the /auth endpoint.

  • Global platform token, usually configured on the root of the config.yaml as token: <VALUE>. It can provided either over on the X-Token header or as a GET ?token=<TOKEN> parameter.

  • Session token, generated upon login, it can be used to authenticate requests through the Cookie header (cookie name: session_token).


  • gunicorn (pip install gunicorn) - optional, to run the Platypush webapp over uWSGI.

By default the Platypush web server will run in a process spawned on the fly by the HTTP backend. However, being a Flask app, it will serve clients in a single thread and it won’t support many features of a full-blown web server. gunicorn allows you to easily spawn the web server in a uWSGI wrapper, separate from the main Platypush daemon, and the uWSGI layer can be easily exposed over an nginx/lighttpd web server.

Command to run the web server over a gunicorn uWSGI wrapper:

gunicorn -w <n_workers> -b <bind_address>:8008 platypush.backend.http.uwsgi
__init__(port=8008, websocket_port=8009, bind_address='', disable_websocket=False, resource_dirs=None, ssl_cert=None, ssl_key=None, ssl_cafile=None, ssl_capath=None, maps=None, run_externally=False, uwsgi_args=None, **kwargs)[source]
  • port (int) – Listen port for the web server (default: 8008)

  • websocket_port (int) – Listen port for the websocket server (default: 8009)

  • bind_address (str) – Address/interface to bind to (default:, accept connection from any IP)

  • disable_websocket (bool) – Disable the websocket interface (default: False)

  • ssl_cert (str) – Set it to the path of your certificate file if you want to enable HTTPS (default: None)

  • ssl_key (str) – Set it to the path of your key file if you want to enable HTTPS (default: None)

  • ssl_cafile (str) – Set it to the path of your certificate authority file if you want to enable HTTPS (default: None)

  • ssl_capath (str) – Set it to the path of your certificate authority directory if you want to enable HTTPS (default: None)

  • resource_dirs (dict[str, str]) – Static resources directories that will be accessible through /resources/<path>. It is expressed as a map where the key is the relative path under /resources to expose and the value is the absolute path to expose.

  • run_externally (bool) – If set, then the HTTP backend will not directly spawn the web server. Set this option if you plan to run the webapp in a separate web server (recommended), like uwsgi or uwsgi+nginx.

  • uwsgi_args (list[str]) –

    If run_externally is set and you would like the HTTP backend to directly spawn and control the uWSGI application server instance, then pass the list of uWSGI arguments through this parameter. Some examples include:

    # Start uWSGI instance listening on HTTP port 8008 with 4
    # processes
    ['--plugin', 'python', '--http-socket', ':8008', '--master', '--processes', '4']
    # Start uWSGI instance listening on uWSGI socket on port 3031.
    # You can then use another full-blown web server, like nginx
    # or Apache, to communicate with the uWSGI instance
    ['--plugin', 'python', '--socket', '', '--master', '--processes', '4']

property daemon

A boolean value indicating whether this thread is a daemon thread.

This must be set before start() is called, otherwise RuntimeError is raised. Its initial value is inherited from the creating thread; the main thread is not a daemon thread and therefore all threads created in the main thread default to daemon = False.

The entire Python program exits when only daemon threads are left.


Return a string used for identification purposes only.

This method is deprecated, use the name attribute instead.

property ident

Thread identifier of this thread or None if it has not been started.

This is a nonzero integer. See the get_ident() function. Thread identifiers may be recycled when a thread exits and another thread is created. The identifier is available even after the thread has exited.


Return whether this thread is a daemon.

This method is deprecated, use the daemon attribute instead.


Return whether the thread is alive.

This method returns True just before the run() method starts until just after the run() method terminates. See also the module function enumerate().


Wait until the thread terminates.

This blocks the calling thread until the thread whose join() method is called terminates – either normally or through an unhandled exception or until the optional timeout occurs.

When the timeout argument is present and not None, it should be a floating point number specifying a timeout for the operation in seconds (or fractions thereof). As join() always returns None, you must call is_alive() after join() to decide whether a timeout happened – if the thread is still alive, the join() call timed out.

When the timeout argument is not present or None, the operation will block until the thread terminates.

A thread can be join()ed many times.

join() raises a RuntimeError if an attempt is made to join the current thread as that would cause a deadlock. It is also an error to join() a thread before it has been started and attempts to do so raises the same exception.

property name

A string used for identification purposes only.

It has no semantics. Multiple threads may be given the same name. The initial name is set by the constructor.

property native_id

Native integral thread ID of this thread, or None if it has not been started.

This is a non-negative integer. See the get_native_id() function. This represents the Thread ID as reported by the kernel.


Notify all the connected web clients (over websocket) of a new event


Callback when a message is received on the backend. It parses and posts the message on the main bus. It should be called by the derived classes whenever a new message should be processed.


msg – Received message. It can be either a key-value dictionary, a platypush.message.Message object, or a string/byte UTF-8 encoded string


On backend stop

register_service(port: Optional[int] = None, name: Optional[str] = None, srv_type: Optional[str] = None, srv_name: Optional[str] = None, udp: bool = False, properties: Optional[Dict] = None)

Initialize the Zeroconf service configuration for this backend.

  • port – Service listen port (default: the backend port attribute if available, or None).

  • name – Service short name (default: backend name).

  • srv_type – Service type (default: _platypush-{name}._{proto}.local.).

  • srv_name – Full service name (default: {hostname or device_id}.{type}).

  • udp – Set to True if this is a UDP service.

  • properties

    Extra properties to be passed on the service. Default:

        "name": "Platypush",
        "vendor": "Platypush",
        "version": "{platypush_version}"


Starts the backend thread. To be implemented in the derived classes if the loop method isn’t defined.

send_event(event, **kwargs)

Send an event message on the backend.


event – Event to send. It can be a dict, a string/bytes UTF-8 JSON, or a platypush.message.event.Event object.

send_message(msg, **kwargs)[source]

Sends a platypush.message.Message to a node. To be implemented in the derived classes. By default, if the Redis backend is configured then it will try to deliver the message to other consumers through the configured Redis main queue.

  • msg – The message to send

  • queue_name – Send the message on a specific queue (default: the queue_name configured on the Redis backend)

send_request(request, on_response=None, response_timeout=5, **kwargs)

Send a request message on the backend.

  • request – The request, either a dict, a string/bytes UTF-8 JSON, or a platypush.message.request.Request object.

  • on_response (function) – Optional callback that will be called when a response is received. If set, this method will synchronously wait for a response before exiting.

  • response_timeout (float) – If on_response is set, the backend will raise an exception if the response isn’t received within this number of seconds (default: None)

send_response(response, request, **kwargs)

Send a response message on the backend.

  • response – The response, either a dict, a string/bytes UTF-8 JSON, or a platypush.message.response.Response object.

  • request – Associated request, used to set the response parameters that will link them


Set whether this thread is a daemon.

This method is deprecated, use the .daemon property instead.


Set the name string for this thread.

This method is deprecated, use the name attribute instead.


Start the thread’s activity.

It must be called at most once per thread object. It arranges for the object’s run() method to be invoked in a separate thread of control.

This method will raise a RuntimeError if called more than once on the same thread object.


Stops the backend thread by sending a STOP event on its bus


Unregister the Zeroconf service configuration if available.


Websocket main server