Added sphinx documentation

docs/source/DUTs.rst

@@ -0,0 +1,149 @@
+***************************
+DUTs
+***************************
+
+
+E_BATTERY_STATUS
+================================
+
+.. plc:autoenum:: E_BATTERY_STATUS
+
+E_BMS_CONTROL_MODE
+================================
+
+.. plc:autoenum:: E_BMS_CONTROL_MODE
+
+E_BMS_STATE
+================================
+
+.. plc:autoenum:: E_BMS_STATE
+
+E_CHARGE_STATUS
+================================
+
+.. plc:autoenum:: E_CHARGE_STATUS
+
+E_CYCLE_STATUS
+================================
+
+.. plc:autoenum:: E_CYCLE_STATUS
+
+E_REACTIVE_POWER_TYPE
+================================
+
+.. plc:autoenum:: E_REACTIVE_POWER_TYPE
+
+E_COMPONENT_STATUS
+================================
+
+.. plc:autoenum:: E_COMPONENT_STATUS
+
+ST_AUTO_HMI_INTERFACE
+================================
+
+.. plc:autostruct:: ST_AUTO_HMI_INTERFACE
+
+ST_MODULE_HMI_INTERFACE
+================================
+
+.. plc:autostruct:: ST_MODULE_HMI_INTERFACE
+
+ST_MODULE_VOLT_CONFIG
+================================
+
+.. plc:autostruct:: ST_MODULE_VOLT_CONFIG
+
+ST_STRING_HMI_INTERFACE
+================================
+
+.. plc:autostruct:: ST_STRING_HMI_INTERFACE
+
+ST_STRING_VOLT_CONFIG
+================================
+
+.. plc:autostruct:: ST_STRING_VOLT_CONFIG
+
+ST_UNIT_HMI_INTERFACE
+================================
+
+.. plc:autostruct:: ST_UNIT_HMI_INTERFACE
+
+ST_UNIT_CONFIG
+================================
+
+.. plc:autostruct:: ST_UNIT_CONFIG
+
+Modbus
+================================
+
+ST_EMS_MODBUS_INTERFACE
+---------------------------------
+
+.. plc:autostruct:: ST_EMS_MODBUS_INTERFACE
+
+ErrorWarningRegisters
+---------------------------------
+
+ST_DWORD_UNIT_ERROR_BITMAP
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+.. plc:autostruct:: ST_DWORD_UNIT_ERROR_BITMAP
+
+ST_DWORD_UNIT_WARNING_BITMAP
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+.. plc:autostruct:: ST_DWORD_UNIT_WARNING_BITMAP
+
+ST_WORD_BMS_ERROR_BITMAP
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+.. plc:autostruct:: ST_WORD_BMS_ERROR_BITMAP
+
+ST_WORD_BMS_WARNING_BITMAP
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+.. plc:autostruct:: ST_WORD_BMS_WARNING_BITMAP
+
+U_BMS_ERROR_REGISTER
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+.. plc:autoenum:: U_BMS_ERROR_REGISTER
+
+U_BMS_WARNING_REGISTER
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+.. plc:autoenum:: U_BMS_WARNING_REGISTER
+
+U_UNIT_ERROR_REGISTER
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+.. plc:autoenum:: U_UNIT_ERROR_REGISTER
+
+U_UNIT_WARNING_REGISTER
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+.. plc:autoenum:: U_UNIT_WARNING_REGISTER
+
+HoldingRegisters
+---------------------------------
+
+ST_MODBUS_REG_10
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+.. plc:autostruct:: ST_MODBUS_REG_10
+
+ST_MODBUS_REG_11
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+.. plc:autostruct:: ST_MODBUS_REG_11
+
+ST_MODBUS_REG_12
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+.. plc:autostruct:: ST_MODBUS_REG_12
+
+ST_MODBUS_REG_13
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+.. plc:autostruct:: ST_MODBUS_REG_13
+

docs/source/GVLs.rst

@@ -0,0 +1,20 @@
+***************************
+GVLs
+***************************
+
+
+GVL_CONFIG
+================================
+
+.. plc:autogvl:: GVL_CONFIG
+
+GVL_MODBUS
+================================
+
+.. plc:autogvl:: GVL_MODBUS
+
+GVL_SCADA
+================================
+
+.. plc:autogvl:: GVL_SCADA
+

docs/source/POUs.rst

@@ -0,0 +1,69 @@
+***************************
+POUs
+***************************
+
+
+.. plc:autofunctionblock:: FB_Module
+	:members:
+
+.. plc:autofunctionblock:: FB_PowerMeter
+
+.. plc:autofunctionblock:: FB_Safety
+
+.. plc:autofunctionblock:: FB_String
+	:members:
+
+.. plc:autofunctionblock:: FB_UMD705
+
+.. plc:autofunctionblock:: FB_Unit
+	:members:
+
+.. plc:autoprogram:: MAIN
+
+Sunspec
+================================
+
+.. plc:autofunctionblock:: FB_PowerSupplySunspec
+	:members:
+
+ST_SUNSPEC_CURRENT_VALUES
+---------------------------------
+
+.. plc:autostruct:: ST_SUNSPEC_CURRENT_VALUES
+
+U_SUNSPEC_ERROR
+---------------------------------
+
+.. plc:autoenum:: U_SUNSPEC_ERROR
+
+ModelData
+---------------------------------
+
+ST_SunspecInverterThreePhase
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+.. plc:autostruct:: ST_SunspecInverterThreePhase
+
+ST_SunspecNameplateRatings
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+.. plc:autostruct:: ST_SunspecNameplateRatings
+
+StatePattern
+---------------------------------
+
+StateEvents
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+.. plc:autofunctionblock:: I_SunspecStateEvents
+	:members:
+
+States
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+.. plc:autofunctionblock:: FB_SunspecErrorState
+	:members:
+
+.. plc:autofunctionblock:: FB_SunspecOffState
+	:members:
+

docs/source/conf.py

@@ -0,0 +1,33 @@
+# Configuration file for the Sphinx documentation builder.
+#
+# For the full list of built-in configuration values, see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+# -- Project information -----------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
+
+project = 'Uniper'
+copyright = '2025, M.Heisig'
+author = 'M.Heisig'
+
+# -- General configuration ---------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
+
+extensions = ['plcdoc', "sphinx.ext.autodoc"]
+
+plc_project = 'C:/Users/Public/Documents/uniblu/PLC/PLC.plcproj'
+
+#rst_file_destination = "C:/Users/Public/Documents/uniblu/docs/source/"
+rst_file_destination = ""
+
+templates_path = ['_templates']
+exclude_patterns = []
+
+language = 'de'
+
+# -- Options for HTML output -------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
+
+html_theme = 'sphinx_rtd_theme'
+html_static_path = ['_static']
+nitpicky = True

docs/source/index.rst

@@ -0,0 +1,10 @@
+Welcome to the Uniper documentation!
+=======================================
+
+.. toctree::
+	:maxdepth: 2
+	:caption: Contents:
+
+	DUTs
+	GVLs
+	POUs