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

.. role:: underline
   :class: underline

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

.. rubric:: Supported Brands

+------------------+--------------+
| **Brand**        | **Protocol** |
+------------------+--------------+
| 1-Wire DS18B20   | ds18b20      |
+------------------+--------------+
| 1-Wire DS18S20   | ds18s20      |
+------------------+--------------+

.. rubric:: Sender Arguments

*None*

.. rubric:: Config

.. code-block:: json
   :linenos:

   {
     "devices": {
       "weather": {
         "protocol": [ "ds18b20" ],
         "id": [{
           "id": "0000052ba3ac"
         }],
         "temperature": 19.562
       }
     },
     "gui": {
       "temperature": {
         "name": "Temperature Sensor",
         "group": [ "Misc" ],
         "media": [ "all" ]
       }
     }
   }

+------------------+-------------------+
| **Option**       | **Value**         |
+------------------+-------------------+
| id               | *valid 1-wire id* |
+------------------+-------------------+
| temperature      | -55 - 125         |
+------------------+-------------------+

.. note:: **DS18B20**

   Valid id's can be found in the path ``/sys/bus/w1/devices/`` starting with ``28-``. The prefix ``28-`` should be removed from the id.

.. note:: **DS18S20**

   Valid id's can be found in the path ``/sys/bus/w1/devices/`` starting with ``10-``. The prefix ``10-`` should be removed from the id.

.. rubric:: Optional Settings

:underline:`Device Settings`

+--------------------+-------------+------------+-------------------------------------------------+
| **Setting**        | **Default** | **Format** | **Description**                                 |
+--------------------+-------------+------------+-------------------------------------------------+
| poll-interval      | 5           | seconds    | What should be the poll interval of the sensors |
+--------------------+-------------+------------+-------------------------------------------------+
| temperature-offset | 0           | number     | Correct temperature value                       |
+--------------------+-------------+------------+-------------------------------------------------+

:underline:`GUI Settings`

.. note:: DS18B20

+----------------------+-------------+------------+-----------------------------------------------------------+
| **Setting**          | **Default** | **Format** | **Description**                                           |
+----------------------+-------------+------------+-----------------------------------------------------------+
| temperature-decimals | 2           | number     | How many decimals the GUIs should display for temperature |
+----------------------+-------------+------------+-----------------------------------------------------------+
| show-temperature     | 1           | 1 or 0     | Don't display the temperature value                       |
+----------------------+-------------+------------+-----------------------------------------------------------+

.. note:: DS18S20

+----------------------+-------------+------------+-----------------------------------------------------------+
| **Setting**          | **Default** | **Format** | **Description**                                           |
+----------------------+-------------+------------+-----------------------------------------------------------+
| temperature-decimals | 3           | number     | How many decimals the GUIs should display for temperature |
+----------------------+-------------+------------+-----------------------------------------------------------+
| show-temperature     | 1           | 1 or 0     | Don't display the temperature value                       |
+----------------------+-------------+------------+-----------------------------------------------------------+


.. rubric:: Comments

Before pilight can see the sensor, you have to run the following commands:

.. code-block:: console

   sudo modprobe w1-gpio
   sudo modprobe w1-therm

To make sure this is done every reboot, edit ``/etc/modules`` and add the following lines:

.. code-block:: console

   w1-gpio
   w1-therm

If you have enabled "Device tree support" (since Raspbian with kernel 3.18 it's the default configuration), you have to add the following line to ``/boot/config.txt``:

.. code-block:: console

   dtoverlay=w1-gpio-pullup,gpiopin=4

.. note:: The GPIO pin number is the BCM GPIO and not the WiringX number.

This will load the module ``w1-gpio``, so you only have to add ``w1-therm`` to your ``/etc/modules``.

To find the correct sensor id, you have to run the following commands:

.. code-block:: console

   cd /sys/bus/w1/devices
   ls

The result will look like:

.. code-block:: console

   28-0000055bd776  w1_bus_master1

Use the part after 28- as the correct id, e.g. 0000055bd776.