********************
Rabbit web
********************

Overview
====================

Creates a web page showing list of available channels with their values.

This Rabbit version of the web presentation auto-updates the displayed
values every 'polling' seconds.  If polling is 0, no auto-update occurs.


.. Note:: The Rabbit Web Presentation has been deprecated and shall be
          removed from the next release of the iDigi Dia software!

          All of the Rabbit Web Presentation's functionality has been
          superceded by the :doc:`Digi Web Presentation <web>` module.
          This module is fully backward compatible with the Rabbit
          Web Presentation.


Configuration
====================

A typical Rabbit web configuration block looks like this::

    - name: rabbit_web
      driver: presentations.rabbit.web2:Web
      settings:
          page: idigi_dia.html
          polling: 1
          title: "BL4S100 GPIO Demo"

Settings
--------------------

page (optional, default: index)
    Page name which will be served by this presentation module.

port (optional, default: 8001)
    Port value of the HTTP server.

use_default_httpserver (optional, default: True)
    Set this value to False if you are going to use your own HTTP server.

title (optional, default: Dia Web Presentation)
    Title of the web page that will be created with this presentation.

polling (optional, default: 0)
    How often, in seconds, the channel values are refreshed. 0 means no
    polling.

Usage
====================
The presentation can start an own HTTP server - configured by 
'use_default_httpserver' and 'port' settings or use the default one.

To access to the generated web page, open an Internet browser and type the
following address:

* Using the default HTTP server (`use_default_httpserver` setting is True):
    ``http://<ip address>/<page name>``

* Using an own HTTP server (`use_default_httpserver setting` is False):
    ``http://<ip address>:<port>/<page name>``

Where ``<ip address>`` is the IP of the remote device (ConnectPort), 
``<port>`` is the port number configured in settings and ``<page name>``
is the name of the page to access, also configured in settings.

Once there you can see the list of available channels with their values
that will be refreshed every 'polling' seconds. You also can modify them
when possible (settable channels).


