Presence-ARP Module
===================

Presence-ARP module periodically scans your local network and monitors,
who is at home. It then sends those data to given ``presence`` service
in meadow. This ``presence`` service is usually maintained by Pan.


application.yaml
----------------

Recommended configuration example:

(with presence-arp config located at ./presence-arp/config.yaml and
a `presence` service named `presence@global`)

.. code-block:: YAML

    presence-arp:
        presence-name: presence@global
        config: presence-arp/config.yaml


Full configuration example:

.. code-block:: YAML

    presence-arp:
        presence-name: presence@global
        config: presence-arp/config.yaml
        name: my-presence
        interval: 30
        timeout: 10



:presence-name:
    To which `presence` service the module should send the data.

:config:
    Path to configuration file of this module.

:name:
    Name of this module as a meadow client.

    Default: <module name>

:interval:
    Interval for scanning the local network (in seconds).

    Default: ... some tested and recommended value

:timeout:
    The number of seconds after which a user is consider to not be present.

    Default: ... some tested and recommended value