New html theme

.github/workflows/build.yml

@@ -17,7 +17,7 @@ jobs:
         run: sudo apt-get install doxygen libsnmp-dev python3-pip texlive-latex-recommended texlive-fonts-recommended tex-gyre texlive-latex-extra latexmk
 
       - name: Install Python dependencies
-        run: pip3 install -r ${{github.workspace}}/doc/doc_requirements.txt
+        run: pip3 install -r ${{github.workspace}}/doc/requirements.txt
 
       - name: Show Python dependencies
         run: pip3 freeze

.gitignore

@@ -10,6 +10,10 @@ doc/_copied
 .cproject
 .project
 
+
+# Python files
+*env*
+
 # Object files
 *.o
 *.ko

CHANGELOG.md

@@ -6,120 +6,120 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 ## [Unreleased]
 
 ## 2021-03-31
-### Changed
+**Changed**
 - Update GSDML file to conformance class B
 
 ## 2021-03-24
-### Added
+**Added**
 - Possibility to configure number of ports, without recompiling.
 
 ## 2021-03-03
-### Changed
+**Changed**
 - Set thread priority and stack size via configuration
 
 ## 2021-02-19
-### Changed
+**Changed**
 - Split options.h into two files.
 - Simplify configuration
 
 ## 2020-02-03
-### Added
+**Added**
  - Improved support for multiple ports
 
 ## 2021-01-29
-### Changed
+**Changed**
  - Move remaining Linux sample app files to src/ports/linux
 
 ## 2020-01-11
-### Added
+**Added**
  - Support for multiple ports
 
 ## 2021-01-05
-### Added
+**Added**
  - Additional API functions for low-level diagnostic handling
 
 ## 2020-12-22
-### Changed
+**Changed**
  - Remove link status from configuration
 
 ## 2020-12-15
-### Changed
+**Changed**
  - Use Profinet version 2.4 for the GSDML file
  - Changed default installation path for sample_app on Raspberry Pi
 
 ## 2020-12-11
-### Added
+**Added**
  - Runtime data for multiple ports
  - Functionality to search for scripts in multiple locations for Linux
 
 ## 2020-12-07
-### Changed
+**Changed**
  - Rename pnet_set_state() to pnet_set_primary_state()
 
 ## 2020-12-01
-### Added
+**Added**
 - Changed informative callbacks to be void-functions.
 
 ## 2020-11-30
-### Added
+**Added**
 - SNMP functionality for Linux
 
 ## 2020-11-20
-### Added
+**Added**
 - Additional log level FATAL
 
 ## 2020-11-19
-### Added
+**Added**
 - SNMP functionality for rt-kernel
 
 ## 2020-11-16
-### Added
+**Added**
 - Support for multiple ports in configuration
 
 ## 2020-11-10
-### Changed
+**Changed**
 - Remove LLDP TTL from configuration
 - Remove LLDP chassis ID from configuration
 
 ## 2020-11-03
-### Changed
+**Changed**
 - Improve API for adding diagnosis
 - Use rtlabs-com/osal and rtlabs-com/cmake-tools as submodules
 
 ## 2020-10-28
-### Changed
+**Changed**
 - Rename compile time constants for number of slots and subslots
 
 ## 2020-09-19
-### Changed
+**Changed**
 - Modified public API for sending alarm ACK.
 
 ## 2020-08-24
-### Changed
+**Changed**
 - Renamed configuration members related to I&M data
 
 ## 2020-08-18
-### Added
+**Added**
 - Add min_device_interval to the configuration
 - Use cmake to set configurable build options
 
 ## 2020-06-15
-### Added
+**Added**
 - New user callback for LED state change.
 
 ## 2020-06-11
-### Added
+**Added**
 - New API function for application to perform a factory reset
 
 ## 2020-04-09
-### Added
+**Added**
 - New user callback to indicate reset requests from the IO-controller.
 
 ## 2020-04-06
-### Changed
+**Changed**
 - Changed the user API to use a handle to the p-net stack, and to allow user
   arguments to callbacks.
 
 ## 2020-03-27
-### Changed
+**Changed**
 - Read MAC address also from Linux hardware.

doc/CMakeLists.txt

@@ -22,7 +22,7 @@ if (DOXYGEN_FOUND)
 
   # Doxygen configuration
   set(DOXYGEN_OPTIMIZE_OUTPUT_FOR_C YES)
-  set(DOXYGEN_TYPEDEF_HIDES_STRUCT NO)
+  set(DOXYGEN_TYPEDEF_HIDES_STRUCT YES)
   set(DOXYGEN_EXTRACT_ALL YES)
   set(DOXYGEN_EXTRACT_STATIC YES)
   set(DOXYGEN_STRIP_CODE_COMMENTS NO)
@@ -47,6 +47,7 @@ if (DOXYGEN_FOUND)
     README.md
     include/pnet_api.h
     src/pnal.h
+    src/drivers/lan9662/include/pnet_lan9662_api.h
     )
 endif()
 
@@ -86,6 +87,17 @@ if (SPHINX_FOUND AND DOXYGEN_FOUND)
   add_sphinx_builder(sphinx-spelling spelling)
   add_sphinx_builder(sphinx-linkcheck linkcheck)
   add_sphinx_builder(sphinx-pdf latexpdf)
+  add_dependencies(sphinx-html remove_badge_svg_images)
   add_dependencies(sphinx-pdf remove_badge_svg_images)
 
+    # Zip the documentation
+  message("p-net revision: ${PROFINET_GIT_REVISION}")
+  add_custom_command(
+    TARGET sphinx-html POST_BUILD
+    COMMAND zip -FS -r pnet_docs_${PROFINET_GIT_REVISION}.zip sphinx/html/ > /dev/null
+    COMMAND echo "The Sphinx HTML and ZIP files are located in ${CMAKE_CURRENT_BINARY_DIR}"
+    BYPRODUCTS ${CMAKE_CURRENT_BINARY_DIR}/pnet_docs_${PROFINET_GIT_REVISION}.zip
+    WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
+    COMMENT "Zipping HTML documentation")
+
 endif()

doc/README.txt

@@ -0,0 +1,12 @@
+To build the documentation, it is important to use the sphinx-build script
+installed in your virtual environment.
+Use CMAKE_IGNORE_PATH to prevent cmake from using a script installed elsewhere
+
+Run these commands (adapt to your needs):
+
+python3 -m venv myvenv
+source myvenv/bin/activate
+pip3 install -r doc/requirements.txt
+
+cmake -B build -DCMAKE_IGNORE_PATH:PATH=$HOME/.local/bin
+cmake --build build/ --target sphinx-html

doc/abbreviations.rst

@@ -1,5 +1,3 @@
-.. _abbreviations:
-
 Terminology and abbreviations
 =============================
 

doc/api_documentation.rst

@@ -109,17 +109,17 @@ to perform specific functionality.
 
 Selected enums
 --------------
-.. doxygenenum:: pnet_event_values
-.. doxygenenum:: pnet_ioxs_values
-.. doxygenenum:: pnet_submodule_dir
-.. doxygenenum:: pnet_control_command
-.. doxygenenum:: pnet_data_status_bits
-.. doxygenenum:: pnet_diag_ch_prop_type_values
-.. doxygenenum:: pnet_diag_ch_prop_dir_values
-.. doxygenenum:: pnet_diag_ch_prop_maint_values
-.. doxygenenum:: pnet_diag_ch_group_values
-.. doxygenenum:: pnet_im_supported_values
-.. doxygenenum:: pnal_eth_mau
+.. doxygenenum:: pnet_event_values_t
+.. doxygenenum:: pnet_ioxs_values_t
+.. doxygenenum:: pnet_submodule_dir_t
+.. doxygenenum:: pnet_control_command_t
+.. doxygenenum:: pnet_data_status_bits_t
+.. doxygenenum:: pnet_diag_ch_prop_type_values_t
+.. doxygenenum:: pnet_diag_ch_prop_dir_values_t
+.. doxygenenum:: pnet_diag_ch_prop_maint_values_t
+.. doxygenenum:: pnet_diag_ch_group_values_t
+.. doxygenenum:: pnet_im_supported_values_t
+.. doxygenenum:: pnal_eth_mau_t
 
 
 Selected structs
@@ -133,54 +133,66 @@ Along with the configuration the initial (default) values of the
 I&M data records are conveyed as well as the values used for
 sending LLDP frames.
 
-.. doxygenstruct:: pnet_im_0
+.. doxygenstruct:: pnet_im_0_t
    :members:
    :undoc-members:
 
-.. doxygenstruct:: pnet_im_1
+.. doxygenstruct:: pnet_im_1_t
    :members:
    :undoc-members:
 
-.. doxygenstruct:: pnet_im_2
+.. doxygenstruct:: pnet_im_2_t
    :members:
    :undoc-members:
 
-.. doxygenstruct:: pnet_im_3
+.. doxygenstruct:: pnet_im_3_t
    :members:
    :undoc-members:
 
-.. doxygenstruct:: pnet_im_4
+.. doxygenstruct:: pnet_im_4_t
    :members:
    :undoc-members:
 
-.. doxygenstruct:: pnet_cfg_device_id
+.. doxygenstruct:: pnet_cfg_device_id_t
    :members:
    :undoc-members:
 
-.. doxygenstruct:: pnet_if_cfg
+.. doxygenstruct:: pnet_if_cfg_t
    :members:
    :undoc-members:
 
-.. doxygenstruct:: pnet_port_cfg
+.. doxygenstruct:: pnet_port_cfg_t
    :members:
    :undoc-members:
 
-.. doxygenstruct:: pnet_ip_cfg
+.. doxygenstruct:: pnet_ip_cfg_t
    :members:
    :undoc-members:
 
-.. doxygenstruct:: pnet_cfg
+.. doxygenstruct:: pnet_cfg_t
    :members:
    :undoc-members:
 
-.. doxygenstruct:: pnet_alarm_spec
+.. doxygenstruct:: pnet_alarm_spec_t
    :members:
    :undoc-members:
 
-.. doxygenstruct:: pnet_alarm_argument
+.. doxygenstruct:: pnet_alarm_argument_t
    :members:
    :undoc-members:
 
-.. doxygenstruct:: pnet_diag_source
+.. doxygenstruct:: pnet_diag_source_t
+   :members:
+   :undoc-members:
+
+.. doxygenstruct:: pnet_result_t
+   :members:
+   :undoc-members:
+
+.. doxygenstruct:: pnet_data_cfg_t
+   :members:
+   :undoc-members:
+
+.. doxygenstruct:: pnet_pnio_status_t
    :members:
    :undoc-members:

doc/applications_and_porting.rst

@@ -9,9 +9,9 @@ If you prefer not to implement some of the callbacks, set the corresponding
 fields in the configuration struct to NULL instead of a function pointer.
 See :ref:`api-documentation` on which callbacks that are optional.
 
-To read output data from the PLC, use :c:func:`pnet_output_get_data_and_iops`.
+To read output data from the PLC, use :cpp:func:`pnet_output_get_data_and_iops`.
 To write data to the PLC (which is input data in Profinet terminology), use
-:c:func:`pnet_input_set_data_and_iops`.
+:cpp:func:`pnet_input_set_data_and_iops`.
 
 
 Adapting to other hardware

doc/compliancetest.rst

@@ -915,8 +915,8 @@ Modify this line in the :file:`/root/Netload/Scripts/Netload-Tester.sh` script::
     Delay="30s"
 
 
-Troubleshooting
----------------
+Compliance test troubleshooting
+-------------------------------
 For the :guilabel:`Get MAC Address` button in ART tester to work, you need to
 have the "Device b" connected.