update esppilight lib
content of the library is not filtered on 433mhz only
This commit is contained in:
Florian committed
1 parent
a275e48ee1
commit
67dd7ac078
1030 files changed
+203335
-116
No files matched your search
@@ -0,0 +1,76 @@
|
||||
.. |yes| image:: ../../images/yes.png
|
||||
.. |no| image:: ../../images/no.png
|
||||
|
||||
.. role:: underline
|
||||
:class: underline
|
||||
|
||||
Dim
|
||||
===
|
||||
|
||||
.. rubric:: Description
|
||||
|
||||
Dims a device to a dimlevel or starts a sequence from one dimlevel to another.
|
||||
|
||||
.. rubric:: Options
|
||||
|
||||
+----------+------------------+---------------------+-------------------------------------------------------+
|
||||
| **Name** | **Required** | **Multiple Values** | **Description** |
|
||||
+----------+------------------+---------------------+-------------------------------------------------------+
|
||||
| DEVICE | |yes| | |yes| | Device(s) to change |
|
||||
+----------+------------------+---------------------+-------------------------------------------------------+
|
||||
| TO | |yes| | |no| | New dimlevel |
|
||||
+----------+------------------+---------------------+-------------------------------------------------------+
|
||||
|
||||
.. versionadded:: 7.0
|
||||
|
||||
+----------+------------------+---------------------+-------------------------------------------------------+
|
||||
| **Name** | **Required** | **Multiple Values** | **Description** |
|
||||
+----------+------------------+---------------------+-------------------------------------------------------+
|
||||
| FOR | |no| | |no| | | Determine how long this new state lasts before |
|
||||
| | | | | we change back to the previous dimlevel and state |
|
||||
+----------+------------------+---------------------+-------------------------------------------------------+
|
||||
| AFTER | |no| | |no| | After how long do we want the new state to be set |
|
||||
+----------+------------------+---------------------+-------------------------------------------------------+
|
||||
| IN | |no| | |no| | | To be combined with FROM. In what time do we want |
|
||||
| | | | | to change the dimlevel FROM x TO y |
|
||||
+----------+------------------+---------------------+-------------------------------------------------------+
|
||||
| FROM | |no| | |no| | | To be combined with IN. From what dimlevel do we |
|
||||
| | | | | want to start a sequence to the target dimlevel |
|
||||
+----------+------------------+---------------------+-------------------------------------------------------+
|
||||
|
||||
.. note:: Units for ``FOR``, ``AFTER``, and ``IN``
|
||||
|
||||
- MILLISECOND
|
||||
- SECOND
|
||||
- MINUTE
|
||||
- HOUR
|
||||
- DAY
|
||||
|
||||
.. rubric:: Examples
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
IF 1 == 1 THEN dim DEVICE mainlight TO 15
|
||||
IF 1 == 1 THEN dim DEVICE mainlight AND bookshelve AND hall TO 10
|
||||
|
||||
.. versionadded:: 7.0
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
IF 1 == 1 THEN dim DEVICE mainlight TO 15 FOR 10 MINUTE
|
||||
IF 1 == 1 THEN dim DEVICE mainlight TO 15 AFTER 30 SECOND
|
||||
IF 1 == 1 THEN dim DEVICE mainlight TO 15 AFTER 30 SECOND FOR 10 MINUTE
|
||||
IF 1 == 1 THEN dim DEVICE mainlight TO 15 FROM 0 IN 45 MINUTE
|
||||
IF 1 == 1 THEN dim DEVICE mainlight TO 15 FROM 0 IN 45 MINUTE FOR 15 MINUTE AFTER 5 MINUTE
|
||||
IF 1 == 1 THEN switch DEVICE light TO off FOR 10 SECOND AFTER 30 MINUTE
|
||||
|
||||
.. versionchanged:: 8.1.0
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
IF 1 == 1 THEN dim DEVICE mainlight TO 15 FOR '10 MINUTE'
|
||||
IF 1 == 1 THEN dim DEVICE mainlight TO 15 AFTER '30 SECOND'
|
||||
IF 1 == 1 THEN dim DEVICE mainlight TO 15 AFTER '30 SECOND' FOR '10 MINUTE'
|
||||
IF 1 == 1 THEN dim DEVICE mainlight TO 15 FROM 0 IN '45 MINUTE'
|
||||
IF 1 == 1 THEN dim DEVICE mainlight TO 15 FROM 0 IN '45 MINUTE' FOR '15 MINUTE' AFTER '5 MINUTE'
|
||||
IF 1 == 1 THEN switch DEVICE light TO off FOR '10 SECOND' AFTER '30 MINUTE'
|
||||
@@ -0,0 +1,21 @@
|
||||
Actions
|
||||
=======
|
||||
|
||||
.. versionadded:: 6.0
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
dim
|
||||
pushover
|
||||
switch
|
||||
toggle
|
||||
|
||||
.. versionadded:: 7.0
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
label
|
||||
pushbullet
|
||||
sendmail
|
||||
@@ -0,0 +1,59 @@
|
||||
.. |yes| image:: ../../images/yes.png
|
||||
.. |no| image:: ../../images/no.png
|
||||
|
||||
.. role:: underline
|
||||
:class: underline
|
||||
|
||||
Label
|
||||
=====
|
||||
|
||||
.. rubric:: Description
|
||||
|
||||
Changes the text and color of a generic label device.
|
||||
|
||||
.. rubric:: Options
|
||||
|
||||
+----------+------------------+---------------------+---------------------------------------------------+
|
||||
| **Name** | **Required** | **Multiple Values** | **Description** |
|
||||
+----------+------------------+---------------------+---------------------------------------------------+
|
||||
| DEVICE | |yes| | |yes| | Device(s) to change |
|
||||
+----------+------------------+---------------------+---------------------------------------------------+
|
||||
| TO | |yes| | |no| | New text |
|
||||
+----------+------------------+---------------------+---------------------------------------------------+
|
||||
| COLOR | |no| | |no| | New color. If omitted, color is set to black |
|
||||
+----------+------------------+---------------------+---------------------------------------------------+
|
||||
| **Name** | **Required** | **Multiple Values** | **Description** |
|
||||
+----------+------------------+---------------------+---------------------------------------------------+
|
||||
| FOR | |no| | |no| | | Determine how long this new label lasts |
|
||||
| | | | | before we change back to the previous label |
|
||||
+----------+------------------+---------------------+---------------------------------------------------+
|
||||
| AFTER | |no| | |no| | After how long do we want the new label to be set |
|
||||
+----------+------------------+---------------------+---------------------------------------------------+
|
||||
|
||||
.. note:: Units for ``FOR`` and ``AFTER``
|
||||
|
||||
- MILLISECOND
|
||||
- SECOND
|
||||
- MINUTE
|
||||
- HOUR
|
||||
- DAY
|
||||
|
||||
.. rubric:: Examples
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
IF 1 == 1 THEN label DEVICE tempLabel TO on
|
||||
IF 1 == 1 THEN label DEVICE tempLabel AND humiLabel TO No information
|
||||
IF 1 == 1 THEN label DEVICE tempLabel TO 23.5 FOR 10 SECOND
|
||||
IF 1 == 1 THEN label DEVICE tempLabel TO Bell rang AFTER 30 SECOND
|
||||
IF 1 == 1 THEN label DEVICE tempLabel TO None FOR 10 MINUTE AFTER 30 SECOND
|
||||
|
||||
.. versionchanged:: 8.1.0.
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
IF 1 == 1 THEN label DEVICE tempLabel TO on
|
||||
IF 1 == 1 THEN label DEVICE tempLabel AND humiLabel TO 'No information'
|
||||
IF 1 == 1 THEN label DEVICE tempLabel TO 23.5 FOR '10 SECOND'
|
||||
IF 1 == 1 THEN label DEVICE tempLabel TO 'Bell rang' AFTER '30 SECOND'
|
||||
IF 1 == 1 THEN label DEVICE tempLabel TO None FOR '10 MINUTE' AFTER '30 SECOND'
|
||||
@@ -0,0 +1,38 @@
|
||||
.. |yes| image:: ../../images/yes.png
|
||||
.. |no| image:: ../../images/no.png
|
||||
|
||||
.. role:: underline
|
||||
:class: underline
|
||||
|
||||
Pushbullet
|
||||
==========
|
||||
|
||||
.. rubric:: Description
|
||||
|
||||
Send a message to your mobile phone with the pushbullet API
|
||||
|
||||
.. rubric:: Options
|
||||
|
||||
+----------+------------------+---------------------+---------------------------------------------------+
|
||||
| **Name** | **Required** | **Multiple Values** | **Description** |
|
||||
+----------+------------------+---------------------+---------------------------------------------------+
|
||||
| TITLE | |yes| | |no| | |
|
||||
+----------+------------------+---------------------+---------------------------------------------------+
|
||||
| BODY | |yes| | |no| | |
|
||||
+----------+------------------+---------------------+---------------------------------------------------+
|
||||
| TOKEN | |yes| | |no| | Unique pushbullet user account token |
|
||||
+----------+------------------+---------------------+---------------------------------------------------+
|
||||
| TYPE | |yes| | |no| | Message type |
|
||||
+----------+------------------+---------------------+---------------------------------------------------+
|
||||
|
||||
.. rubric:: Example
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
IF 1 == 1 THEN pushbullet TITLE Doorbell rang BODY Doorbell rang TOKEN abcd123abc TYPE note
|
||||
|
||||
.. versionchanged:: 8.1.0
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
IF 1 == 1 THEN pushbullet TITLE 'Doorbell rang' BODY 'Doorbell rang' TOKEN abcd123abc TYPE note
|
||||
@@ -0,0 +1,38 @@
|
||||
.. |yes| image:: ../../images/yes.png
|
||||
.. |no| image:: ../../images/no.png
|
||||
|
||||
.. role:: underline
|
||||
:class: underline
|
||||
|
||||
Pushover
|
||||
========
|
||||
|
||||
.. rubric:: Description
|
||||
|
||||
Send a message to your mobile phone with the pushover API
|
||||
|
||||
.. rubric:: Options
|
||||
|
||||
+----------+------------------+---------------------+---------------------------------------------------+
|
||||
| **Name** | **Required** | **Multiple Values** | **Description** |
|
||||
+----------+------------------+---------------------+---------------------------------------------------+
|
||||
| TITLE | |yes| | |no| | |
|
||||
+----------+------------------+---------------------+---------------------------------------------------+
|
||||
| MESSAGE | |yes| | |no| | |
|
||||
+----------+------------------+---------------------+---------------------------------------------------+
|
||||
| TOKEN | |yes| | |no| | Unique pushover user account token |
|
||||
+----------+------------------+---------------------+---------------------------------------------------+
|
||||
| USER | |yes| | |no| | Unique pushover username |
|
||||
+----------+------------------+---------------------+---------------------------------------------------+
|
||||
|
||||
.. rubric:: Example
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
IF 1 == 1 THEN pushover TITLE Doorbell rang MESSAGE Doorbell rang TOKEN abcd123abc USER pilight
|
||||
|
||||
.. versionchanged:: 8.1.0
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
IF 1 == 1 THEN pushover TITLE 'Doorbell rang' MESSAGE 'Doorbell rang' TOKEN abcd123abc USER pilight
|
||||
@@ -0,0 +1,52 @@
|
||||
.. |yes| image:: ../../images/yes.png
|
||||
.. |no| image:: ../../images/no.png
|
||||
|
||||
.. role:: underline
|
||||
:class: underline
|
||||
|
||||
Sendmail
|
||||
========
|
||||
|
||||
.. rubric:: Description
|
||||
|
||||
Send a message to any e-mail address
|
||||
|
||||
.. rubric:: Options
|
||||
|
||||
+----------+------------------+---------------------+---------------------------------------------------+
|
||||
| **Name** | **Required** | **Multiple Values** | **Description** |
|
||||
+----------+------------------+---------------------+---------------------------------------------------+
|
||||
| TO | |yes| | |no| | |
|
||||
+----------+------------------+---------------------+---------------------------------------------------+
|
||||
| SUBJECT | |yes| | |no| | |
|
||||
+----------+------------------+---------------------+---------------------------------------------------+
|
||||
| MESSAGE | |yes| | |no| | |
|
||||
+----------+------------------+---------------------+---------------------------------------------------+
|
||||
|
||||
.. note::
|
||||
|
||||
The ``sendmail`` action requires some additional settings in the pilight configuration:
|
||||
|
||||
.. code-block:: json
|
||||
|
||||
{
|
||||
"settings": {
|
||||
"smtp-sender": "sender@domain.com",
|
||||
"smtp-host": "smtp.smtphost.com",
|
||||
"smtp-port": 465,
|
||||
"smtp-user": "smtpuser@domain.com",
|
||||
"smtp-password": "password"
|
||||
}
|
||||
}
|
||||
|
||||
.. rubric:: Examples
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
IF 1 == 1 THEN sendmail SUBJECT Doorbell rang MESSAGE Doorbell rang TO someone@somewhere.com
|
||||
|
||||
.. versionchanged:: 8.1.0
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
IF 1 == 1 THEN sendmail SUBJECT 'Doorbell rang' MESSAGE 'Doorbell rang' TO someone@somewhere.com
|
||||
@@ -0,0 +1,64 @@
|
||||
.. |yes| image:: ../../images/yes.png
|
||||
.. |no| image:: ../../images/no.png
|
||||
|
||||
.. role:: underline
|
||||
:class: underline
|
||||
|
||||
Switch
|
||||
======
|
||||
|
||||
.. rubric:: Description
|
||||
|
||||
Changes the state of a switch, relay or dimmer.
|
||||
|
||||
.. rubric:: Options
|
||||
|
||||
+----------+------------------+---------------------+---------------------------------------------------+
|
||||
| **Name** | **Required** | **Multiple Values** | **Description** |
|
||||
+----------+------------------+---------------------+---------------------------------------------------+
|
||||
| DEVICE | |yes| | |yes| | Device(s) to change |
|
||||
+----------+------------------+---------------------+---------------------------------------------------+
|
||||
| TO | |yes| | |no| | New state |
|
||||
+----------+------------------+---------------------+---------------------------------------------------+
|
||||
|
||||
.. versionadded:: 7.0
|
||||
|
||||
+----------+------------------+---------------------+---------------------------------------------------+
|
||||
| **Name** | **Required** | **Multiple Values** | **Description** |
|
||||
+----------+------------------+---------------------+---------------------------------------------------+
|
||||
| FOR | |no| | |no| | | Determine how long this new state lasts |
|
||||
| | | | | before we change back to the previous state |
|
||||
+----------+------------------+---------------------+---------------------------------------------------+
|
||||
| AFTER | |no| | |no| | After how long do we want the new state to be set |
|
||||
+----------+------------------+---------------------+---------------------------------------------------+
|
||||
|
||||
.. note:: Units for ``FOR`` and ``AFTER``
|
||||
|
||||
- MILLISECOND
|
||||
- SECOND
|
||||
- MINUTE
|
||||
- HOUR
|
||||
- DAY
|
||||
|
||||
.. rubric:: Examples
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
IF 1 == 1 THEN switch DEVICE light TO on
|
||||
IF 1 == 1 THEN switch DEVICE mainlight AND bookshelve AND hall TO on
|
||||
|
||||
.. versionadded:: 7.0
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
IF 1 == 1 THEN switch DEVICE light TO on FOR 10 MINUTE
|
||||
IF 1 == 1 THEN switch DEVICE light TO on AFTER 30 MILLISECOND
|
||||
IF 1 == 1 THEN switch DEVICE light TO off FOR 10 SECOND AFTER 30 MINUTE
|
||||
|
||||
.. versionchanged:: 8.1.0
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
IF 1 == 1 THEN switch DEVICE light TO on FOR '10 MINUTE'
|
||||
IF 1 == 1 THEN switch DEVICE light TO on AFTER '30 MILLISECOND'
|
||||
IF 1 == 1 THEN switch DEVICE light TO off FOR '10 SECOND' AFTER '30 MINUTE'
|
||||
@@ -0,0 +1,30 @@
|
||||
.. |yes| image:: ../../images/yes.png
|
||||
.. |no| image:: ../../images/no.png
|
||||
|
||||
.. role:: underline
|
||||
:class: underline
|
||||
|
||||
Toggle
|
||||
======
|
||||
|
||||
.. rubric:: Description
|
||||
|
||||
Toggles a device between state X and state Y. This action is especially made for ``one-shot`` devices such as a remote control button where a normal separate 'switch-on' and separate 'switch-off' rule doesn't apply. This action will check what the current state of a device is, and will change it to the non-current state.
|
||||
|
||||
.. rubric:: Options
|
||||
|
||||
+----------+------------------+---------------------+---------------------------------------------------+
|
||||
| **Name** | **Required** | **Multiple Values** | **Description** |
|
||||
+----------+------------------+---------------------+---------------------------------------------------+
|
||||
| DEVICE | |yes| | |yes| | Device(s) to change |
|
||||
+----------+------------------+---------------------+---------------------------------------------------+
|
||||
| BETWEEN | |yes| | |no| | State 1 |
|
||||
+----------+------------------+---------------------+---------------------------------------------------+
|
||||
| AND | |no| | |no| | State 2 |
|
||||
+----------+------------------+---------------------+---------------------------------------------------+
|
||||
|
||||
.. rubric:: Example
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
IF 1 == 1 THEN toggle DEVICE television BETWEEN on AND off
|
||||
Reference in new issue
Block a user