[CUL Reader] Add basic docs

This commit is contained in:
Gijs Noorlander
2020-04-09 15:51:19 +02:00
parent deabb75eb7
commit 233aa62403
5 changed files with 75 additions and 1 deletions
+48
View File
@@ -0,0 +1,48 @@
.. include:: ../Plugin/_plugin_substitutions_p09x.repl
.. _P094_page:
|P094_typename|
==================================================
|P094_shortinfo|
Plugin details
--------------
Type: |P094_type|
Name: |P094_name|
Status: |P094_status|
GitHub: |P094_github|_
Maintainer: |P094_maintainer|
Used libraries: |P094_usedlibraries|
Description
-----------
This plugin is written to interact with the `CUL firmware <http://culfw.de/commandref.html>`_
Supported hardware
------------------
|P094_usedby|
Commands available
^^^^^^^^^^^^^^^^^^
.. include:: P094_commands.repl
Change log
----------
.. versionchanged:: 2.0
...
|added| 2020-04-09
+13
View File
@@ -0,0 +1,13 @@
.. csv-table::
:header: "Command", "Extra information"
:widths: 20, 30
"
``culreader_write``
","
Examples:
- ``culreader_write,brt`` Switch CULfw into Wireless M-Bus receive mode 'T'
"
+1
View File
@@ -116,6 +116,7 @@ There's three different released versions of ESP Easy:
":ref:`P090_page`","|P090_status|","P090"
":ref:`P091_page`","|P091_status|","P091"
":ref:`P093_page`","|P093_status|","P093"
":ref:`P094_page`","|P094_status|","P094"
Internal GPIO handling
+1 -1
View File
@@ -1,5 +1,5 @@
.. |Plugin_Analog_input| replace:: :ref:`P002_page`, :ref:`P007_page`, :ref:`P025_page`, :ref:`P060_page`
.. |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`
.. |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`
.. |Plugin_Display| replace:: :ref:`P012_page`, :ref:`P023_page`, :ref:`P036_page`, :ref:`P057_page`, :ref:`P073_page`, :ref:`P075_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`
@@ -34,3 +34,15 @@
.. |P093_maintainer| replace:: `crnjan`
.. |P093_compileinfo| replace:: `.`
.. |P093_usedlibraries| replace:: `.`
.. |P094_name| replace:: :cyan:`Communication - CUL Reader`
.. |P094_type| replace:: :cyan:`Communication`
.. |P094_typename| replace:: :cyan:`CUL Reader`
.. |P094_status| replace:: :yellow:`TESTING`
.. |P094_github| replace:: P094_CULReader.ino
.. _P094_github: https://github.com/letscontrolit/ESPEasy/blob/mega/src/_P094_CULReader.ino
.. |P094_usedby| replace:: `.`
.. |P094_shortinfo| replace:: `Interact with the CUL firmware`
.. |P094_maintainer| replace:: `TD-er`
.. |P094_compileinfo| replace:: `.`
.. |P094_usedlibraries| replace:: `.`