========
Liveview
========

Liveview utilizes the http/websocket server on the system to which the
Python API is connected, to view real time data.

Liveview requires the ``websockets`` library to be installed on the
local machine::

$ pip install websockets

Liveview also requires the *plhttpd* service to be licensed and enabled
on the remote system.

Example of usage:

.. literalinclude:: examples/api/liveview.py

.. currentmodule:: activelogic.liveview

.. autoclass:: View()

.. automethod:: View.connect
.. automethod:: View.connected
.. automethod:: View.close
.. automethod:: View.add_distributions
.. automethod:: View.add_filters
.. automethod:: View.expand_by_default
.. automethod:: View.wait_for_update

ViewFilter
==========

.. autoclass:: ViewIncludeFilter()
.. autoclass:: ViewExcludeFilter()

Filters that can be applied on a View.

.. automethod:: View.filters
.. automethod:: View.services

ViewDistribution
================

.. autoclass:: ViewDistribution()

Distributions that can be applied on a View.

.. automethod:: View.fields