.. |yes| image:: ../../images/yes.png
.. |no| image:: ../../images/no.png

.. role:: underline
   :class: underline

Webcam
=======

+------------------+-------------+
| **Feature**      | **Support** |
+------------------+-------------+
| Sending          | |no|        |
+------------------+-------------+
| Receiving        | |no|        |
+------------------+-------------+
| Config           | |yes|       |
+------------------+-------------+

.. rubric:: Supported Brands

*None*

.. rubric:: Sender Arguments

*None*

.. rubric:: Config

.. code-block:: json
   :linenos:

   {
     "devices": {
       "webcam": {
         "protocol": [ "generic_webcam" ],
         "id": [{
           "id": 100
         }],
         "url": "http://x.x.x.x:xxxx"
       }
     },
     "gui": {
       "webcam": {
         "name": "Webcam",
         "group": [ "Frontdoor" ],
         "media": [ "all" ]
       }
     }
   }

+------------------+-------------------+
| **Option**       | **Value**         |
+------------------+-------------------+
| id               | 0 - 99999         |
+------------------+-------------------+
| url              | *valid image url* |
+------------------+-------------------+

.. rubric:: Optional Settings

:underline:`Device Settings`

+--------------------+-------------+------------+-------------------------------+
| **Setting**        | **Default** | **Format** | **Description**               |
+--------------------+-------------+------------+-------------------------------+
| poll-interval      | 10          | number     | Refresh webcam image interval |
+--------------------+-------------+------------+-------------------------------+

:underline:`GUI Settings`

+----------------------+-------------+------------+-----------------------------------------------------------+
| **Setting**          | **Default** | **Format** | **Description**                                           |
+----------------------+-------------+------------+-----------------------------------------------------------+
| image-width          | NULL        | number     | Webcam image width                                        |
+----------------------+-------------+------------+-----------------------------------------------------------+
| image-height         | 300         | number     | Webcam image height                                       |
+----------------------+-------------+------------+-----------------------------------------------------------+
| show-webcam          | 1           | 1 or 0     | Don't display the webcam image                            |
+----------------------+-------------+------------+-----------------------------------------------------------+