Michel2/ESPEasy
1
0
Fork 0
mirror of https://github.com/letscontrolit/ESPEasy.git synced 2026-07-28 04:07:47 +00:00
Code Issues Releases Activity

[Docs] Add stubs for not yet documented plugins

Browse Source 
Also added entries in the Custom-sample.h file
This commit is contained in:
TD-er
2020-12-19 14:54:19 +01:00
parent 8726ec7531
commit 0772905b70
10 changed files with 447 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/source/Plugin/P102.rst
+115
View File
@@ -0,0 +1,115 @@
.. include:: ../Plugin/_plugin_substitutions_p10x.repl
.. _P102_page:
|P102_typename|
==================================================
|P102_shortinfo|
Plugin details
--------------
Type: |P102_type|
Name: |P102_name|
Status: |P102_status|
GitHub: |P102_github|_
Maintainer: |P102_maintainer|
Used libraries: |P102_usedlibraries|
Description
-----------
PZEM-004T V3.0 or Version 3.0 is the upgraded version to replace the old PZEM004T V1.0.
The old version has been sold out in most of the online store and is no longer being produced.
Improvements over V1:
* Higher resolution
* More samples per second
* Increased stability
Specifications
--------------
Voltage
^^^^^^^
* Measuring range: 80 - 260V
* Resolution: 0.1V
* Measurement accuracy: 0.5%
Power factor
^^^^^^^^^^^^
* Measuring range: 0.00 - 1.00
* Resolution: 0.01
* Measurement accuracy: 1%
Frequency
^^^^^^^^^
* Measuring range: 45Hz - 65Hz
* Resolution: 0.1Hz
* Measurement accuracy: 0.5%
Current
^^^^^^^
* Measuring range:
* 0 - 10A(PZEM-004T-10A)
* 0 - 100A(PZEM-004T-100A)
* Starting measure current:
* 0.01A(PZEM-004T-10A)
* 0.02A(PZEM-004T-100A)
* Resolution: 0.001A
* 0.001A(PZEM-004T-10A)
* 0.01A(PZEM-004T-100A)
* Measurement accuracy: 0.5%
Active power
^^^^^^^^^^^^
* Measuring range:
* 0 - 2.3kW(PZEM-004T-10A)
* 0 - 23kW(PZEM-004T-100A)
* Starting measure power: 0.4W
* Resolution: 0.1W
* Measurement accuracy: 0.5%
Active Energy
^^^^^^^^^^^^^
* Measuring range: 0 - 9999.99kWh
* Resolution: 1Wh
* Measurement accuracy: 0.5%
.. Events
.. ~~~~~~
.. .. include:: P102_events.repl
Change log
----------
.. versionchanged:: 2.0
...
|added| 2020-04-25
docs/source/Plugin/P103.rst
+46
View File
@@ -0,0 +1,46 @@
.. include:: ../Plugin/_plugin_substitutions_p10x.repl
.. _P103_page:
|P103_typename|
==================================================
|P103_shortinfo|
Plugin details
--------------
Type: |P103_type|
Name: |P103_name|
Status: |P103_status|
GitHub: |P103_github|_
Maintainer: |P103_maintainer|
Used libraries: |P103_usedlibraries|
Datasheet: |P103_datasheet|
Description
-----------
.. Events
.. ~~~~~~
.. .. include:: P103_events.repl
Change log
----------
.. versionchanged:: 2.0
...
|added| 2020-04-25
docs/source/Plugin/P104.rst
+44
View File
@@ -0,0 +1,44 @@
.. include:: ../Plugin/_plugin_substitutions_p10x.repl
.. _P104_page:
|P104_typename|
==================================================
|P104_shortinfo|
Plugin details
--------------
Type: |P104_type|
Name: |P104_name|
Status: |P104_status|
GitHub: |P104_github|_
Maintainer: |P104_maintainer|
Used libraries: |P104_usedlibraries|
Datasheet: |P104_datasheet|
Description
-----------
.. Events
.. ~~~~~~
.. .. include:: P104_events.repl
Change log
----------
.. versionchanged:: 2.0
...
|added| 2020-04-25
docs/source/Plugin/P105.rst
+44
View File
@@ -0,0 +1,44 @@
.. include:: ../Plugin/_plugin_substitutions_p10x.repl
.. _P105_page:
|P105_typename|
==================================================
|P105_shortinfo|
Plugin details
--------------
Type: |P105_type|
Name: |P105_name|
Status: |P105_status|
GitHub: |P105_github|_
Maintainer: |P105_maintainer|
Used libraries: |P105_usedlibraries|
Datasheet: |P105_datasheet|
Description
-----------
.. Events
.. ~~~~~~
.. .. include:: P105_events.repl
Change log
----------
.. versionchanged:: 2.0
...
|added| 2020-04-25
docs/source/Plugin/P106.rst
+42
View File
@@ -0,0 +1,42 @@
.. include:: ../Plugin/_plugin_substitutions_p10x.repl
.. _P106_page:
|P106_typename|
==================================================
|P106_shortinfo|
Plugin details
--------------
Type: |P106_type|
Name: |P106_name|
Status: |P106_status|
GitHub: |P106_github|_
Maintainer: |P106_maintainer|
Used libraries: |P106_usedlibraries|
Description
-----------
.. Events
.. ~~~~~~
.. .. include:: P106_events.repl
Change log
----------
.. versionchanged:: 2.0
...
|added| 2020-04-25
docs/source/Plugin/P107.rst
+42
View File
@@ -0,0 +1,42 @@
.. include:: ../Plugin/_plugin_substitutions_p10x.repl
.. _P107_page:
|P107_typename|
==================================================
|P107_shortinfo|
Plugin details
--------------
Type: |P107_type|
Name: |P107_name|
Status: |P107_status|
GitHub: |P107_github|_
Maintainer: |P107_maintainer|
Used libraries: |P107_usedlibraries|
Description
-----------
.. Events
.. ~~~~~~
.. .. include:: P107_events.repl
Change log
----------
.. versionchanged:: 2.0
...
|added| 2020-04-25
docs/source/Plugin/_Plugin.rst
+6
View File
@@ -122,6 +122,12 @@ There's three different released versions of ESP Easy:
":ref:`P097_page`","|P097_status|","P097"
":ref:`P100_page`","|P100_status|","P100"
":ref:`P101_page`","|P101_status|","P101"
":ref:`P102_page`","|P102_status|","P102"
":ref:`P103_page`","|P103_status|","P103"
":ref:`P104_page`","|P104_status|","P104"
":ref:`P105_page`","|P105_status|","P105"
":ref:`P106_page`","|P106_status|","P106"
":ref:`P107_page`","|P107_status|","P107"
Internal GPIO handling
docs/source/Plugin/_plugin_categories.repl
+3 -3
View File
@@ -2,10 +2,10 @@
.. |Plugin_Communication| replace:: :ref:`P016_page`, :ref:`P020_page`, :ref:`P035_page`, :ref:`P044_page`, :ref:`P054_page`, :ref:`P071_page`, :ref:`P087_page`, :ref:`P089_page`, :ref:`P094_page`, :ref:`P101_page`
.. |Plugin_Display| replace:: :ref:`P012_page`, :ref:`P023_page`, :ref:`P036_page`, :ref:`P057_page`, :ref:`P073_page`, :ref:`P075_page`, :ref:`P095_page`
.. |Plugin_Dust| replace:: :ref:`P018_page`, :ref:`P053_page`, :ref:`P056_page`
.. |Plugin_Energy_AC| replace:: :ref:`P076_page`, :ref:`P077_page`, :ref:`P078_page`
.. |Plugin_Energy_AC| replace:: :ref:`P076_page`, :ref:`P077_page`, :ref:`P078_page`, :ref:`P102_page`
.. |Plugin_Energy_DC| replace:: :ref:`P027_page`, :ref:`P085_page`
.. |Plugin_Energy_Heat| replace:: :ref:`P088_page`, :ref:`P093_page`
.. |Plugin_Environment| replace:: :ref:`P004_page`, :ref:`P005_page`, :ref:`P006_page`, :ref:`P014_page`, :ref:`P024_page`, :ref:`P028_page`, :ref:`P030_page`, :ref:`P031_page`, :ref:`P032_page`, :ref:`P034_page`, :ref:`P039_page`, :ref:`P047_page`, :ref:`P051_page`, :ref:`P068_page`, :ref:`P069_page`, :ref:`P072_page`
.. |Plugin_Environment| replace:: :ref:`P004_page`, :ref:`P005_page`, :ref:`P006_page`, :ref:`P014_page`, :ref:`P024_page`, :ref:`P028_page`, :ref:`P030_page`, :ref:`P031_page`, :ref:`P032_page`, :ref:`P034_page`, :ref:`P039_page`, :ref:`P047_page`, :ref:`P051_page`, :ref:`P068_page`, :ref:`P069_page`, :ref:`P072_page`, :ref:`P103_page`, :ref:`P104_page`, :ref:`P105_page`, :ref:`P106_page`
.. |Plugin_Extra_IO| replace:: :ref:`P011_page`, :ref:`P022_page`
.. |Plugin_Gases| replace:: :ref:`P049_page`, :ref:`P052_page`, :ref:`P083_page`, :ref:`P090_page`
.. |Plugin_Generic| replace:: :ref:`P003_page`, :ref:`P026_page`, :ref:`P033_page`, :ref:`P037_page`, :ref:`P081_page`, :ref:`P100_page`
@@ -14,7 +14,7 @@
.. |Plugin_Hardware| replace:: :ref:`P046_page`
.. |Plugin_Keypad| replace:: :ref:`P058_page`, :ref:`P061_page`, :ref:`P062_page`, :ref:`P063_page`
.. |Plugin_Light_Color| replace:: :ref:`P050_page`, :ref:`P066_page`
.. |Plugin_Light_UV| replace:: :ref:`P084_page`
.. |Plugin_Light_UV| replace:: :ref:`P084_page`, :ref:`P107_page`
.. |Plugin_Light_Lux| replace:: :ref:`P010_page`, :ref:`P015_page`, :ref:`P074_page`
.. |Plugin_Motor| replace:: :ref:`P048_page`, :ref:`P079_page`
.. |Plugin_Notify| replace:: :ref:`P055_page`, :ref:`P065_page`
docs/source/Plugin/_plugin_substitutions_p10x.repl
+83
View File
@@ -23,3 +23,86 @@
.. |P101_maintainer| replace:: thomastech
.. |P101_compileinfo| replace:: `.`
.. |P101_usedlibraries| replace:: https://github.com/a7md0/WakeOnLan
.. |P102_name| replace:: :cyan:`PZEM-004Tv30-Multiple`
.. |P102_type| replace:: :cyan:`Energy (AC)`
.. |P102_typename| replace:: :cyan:`Energy (AC) - PZEM-004Tv30-Multiple`
.. |P102_porttype| replace:: `.`
.. |P102_status| replace:: :yellow:`TESTING`
.. |P102_github| replace:: P102_PZEM004Tv3.ino
.. _P102_github: https://github.com/letscontrolit/ESPEasy/blob/mega/src/_P102_PZEM004Tv3.ino
.. |P102_usedby| replace:: `.`
.. |P102_shortinfo| replace:: `.`
.. |P102_maintainer| replace:: TD-er
.. |P102_compileinfo| replace:: `.`
.. |P102_usedlibraries| replace:: https://github.com/olehs/PZEM004T
.. |P103_name| replace:: :cyan:`Atlas Scientific EZO pH`
.. |P103_type| replace:: :cyan:`Environment`
.. |P103_typename| replace:: :cyan:`Environment - Atlas Scientific EZO pH`
.. |P103_porttype| replace:: `.`
.. |P103_status| replace:: :yellow:`TESTING`
.. |P103_github| replace:: P103_Atlas_EZO_pH.ino
.. _P103_github: https://github.com/letscontrolit/ESPEasy/blob/mega/src/_P103_Atlas_EZO_pH.ino
.. |P103_usedby| replace:: `.`
.. |P103_shortinfo| replace:: `.`
.. |P103_maintainer| replace:: TD-er
.. |P103_compileinfo| replace:: `.`
.. |P103_usedlibraries| replace:: `.`
.. |P103_datasheet| replace:: https://atlas-scientific.com/files/pH_EZO_Datasheet.pdf
.. |P104_name| replace:: :cyan:`Atlas Scientific EC EZO`
.. |P104_type| replace:: :cyan:`Environment`
.. |P104_typename| replace:: :cyan:`Environment - Atlas Scientific EC EZO`
.. |P104_porttype| replace:: `.`
.. |P104_status| replace:: :yellow:`TESTING`
.. |P104_github| replace:: P104_Atlas_EZO_EC.ino
.. _P104_github: https://github.com/letscontrolit/ESPEasy/blob/mega/src/_P104_Atlas_EZO_EC.ino
.. |P104_usedby| replace:: `.`
.. |P104_shortinfo| replace:: `.`
.. |P104_maintainer| replace:: TD-er
.. |P104_compileinfo| replace:: `.`
.. |P104_usedlibraries| replace:: `.`
.. |P104_datasheet| replace:: https://atlas-scientific.com/files/electrically-isolated-ezo-carrier-board.pdf
.. |P105_name| replace:: :cyan:`Atlas Scientific EZO ORP`
.. |P105_type| replace:: :cyan:`Environment`
.. |P105_typename| replace:: :cyan:`Environment - Atlas Scientific EZO ORP`
.. |P105_porttype| replace:: `.`
.. |P105_status| replace:: :yellow:`TESTING`
.. |P105_github| replace:: P105_Atlas_EZO_ORP.ino
.. _P105_github: https://github.com/letscontrolit/ESPEasy/blob/mega/src/_P105_Atlas_EZO_ORP.ino
.. |P105_usedby| replace:: `.`
.. |P105_shortinfo| replace:: `.`
.. |P105_maintainer| replace:: TD-er
.. |P105_compileinfo| replace:: `.`
.. |P105_usedlibraries| replace:: `.`
.. |P105_datasheet| replace:: https://atlas-scientific.com/files/ORP_EZO_Datasheet.pdf
.. |P106_name| replace:: :cyan:`BME680`
.. |P106_type| replace:: :cyan:`Environment`
.. |P106_typename| replace:: :cyan:`Environment - BME680`
.. |P106_porttype| replace:: `.`
.. |P106_status| replace:: :yellow:`TESTING`
.. |P106_github| replace:: P106_BME680.ino
.. _P106_github: https://github.com/letscontrolit/ESPEasy/blob/mega/src/_P106_BME680.ino
.. |P106_usedby| replace:: `.`
.. |P106_shortinfo| replace:: `.`
.. |P106_maintainer| replace:: TD-er
.. |P106_compileinfo| replace:: `.`
.. |P106_usedlibraries| replace:: https://github.com/adafruit/Adafruit_BME680
.. |P107_name| replace:: :cyan:`SI1145`
.. |P107_type| replace:: :cyan:`UV`
.. |P107_typename| replace:: :cyan:`UV - SI1145`
.. |P107_porttype| replace:: `.`
.. |P107_status| replace:: :yellow:`TESTING`
.. |P107_github| replace:: P107_Si1145.ino
.. _P107_github: https://github.com/letscontrolit/ESPEasy/blob/mega/src/_P107_Si1145.ino
.. |P107_usedby| replace:: `.`
.. |P107_shortinfo| replace:: `.`
.. |P107_maintainer| replace:: TD-er
.. |P107_compileinfo| replace:: `.`
.. |P107_usedlibraries| replace:: https://github.com/adafruit/Adafruit_SI1145_Library
src/Custom-sample.h
+22
View File
@@ -263,6 +263,28 @@
// #define USES_P085 // AcuDC24x
// #define USES_P086 // Receiving values according Homie convention. Works together with C014 Homie controller
// #define USES_P087 // Serial Proxy
// #define USES_P088 // HeatpumpIR
// #define USES_P089 // Ping
// #define USES_P090 // CCS811
// #define USES_P091 // SerSwitch
// #define USES_P092 // DLbus
// #define USES_P093 // MitsubishiHP
// #define USES_P094 // CULReader
// #define USES_P095 // ILI9341
// #define USES_P096 // eInk
// #define USES_P097 // ESP32Touch
// #define USES_P098 //
// #define USES_P099 //
// #define USES_P100 // DS2423 counter
// #define USES_P101 // WakeOnLan
// #define USES_P102 // PZEM004Tv3
// #define USES_P103 // Atlas_EZO_pH
// #define USES_P104 // Atlas_EZO_EC
// #define USES_P105 // Atlas_EZO_ORP
// #define USES_P106 // BME680
// #define USES_P107 // Si1145
// Special plugins needing IR library