From 233aa62403dc2972a4e92d9bc80d58d785b3d2ae Mon Sep 17 00:00:00 2001 From: Gijs Noorlander Date: Thu, 9 Apr 2020 15:51:19 +0200 Subject: [PATCH] [CUL Reader] Add basic docs --- docs/source/Plugin/P094.rst | 48 +++++++++++++++++++ docs/source/Plugin/P094_commands.repl | 13 +++++ docs/source/Plugin/_Plugin.rst | 1 + docs/source/Plugin/_plugin_categories.repl | 2 +- .../Plugin/_plugin_substitutions_p09x.repl | 12 +++++ 5 files changed, 75 insertions(+), 1 deletion(-) create mode 100644 docs/source/Plugin/P094.rst create mode 100644 docs/source/Plugin/P094_commands.repl diff --git a/docs/source/Plugin/P094.rst b/docs/source/Plugin/P094.rst new file mode 100644 index 000000000..369efb2a2 --- /dev/null +++ b/docs/source/Plugin/P094.rst @@ -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 `_ + + +Supported hardware +------------------ + +|P094_usedby| + +Commands available +^^^^^^^^^^^^^^^^^^ + +.. include:: P094_commands.repl + + + +Change log +---------- + +.. versionchanged:: 2.0 + ... + + |added| 2020-04-09 diff --git a/docs/source/Plugin/P094_commands.repl b/docs/source/Plugin/P094_commands.repl new file mode 100644 index 000000000..4b4dd6f2b --- /dev/null +++ b/docs/source/Plugin/P094_commands.repl @@ -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' + + " + \ No newline at end of file diff --git a/docs/source/Plugin/_Plugin.rst b/docs/source/Plugin/_Plugin.rst index 79b9bbfed..3de0f2c1e 100644 --- a/docs/source/Plugin/_Plugin.rst +++ b/docs/source/Plugin/_Plugin.rst @@ -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 diff --git a/docs/source/Plugin/_plugin_categories.repl b/docs/source/Plugin/_plugin_categories.repl index c50ab6cd7..3e322870a 100644 --- a/docs/source/Plugin/_plugin_categories.repl +++ b/docs/source/Plugin/_plugin_categories.repl @@ -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` diff --git a/docs/source/Plugin/_plugin_substitutions_p09x.repl b/docs/source/Plugin/_plugin_substitutions_p09x.repl index d68fd431d..3b969790f 100644 --- a/docs/source/Plugin/_plugin_substitutions_p09x.repl +++ b/docs/source/Plugin/_plugin_substitutions_p09x.repl @@ -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:: `.` \ No newline at end of file