chriz/OpenMQTT-Gateway
1
0 Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 5 Wiki Activity

update esppilight lib

Browse Source 
content of the library is not filtered on 433mhz only
This commit is contained in:
Florian committed 2018-11-28 20:41:37 +01:00
1 parent a275e48ee1
commit 67dd7ac078
1030 files changed
+203335 -116
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

lib/ESPiLight/pilight/docs/source/protocols/gpio/_am2302.rst
+99
View File
@@ -0,0 +1,99 @@
.. |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 |
+----------------------+-------------+------------+-----------------------------------------------------------+
lib/ESPiLight/pilight/docs/source/protocols/gpio/_bmp180.rst
+115
View File
@@ -0,0 +1,115 @@
.. |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** |
+------------------+--------------+
| BMP180 | bmp180 |
+------------------+--------------+
| BMP085 | bmp085 |
+------------------+--------------+
.. rubric:: Sender Arguments
*None*
.. rubric:: Config
.. code-block:: json
:linenos:
{
"devices": {
"bmp180": {
"protocol": [ "bmp180" ],
"id": [{
"id": "0x77"
}],
"temperature": 19.1,
"pressure": 1006.8,
"oversampling": 1
}
},
"gui": {
"temperature": {
"name": "Temperature Sensor",
"group": [ "Misc" ],
"media": [ "all" ]
}
}
}
+------------------+------------------+
| **Option** | **Value** |
+------------------+------------------+
| id | *valid i2c path* |
+------------------+------------------+
| temperature | -40 - 85 |
+------------------+------------------+
| pressure | 300 - 1100 |
+------------------+------------------+
| oversampling | 0 - 3 |
+------------------+------------------+
.. rubric:: Optional Settings
:underline:`Device Settings`
+--------------------+-------------+------------+-------------------------------------------------+
| **Setting** | **Default** | **Format** | **Description** |
+--------------------+-------------+------------+-------------------------------------------------+
| poll-interval | 10 | 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 | 2 | number | How many decimals the GUIs should display for temperature |
+----------------------+-------------+------------+-----------------------------------------------------------+
| pressure-decimals | 2 | number | How many decimals the GUIs should display for pressure |
+----------------------+-------------+------------+-----------------------------------------------------------+
| show-temperature | 1 | 1 or 0 | Don't display the temperature value |
+----------------------+-------------+------------+-----------------------------------------------------------+
| show-pressure | 1 | 1 or 0 | Don't display the pressure value |
+----------------------+-------------+------------+-----------------------------------------------------------+
.. rubric:: Comments
Pressure is provided in hectopascal (hPa) and temperature in degrees Celsius (°C).
Option ``oversampling`` sets the BMP180 hardware accuracy mode which is relevant for pressure readings only.
+-----------------------+--------------+-------------------------+------------------------------------+
| Mode | oversampling | Internal no. of samples | Conversion time pressure max. [ms] |
+-----------------------+--------------+-------------------------+------------------------------------+
| ultra low power | 0 | 1 | 4.5 |
+-----------------------+--------------+-------------------------+------------------------------------+
| standard | 1 | 2 | 7.5 |
+-----------------------+--------------+-------------------------+------------------------------------+
| high resolution | 2 | 4 | 13.5 |
+-----------------------+--------------+-------------------------+------------------------------------+
| ultra high resolution | 3 | 8 | 25.5 |
+-----------------------+--------------+-------------------------+------------------------------------+
The algorithm for pressure and temperature measurement is based on the specification in the `official datasheet <https://ae-bst.resource.bosch.com/media/products/dokumente/bmp180/BST-BMP180-DS000-12~1.pdf>`_.
lib/ESPiLight/pilight/docs/source/protocols/gpio/_ds18b20.rst
+145
View File
@@ -0,0 +1,145 @@
.. |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.
lib/ESPiLight/pilight/docs/source/protocols/gpio/_lm75.rst
+131
View File
@@ -0,0 +1,131 @@
.. |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** |
+------------------+--------------+
| LM75 | lm75 |
+------------------+--------------+
| LM76 | lm76 |
+------------------+--------------+
.. rubric:: Sender Arguments
*None*
.. rubric:: Config
.. code-block:: json
:linenos:
{
"devices": {
"temperature": {
"protocol": [ "lm75" ],
"id": [{
"id": "0x49"
}],
"temperature": 17.2
}
},
"gui": {
"temperature": {
"name": "Temperature Sensor",
"group": [ "Misc" ],
"media": [ "all" ]
}
}
}
+------------------+-------------------+
| **Option** | **Value** |
+------------------+-------------------+
| id | *valid i2c id* |
+------------------+-------------------+
| temperature | -55 - 125 |
+------------------+-------------------+
.. versionchanged:: 8.0
.. code-block:: json
:linenos:
{
"devices": {
"temperature": {
"protocol": [ "lm75" ],
"id": [{
"id": "0x49",
"i2c-path": "/dev/i2c-0"
}],
"temperature": 17.2
}
},
"gui": {
"temperature": {
"name": "Temperature Sensor",
"group": [ "Misc" ],
"media": [ "all" ]
}
}
}
+------------------+-------------------+
| **Option** | **Value** |
+------------------+-------------------+
| id | *valid i2c id* |
+------------------+-------------------+
| i2c-path | *valid i2c path* |
+------------------+-------------------+
| temperature | -55 - 125 |
+------------------+-------------------+
.. 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:: LM75
+----------------------+-------------+------------+-----------------------------------------------------------+
| **Setting** | **Default** | **Format** | **Description** |
+----------------------+-------------+------------+-----------------------------------------------------------+
| temperature-decimals | 1 | number | How many decimals the GUIs should display for temperature |
+----------------------+-------------+------------+-----------------------------------------------------------+
| show-temperature | 1 | 1 or 0 | Don't display the temperature value |
+----------------------+-------------+------------+-----------------------------------------------------------+
.. note:: LM76
+----------------------+-------------+------------+-----------------------------------------------------------+
| **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 |
+----------------------+-------------+------------+-----------------------------------------------------------+
lib/ESPiLight/pilight/docs/source/protocols/gpio/am2302.rst
+4
View File
@@ -0,0 +1,4 @@
1-Wire AM2302
=============
.. include:: _am2302.rst
lib/ESPiLight/pilight/docs/source/protocols/gpio/bmp085.rst
+4
View File
@@ -0,0 +1,4 @@
BMP085
======
.. include:: _bmp180.rst
Side by Side

After

Width:  |  Height:  |  Size: 39 B

lib/ESPiLight/pilight/docs/source/protocols/gpio/bmp180.rst
+4
View File
@@ -0,0 +1,4 @@
BMP180
======
.. include:: _bmp180.rst
Side by Side

After

Width:  |  Height:  |  Size: 39 B

lib/ESPiLight/pilight/docs/source/protocols/gpio/cputemp.rst
+105
View File
@@ -0,0 +1,105 @@
.. |yes| image:: ../../images/yes.png
.. |no| image:: ../../images/no.png
.. role:: underline
:class: underline
CPU Temperature
===============
+------------------+-------------+
| **Feature** | **Support** |
+------------------+-------------+
| Sending | |no| |
+------------------+-------------+
| Receiving | |yes| |
+------------------+-------------+
| Config | |yes| |
+------------------+-------------+
.. rubric:: Supported Brands
+------------------+--------------+
| **Brand** | **Protocol** |
+------------------+--------------+
| Raspberry Pi | cpu_temp |
+------------------+--------------+
| Hummingboard | cpu_temp |
+------------------+--------------+
.. rubric:: Sender Arguments
*None*
.. rubric:: Config
.. code-block:: json
:linenos:
{
"devices": {
"weather": {
"protocol": [ "cpu_temp" ],
"id": [{
"id": 1
}],
"temperature": 59.397,
"poll-interval": 10
}
},
"gui": {
"temperature": {
"name": "Temperature Sensor",
"group": [ "Misc" ],
"media": [ "all" ]
}
}
}
+------------------+-------------------+
| **Option** | **Value** |
+------------------+-------------------+
| id | 0 - 99999 |
+------------------+-------------------+
| temperature | -40.000 - 85.000 |
+------------------+-------------------+
| poll-interval | 1 - 60 |
+------------------+-------------------+
.. 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`
+----------------------+-------------+------------+-----------------------------------------------------------+
| **Setting** | **Default** | **Format** | **Description** |
+----------------------+-------------+------------+-----------------------------------------------------------+
| temperature-decimals | 1 | number | How many decimals the GUIs should display for temperature |
+----------------------+-------------+------------+-----------------------------------------------------------+
| show-temperature | 1 | 1 or 0 | Don't display the temperature value |
+----------------------+-------------+------------+-----------------------------------------------------------+
.. rubric:: Comments
On the Raspberry Pi:
It is possible you need to first load the sensor module:
.. code-block:: console
sudo modprobe bcm2835_thermal
To make sure this is done every reboot, edit ``/etc/modules`` and add the following lines:
.. code-block:: console
bcm2835_thermal
lib/ESPiLight/pilight/docs/source/protocols/gpio/dht11.rst
+4
View File
@@ -0,0 +1,4 @@
1-Wire DHT11
=============
.. include:: _am2302.rst
lib/ESPiLight/pilight/docs/source/protocols/gpio/dht22.rst
+4
View File
@@ -0,0 +1,4 @@
1-Wire DHT22
=============
.. include:: _am2302.rst
lib/ESPiLight/pilight/docs/source/protocols/gpio/ds18b20.rst
+4
View File
@@ -0,0 +1,4 @@
DS18B20
=======
.. include:: _ds18b20.rst
lib/ESPiLight/pilight/docs/source/protocols/gpio/ds18s20.rst
+4
View File
@@ -0,0 +1,4 @@
DS18S20
=======
.. include:: _ds18b20.rst
lib/ESPiLight/pilight/docs/source/protocols/gpio/gpio_switch.rst
+86
View File
@@ -0,0 +1,86 @@
.. |yes| image:: ../../images/yes.png
.. |no| image:: ../../images/no.png
.. role:: underline
:class: underline
GPIO Switch
===============
+------------------+-------------+
| **Feature** | **Support** |
+------------------+-------------+
| Sending | |no| |
+------------------+-------------+
| Receiving | |yes| |
+------------------+-------------+
| Config | |yes| |
+------------------+-------------+
.. rubric:: Supported Brands
+------------------+--------------+
| **Brand** | **Protocol** |
+------------------+--------------+
| Raspberry Pi | cpu_temp |
+------------------+--------------+
| Hummingboard | cpu_temp |
+------------------+--------------+
.. rubric:: Sender Arguments
.. code-block:: console
-g --gpio=gpio the gpio the switch is connected to
.. rubric:: Config
.. code-block:: json
:linenos:
{
"devices": {
"switch": {
"protocol": [ "gpio_switch" ],
"id": [{
"gpio": 1
}],
"state": "off"
}
},
"gui": {
"switch": {
"name": "Switch",
"group": [ "Misc" ],
"media": [ "all" ]
}
}
}
+------------------+-----------------+
| **Option** | **Value** |
+------------------+-----------------+
| gpio | 0 - 255 |
+------------------+-----------------+
| state | on / off |
+------------------+-----------------+
.. note::
The ``gpio`` value should be a valid GPIO for the platform used
.. rubric:: Optional Settings
:underline:`Device Settings`
+------------------+-------------+------------+-----------------------------------------------+
| **Setting** | **Default** | **Format** | **Description** |
+------------------+-------------+------------+-----------------------------------------------+
| readonly | 0 | 1 or 0 | Disable controlling this device from the GUIs |
+------------------+-------------+------------+-----------------------------------------------+
| confirm | 0 | 1 or 0 | Ask for confirmation when switching device |
+------------------+-------------+------------+-----------------------------------------------+
.. rubric:: Comments
The GPIO switch protocol follows the wiringX numbering as can be found here: http://wiringx.org
lib/ESPiLight/pilight/docs/source/protocols/gpio/index.rst
+17
View File
@@ -0,0 +1,17 @@
GPIO
====
.. toctree::
:maxdepth: 3
am2302
bmp180
bmp085
cputemp
dht22
dht11
ds18b20
ds18s20
gpio_switch
lm75
lm76
lib/ESPiLight/pilight/docs/source/protocols/gpio/lm75.rst
+4
View File
@@ -0,0 +1,4 @@
I2C-bus LM75
============
.. include:: _lm75.rst
lib/ESPiLight/pilight/docs/source/protocols/gpio/lm76.rst
+4
View File
@@ -0,0 +1,4 @@
I2C-bus LM76
============
.. include:: _lm75.rst