99 lines
3.8 KiB
ReStructuredText
99 lines
3.8 KiB
ReStructuredText
.. |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 DHT11 | dht11 |
|
|
+------------------+--------------+
|
|
| 1-Wire DHT22 | dht22 |
|
|
+------------------+--------------+
|
|
| 1-Wire AM2302 | am2302 |
|
|
+------------------+--------------+
|
|
|
|
.. rubric:: Sender Arguments
|
|
|
|
*None*
|
|
|
|
.. rubric:: Config
|
|
|
|
.. code-block:: json
|
|
:linenos:
|
|
|
|
{
|
|
"devices": {
|
|
"weather": {
|
|
"protocol": [ "dht22" ],
|
|
"id": [{
|
|
"gpio": 7
|
|
}],
|
|
"temperature": 5.2,
|
|
"humidity": 1.7,
|
|
"poll-interval": 5
|
|
}
|
|
},
|
|
"gui": {
|
|
"temperature": {
|
|
"name": "Temperature Sensor",
|
|
"group": [ "Misc" ],
|
|
"media": [ "all" ]
|
|
}
|
|
}
|
|
}
|
|
|
|
+------------------+-----------------+
|
|
| **Option** | **Value** |
|
|
+------------------+-----------------+
|
|
| gpio | 0 - 255 |
|
|
+------------------+-----------------+
|
|
| temperature | -40 - 80 |
|
|
+------------------+-----------------+
|
|
| humidity | 0 - 100 |
|
|
+------------------+-----------------+
|
|
|
|
.. note::
|
|
|
|
The ``gpio`` value should be a valid GPIO for the platform used
|
|
|
|
.. rubric:: Optional Settings
|
|
|
|
:underline:`Device Settings`
|
|
|
|
+--------------------+-------------+------------+-------------------------------------------------+
|
|
| **Setting** | **Default** | **Format** | **Description** |
|
|
+--------------------+-------------+------------+-------------------------------------------------+
|
|
| poll-interval | 5 | seconds | What should be the poll interval of the sensors |
|
|
+--------------------+-------------+------------+-------------------------------------------------+
|
|
| humidity-offset | 0 | number | Correct humidity value |
|
|
+--------------------+-------------+------------+-------------------------------------------------+
|
|
| temperature-offset | 0 | number | Correct temperature value |
|
|
+--------------------+-------------+------------+-------------------------------------------------+
|
|
|
|
:underline:`GUI Settings`
|
|
|
|
+----------------------+-------------+------------+-----------------------------------------------------------+
|
|
| **Setting** | **Default** | **Format** | **Description** |
|
|
+----------------------+-------------+------------+-----------------------------------------------------------+
|
|
| temperature-decimals | 1 | number | How many decimals the GUIs should display for temperature |
|
|
+----------------------+-------------+------------+-----------------------------------------------------------+
|
|
| humidity-decimals | 1 | number | How many decimals the GUIs should display for humidity |
|
|
+----------------------+-------------+------------+-----------------------------------------------------------+
|
|
| show-temperature | 1 | 1 or 0 | Don't display the temperature value |
|
|
+----------------------+-------------+------------+-----------------------------------------------------------+
|
|
| show-humidity | 1 | 1 or 0 | Don't display the humidity value |
|
|
+----------------------+-------------+------------+-----------------------------------------------------------+ |