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/generic/dimmer.rst
+111
View File
@@ -0,0 +1,111 @@
.. |yes| image:: ../../images/yes.png
.. |no| image:: ../../images/no.png
.. role:: underline
:class: underline
Dimmer
======
+------------------+-------------+
| **Feature** | **Support** |
+------------------+-------------+
| Sending | |yes| |
+------------------+-------------+
| Receiving | |no| |
+------------------+-------------+
| Config | |yes| |
+------------------+-------------+
.. rubric:: Supported Brands
*None*
.. rubric:: Sender Arguments
.. code-block:: console
-t --on send an on signal
-f --off send an off signal
-i --id=id control a device with this id
-d --dimlevel=dimlevel send a specific dimlevel
.. rubric:: Config
.. code-block:: json
:linenos:
{
"devices": {
"dimmer": {
"protocol": [ "generic_dimmer" ],
"id": [{
"id": 100
}],
"state": "off",
"dimlevel": 0
}
},
"gui": {
"dimmer": {
"name": "Dimmer",
"group": [ "Living" ],
"media": [ "all" ]
}
}
}
+------------------+-----------------+
| **Option** | **Value** |
+------------------+-----------------+
| id | 0 - 99999 |
+------------------+-----------------+
| state | on / off |
+------------------+-----------------+
| dimlevel | 0 - 99999 |
+------------------+-----------------+
.. rubric:: Optional Settings
:underline:`GUI 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 |
+------------------+-------------+------------+-----------------------------------------------+
.. versionadded:: 8.0.6
.. note::
The minimum and maximum is dependent on the ``Device Settings`` below.
The actual dimlevel is not validated against these ranges.
:underline:`GUI Settings`
+------------------+-------------+------------+------------------+
| **Setting** | **Default** | **Format** | **Description** |
+------------------+-------------+------------+------------------+
| dimlevel-minimum | 0 | number | Minimum dimlevel |
+------------------+-------------+------------+------------------+
| dimlevel-maximum | 15 | number | Maximum dimlevel |
+------------------+-------------+------------+------------------+
.. deprecated:: 8.0.5
.. note::
The minimum and maximum is dependent on the ``Device Settings`` below.
:underline:`Device Settings`
+------------------+-------------+------------+------------------+
| **Setting** | **Default** | **Format** | **Description** |
+------------------+-------------+------------+------------------+
| dimlevel-minimum | 0 | number | Minimum dimlevel |
+------------------+-------------+------------+------------------+
| dimlevel-maximum | 15 | number | Maximum dimlevel |
+------------------+-------------+------------+------------------+
lib/ESPiLight/pilight/docs/source/protocols/generic/index.rst
+13
View File
@@ -0,0 +1,13 @@
Generic
=======
.. toctree::
:maxdepth: 3
dimmer
label
raw
screen
switch
weather
webcam
lib/ESPiLight/pilight/docs/source/protocols/generic/label.rst
+69
View File
@@ -0,0 +1,69 @@
.. |yes| image:: ../../images/yes.png
.. |no| image:: ../../images/no.png
.. role:: underline
:class: underline
Label
=====
+------------------+-------------+
| **Feature** | **Support** |
+------------------+-------------+
| Sending | |yes| |
+------------------+-------------+
| Receiving | |no| |
+------------------+-------------+
| Config | |yes| |
+------------------+-------------+
.. rubric:: Supported Brands
*None*
.. rubric:: Sender Arguments
.. code-block:: console
-i --id=id control a device with this id
-l --label=label show a specific label
-c --color=color give the label a specific color
.. rubric:: Config
.. code-block:: json
:linenos:
{
"devices": {
"label": {
"protocol": [ "generic_label" ],
"id": [{
"id": 100
}],
"label": "test1234",
"color": "red"
}
},
"gui": {
"label": {
"name": "Label",
"group": [ "Living" ],
"media": [ "all" ]
}
}
}
+------------------+-----------------+
| **Option** | **Value** |
+------------------+-----------------+
| id | 0 - 99999 |
+------------------+-----------------+
| label | *any value* |
+------------------+-----------------+
| color | *any color* |
+------------------+-----------------+
.. note::
Please notice that the label color is not validated in any way. The color information is just forwarded to the GUIs as is. So it could be that some GUIs do not support certain color naming. Using hex colors is therefore the safest, e.g. #000000.
lib/ESPiLight/pilight/docs/source/protocols/generic/raw.rst
+33
View File
@@ -0,0 +1,33 @@
.. |yes| image:: ../../images/yes.png
.. |no| image:: ../../images/no.png
.. role:: underline
:class: underline
Raw
===
+------------------+-------------+
| **Feature** | **Support** |
+------------------+-------------+
| Sending | |yes| |
+------------------+-------------+
| Receiving | |no| |
+------------------+-------------+
| Config | |no| |
+------------------+-------------+
.. rubric:: Supported Brands
*None*
.. rubric:: Sender Arguments
.. code-block:: console
-c --code="raw" raw code divided by spaces
(just like the output of debug)
.. rubric:: Config
*None*
lib/ESPiLight/pilight/docs/source/protocols/generic/screen.rst
+74
View File
@@ -0,0 +1,74 @@
.. |yes| image:: ../../images/yes.png
.. |no| image:: ../../images/no.png
.. role:: underline
:class: underline
Screen
======
+------------------+-------------+
| **Feature** | **Support** |
+------------------+-------------+
| Sending | |yes| |
+------------------+-------------+
| Receiving | |no| |
+------------------+-------------+
| Config | |yes| |
+------------------+-------------+
.. rubric:: Supported Brands
*None*
.. rubric:: Sender Arguments
.. code-block:: console
-t --up send an up signal
-f --down send a down signal
-i --id=id control a device with this id
.. rubric:: Config
.. code-block:: json
:linenos:
{
"devices": {
"screen": {
"protocol": [ "generic_screen" ],
"id": [{
"id": 100
}],
"state": "down"
}
},
"gui": {
"screen": {
"name": "Screen",
"group": [ "Living" ],
"media": [ "all" ]
}
}
}
+------------------+-----------------+
| **Option** | **Value** |
+------------------+-----------------+
| id | 0 - 99999 |
+------------------+-----------------+
| state | up/down |
+------------------+-----------------+
.. rubric:: Optional Settings
:underline:`GUI 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 |
+------------------+-------------+------------+-----------------------------------------------+
lib/ESPiLight/pilight/docs/source/protocols/generic/switch.rst
+74
View File
@@ -0,0 +1,74 @@
.. |yes| image:: ../../images/yes.png
.. |no| image:: ../../images/no.png
.. role:: underline
:class: underline
Switch
======
+------------------+-------------+
| **Feature** | **Support** |
+------------------+-------------+
| Sending | |yes| |
+------------------+-------------+
| Receiving | |no| |
+------------------+-------------+
| Config | |yes| |
+------------------+-------------+
.. rubric:: Supported Brands
*None*
.. rubric:: Sender Arguments
.. code-block:: console
-t --on send an on signal
-f --off send an off signal
-i --id=id control a device with this id
.. rubric:: Config
.. code-block:: json
:linenos:
{
"devices": {
"switch": {
"protocol": [ "generic_switch" ],
"id": [{
"id": 100
}],
"state": "off"
}
},
"gui": {
"switch": {
"name": "Switch",
"group": [ "Living" ],
"media": [ "all" ]
}
}
}
+------------------+-----------------+
| **Option** | **Value** |
+------------------+-----------------+
| id | 0 - 99999 |
+------------------+-----------------+
| state | on / off |
+------------------+-----------------+
.. rubric:: Optional Settings
:underline:`GUI 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 |
+------------------+-------------+------------+-----------------------------------------------+
lib/ESPiLight/pilight/docs/source/protocols/generic/weather.rst
+97
View File
@@ -0,0 +1,97 @@
.. |yes| image:: ../../images/yes.png
.. |no| image:: ../../images/no.png
.. role:: underline
:class: underline
Weather
=======
+------------------+-------------+
| **Feature** | **Support** |
+------------------+-------------+
| Sending | |yes| |
+------------------+-------------+
| Receiving | |no| |
+------------------+-------------+
| Config | |yes| |
+------------------+-------------+
.. rubric:: Supported Brands
*None*
.. rubric:: Sender Arguments
.. code-block:: console
-t --temperature=temperature set the temperature
-h --humidity=humidity set the humidity
-b --battery=battery set the battery level
-i --id=id control a device with this id
.. rubric:: Config
.. code-block:: json
:linenos:
{
"devices": {
"weather": {
"protocol": [ "generic_weather" ],
"id": [{
"id": 100
}],
"temperature": 23.00,
"humidity": 76.00,
"battery": 0
}
},
"gui": {
"weather": {
"name": "Weather",
"group": [ "Weather" ],
"media": [ "all" ]
}
}
}
+------------------+-----------------+
| **Option** | **Value** |
+------------------+-----------------+
| id | 0 - 99999 |
+------------------+-----------------+
| temperature | 0.00 - 100.00 |
+------------------+-----------------+
| humidity | 0.00 - 100.00 |
+------------------+-----------------+
| battery | 0 - 1 |
+------------------+-----------------+
.. rubric:: Optional Settings
:underline:`Device Settings`
+--------------------+-------------+------------+---------------------------+
| **Setting** | **Default** | **Format** | **Description** |
+--------------------+-------------+------------+---------------------------+
| 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 |
+----------------------+-------------+------------+-----------------------------------------------------------+
| humidity-decimals | 2 | number | How many decimals the GUIs should display for humidity |
+----------------------+-------------+------------+-----------------------------------------------------------+
| show-humidity | 1 | 1 or 0 | Don't display the humidity value |
+----------------------+-------------+------------+-----------------------------------------------------------+
| show-temperature | 1 | 1 or 0 | Don't display the temperature value |
+----------------------+-------------+------------+-----------------------------------------------------------+
| show-battery | 0 | 1 or 0 | Don't display the battery value |
+----------------------+-------------+------------+-----------------------------------------------------------+
lib/ESPiLight/pilight/docs/source/protocols/generic/webcam.rst
+80
View File
@@ -0,0 +1,80 @@
.. |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 |
+----------------------+-------------+------------+-----------------------------------------------------------+