.. highlight:: rst

.. _webcam2caps:

###########
webcam2caps
###########

**Reads camera frames data products from URL and pushes it to a CAPS server.**


Description
===========

Read camera images from a server and push them into a CAPS server.

.. note::

   This module is currently tight to data from the default input server. For
   other servers a modification may be required. Please contact us at
   info@gempa.de .



Module Configuration
====================

| :file:`etc/defaults/global.cfg`
| :file:`etc/defaults/webcam2caps.cfg`
| :file:`etc/global.cfg`
| :file:`etc/webcam2caps.cfg`
| :file:`~/.seiscomp/global.cfg`
| :file:`~/.seiscomp/webcam2caps.cfg`

webcam2caps inherits :ref:`global options<global-configuration>`.

.. note::

   Modules/plugins may require a license file. The default path to license
   files is :file:`@DATADIR@/licenses/` which can be overridden by global
   configuration of the parameter :confval:`gempa.licensePath`. Example: ::

      gempa.licensePath = @CONFIGDIR@/licenses



.. _input:


.. note::

   **input.\***
   *Configuration of data input.*


.. confval:: input.interval

   Default: ``60``

   Unit: *s*

   Type: *uint*

   Range: ``1,inf``

   Time interval to fetch data.


.. confval:: input.address

   Default: ``https://www.geonet.org.nz:443//volcano/cameras/latest``

   Type: *url*

   Host URL. Format: [http\|https]:\/\/host[:port]\/baseURL


.. _output:


.. note::

   **output.\***
   *Configuration of data output host.*


.. confval:: output.address

   Default: ``caps://localhost:18003``

   Type: *url*

   URL. Format: [caps\|capss]:\/\/[user:pass\@]host[:port]


.. confval:: output.baseDir

   Default: ``/tmp/webcam``

   Type: *directory*

   Directory for temporary storage of images.




Command-Line Options
====================


.. _Generic:


Generic
-------

.. option:: -h, --help

   Show help message.

.. option:: -V, --version

   Show version information.

.. option:: --config-file file

   The alternative module configuration file. When this option
   is used, the module configuration is only read from the
   given file and no other configuration stage is considered.
   Therefore, all configuration including the definition of
   plugins must be contained in that file or given along with
   other command\-line options such as \-\-plugins.

.. option:: -D, --daemon

   Run as daemon. This means the application will fork itself
   and doesn't need to be started with \&.


.. _Verbosity:


Verbosity
---------

.. option:: --verbosity arg

   Verbosity level [0..4]. 0:quiet, 1:error, 2:warning, 3:info,
   4:debug.

.. option:: -v, --v

   Increase verbosity level \(may be repeated, e.g., \-vv\).

.. option:: -q, --quiet

   Quiet mode: no logging output.

.. option:: --print-component arg

   For each log entry print the component right after the
   log level. By default the component output is enabled
   for file output but disabled for console output.

.. option:: --component arg

   Limit the logging to a certain component. This option can
   be given more than once.

.. option:: -s, --syslog

   Use syslog logging backend. The output usually goes to
   \/var\/lib\/messages.

.. option:: -l, --lockfile arg

   Path to lock file.

.. option:: --console arg

   Send log output to stdout.

.. option:: --debug

   Execute in debug mode.
   Equivalent to \-\-verbosity\=4 \-\-console\=1 .

.. option:: --trace

   Execute in trace mode.
   Equivalent to \-\-verbosity\=4 \-\-console\=1 \-\-print\-component\=1
   \-\-print\-context\=1 .

.. option:: --log-file arg

   Use alternative log file.