From 4938cbee319387d11479e0eb5ecc4a196168e227 Mon Sep 17 00:00:00 2001
From: Alex Lisitsyn <aleks@espressif.com>
Date: Fri, 20 Sep 2024 21:14:34 +0800
Subject: [PATCH] fix build docs, fix extended types enable option v1

---
 docs/_static/diag_frame.diag                  |  6 +-
 docs/_static/modbus_docs_versions.js          |  6 +-
 docs/_static/modbus_frame_examples.diag       | 60 +++++++++----------
 docs/generate_docs                            | 16 ++++-
 docs/requirements.txt                         |  3 +-
 freemodbus/common/include/esp_modbus_common.h |  4 +-
 freemodbus/common/include/esp_modbus_master.h |  4 +-
 7 files changed, 57 insertions(+), 42 deletions(-)

diff --git a/docs/_static/diag_frame.diag b/docs/_static/diag_frame.diag
index f27add3..5ba19c6 100644
--- a/docs/_static/diag_frame.diag
+++ b/docs/_static/diag_frame.diag
@@ -2,10 +2,10 @@
 
 blockdiag mb_float_frame {
     # global properties
-    span_width = 2;
+    span_width = 5;
     span_height = 5;
-    node_height = 25;
-    default_fontsize = 16;
+    node_height = 30;
+    default_fontsize = 15;
     default_group_color = lightgrey;
     class spacer [shape=none, width=10];
     # tuning node properties and connections
diff --git a/docs/_static/modbus_docs_versions.js b/docs/_static/modbus_docs_versions.js
index 37a2cda..cc50de1 100644
--- a/docs/_static/modbus_docs_versions.js
+++ b/docs/_static/modbus_docs_versions.js
@@ -1,6 +1,6 @@
 var DOCUMENTATION_VERSIONS = {
     VERSIONS: [
-        { name: "latest", has_targets: true, supported_targets: [ "esp32", "esp32s2", "esp32s3", "esp32c2", "esp32c3", "esp32c6", "esp32h2" ] },
+        { name: "latest", has_targets: true, supported_targets: [ "esp32", "esp32s2", "esp32s3", "esp32c2", "esp32c3", "esp32c6", "esp32h2", "esp32p4", "esp32c5" ] },
     ],
     IDF_TARGETS: [
        { text: "ESP32", value: "esp32"},
@@ -9,6 +9,8 @@ var DOCUMENTATION_VERSIONS = {
        { text: "ESP32-C2", value: "esp32c2"},
        { text: "ESP32-C3", value: "esp32c3"},
        { text: "ESP32-C6", value: "esp32c6"},
-       { text: "ESP32-H2", value: "esp32h2"}
+       { text: "ESP32-H2", value: "esp32h2"},
+       { text: "ESP32-P4", value: "esp32p4"},
+       { text: "ESP32-C5", value: "esp32c5"}
     ]
 };
diff --git a/docs/_static/modbus_frame_examples.diag b/docs/_static/modbus_frame_examples.diag
index acef030..c9eb2a2 100644
--- a/docs/_static/modbus_frame_examples.diag
+++ b/docs/_static/modbus_frame_examples.diag
@@ -4,7 +4,7 @@ blockdiag mb_master_frames {
         # global properties
         span_width = 5;
         span_height = 5;
-        node_height = 25;
+        node_height = 30;
         default_group_color = lightgrey;
         default_fontsize = 15;
         # tuning node properties and connections
@@ -29,33 +29,33 @@ blockdiag mb_master_frames {
             style = dashed;
             64bit_notes;
         }
-        16bit_notes[label="UINT16, INT16 VALUE = 0x3039 = (uint16_t)12345", width=600, color=orange, shape = roundedbox];
-        req_u16_hd1[label= "TX:| UID | FC | REG_START | REG_LEN | CRC   |", color=lightyellow, width=380, colwidth=2, shape = roundedbox ,group=16bit_packets];
-        req_u16_frm1[label="TX:| 01  | 03 | 00 04 | 00 02 | 85 CA |", color=lightgrey, width=380, colwidth=2,group=16bit_packets];
-        rsp_u16_hd1[label= "RX:| UID | FC | LEN | UINT16_AB1 | UINT16_AB2 | CRC   |", color=lightyellow, width=380, colwidth=2, shape = roundedbox ,group=16bit_packets];
-        rsp_u16_frm1[label="RX:| 01  | 03 | 04 | 30 39 | 30 39 | F1 2C |", color=lightgrey, width=380, colwidth=2,group=16bit_packets];
-        rsp_u16_hd2[label= "RX:| UID | FC | LEN | UINT16_BA1 | UINT16_BA2 | CRC   |\n ", color=lightyellow, width=380, colwidth=2, shape = roundedbox, group=16bit_packets];
-        rsp_u16_frm2[label="RX:| 01  | 03 | 04 | 39 30 | 39 30 | E4 E4 |\n", color=lightgrey, width=380, colwidth=2,group=16bit_packets];
-        32bit_notes[label="(UINT32, INT32) FLOAT32 VALUE = 0x4640e400 = 12345.0", width=600, color=lightgreen, shape = roundedbox];
-        req_fl_hd1[label= "TX:| UID | FC | REG_START | REG_LEN | CRC   |", color=lightyellow, width=380, colwidth=2, shape = roundedbox ,group=32bit_packets];
-        req_fl_frm1[label="TX:| 01  | 03 | 00 XX | 00 04 | C5 CB |", color=lightgrey, width=380, colwidth=2,group=32bit_packets];
-        rsp_fl_hd1[label= "RX:| UID | FC | LEN | FLOAT_ABCD1 | FLOAT_ABCD2 | CRC   |", color=lightyellow, width=380, colwidth=2, shape = roundedbox ,group=32bit_packets];
-        rsp_fl_frm1[label="RX:| 01  | 03 | 08 | E4 00 46 40 | E4 00 46 40 | 90 65 |", color=lightgrey, width=380, colwidth=2,group=32bit_packets];
-        rsp_fl_hd2[label= "RX:| UID | FC | LEN | FLOAT_CDAB1 | FLOAT_CDAB2 | CRC   |\n ", color=lightyellow, width=380, colwidth=2, shape = roundedbox, group=32bit_packets];
-        rsp_fl_frm2[label="RX:| 01  | 03 | 08 | 46 40 E4 00 | 46 40 E4 00 | 18 71 |\n", color=lightgrey, width=380, colwidth=2,group=32bit_packets];
-        rsp_fl_hd3[label= "RX:| UID | FC | LEN | FLOAT_BADC1 | FLOAT_BADC2 | CRC   |\n ", color=lightyellow, width=380, colwidth=2, shape = roundedbox, group=32bit_packets];
-        rsp_fl_frm3[label="RX:| 01  | 03 | 08 | 00 E4 40 46 | 00 E4 40 46 | 46 D3 |\n", color=lightgrey, width=380, colwidth=2,group=32bit_packets];
-        rsp_fl_hd4[label= "RX:| UID | FC | LEN | FLOAT_DCAB1 | FLOAT_DCAB2 | CRC   |\n ", color=lightyellow, width=380, colwidth=2, shape = roundedbox, group=32bit_packets];
-        rsp_fl_frm4[label="RX:| 01  | 03 | 08 | 40 46 00 E4 | 40 46 00 E4 | 32 6B |\n", color=lightgrey, width=380, colwidth=2,group=32bit_packets];
-        64bit_notes[label="(UINT64, INT64) FLOAT64 VALUE = 0x40c81c8000000000 = 12345.0", width=600, color=lightblue, shape = roundedbox];
-        req_dbl_hd1[label= "TX:| UID | FC | REG_START | REG_LEN | CRC   |", color=lightyellow, width=380, colwidth=2, shape = roundedbox ,group=64bit_packets];
-        req_dbl_frm1[label="TX:| 01  | 03 | 00 28 | 00 08 | C4 04 |", color=lightgrey, width=380, colwidth=2,group=64bit_packets];
-        rsp_dbl_hd1[label= "RX:| UID | FC | LEN | DOUBLE_ABCDEFGH1 | DOUBLE_ABCDEFGH2 | CRC   |", color=lightyellow, width=380, colwidth=2, shape = roundedbox ,group=64bit_packets];
-        rsp_dbl_frm1[label="RX:| 01  | 03 | 10 | 00 00 00 00 1C 80 40 C8 | 00 00 00 00 1C 80 40 C8 | 9F 4B |", color=lightgrey, width=380, colwidth=2,group=64bit_packets];
-        rsp_dbl_hd2[label= "RX:| UID | FC | LEN | DOUBLE_HGFEDCBA1 | DOUBLE_HGFEDCBA2 | CRC   |\n ", color=lightyellow, width=380, colwidth=2, shape = roundedbox, group=64bit_packets];
-        rsp_dbl_frm2[label="RX:| 01  | 03 | 10 | C8 40 80 1C 00 00 00 00 | C8 40 80 1C 00 00 00 00 | DF D3 |\n", color=lightgrey, width=380, colwidth=2,group=64bit_packets];
-        rsp_dbl_hd3[label= "RX:| UID | FC | LEN | DOUBLE_GHEFCDAB1 | DOUBLE_GHEFCDAB2 | CRC   |\n ", color=lightyellow, width=380, colwidth=2, shape = roundedbox, group=64bit_packets];
-        rsp_dbl_frm3[label="RX:| 01  | 03 | 10 | 40 C8 1C 80 00 00 00 00 | 40 C8 1C 80 00 00 00 00 | B1 9C |\n", color=lightgrey, width=380, colwidth=2,group=64bit_packets];
-        rsp_dbl_hd4[label= "RX:| UID | FC | LEN | DOUBLE_BADCFEHG1 | DOUBLE_BADCFEHG2 | CRC   |\n ", color=lightyellow, width=380, colwidth=2, shape = roundedbox, group=64bit_packets];
-        rsp_dbl_frm4[label="RX:| 01  | 03 | 10 | 00 00 00 00 80 1C C8 40 | 00 00 00 00 80 1C C8 40 | 86 94 |\n", color=lightgrey, width=380, colwidth=2,group=64bit_packets];
+        16bit_notes[label="(UINT16, INT16) VALUE = 0x3039 = 12345", width=600, color=orange, shape = roundedbox];
+        req_u16_hd1[label= "TX:| UID | FC | REG_START | REG_LEN | CRC   |", color=lightyellow, width=520, colwidth=2, shape = roundedbox ,group=16bit_packets];
+        req_u16_frm1[label="TX:| 01  | 03 | 00 04 | 00 02 | 85 CA |", color=lightgrey, width=540, colwidth=2,group=16bit_packets];
+        rsp_u16_hd1[label= "RX:| UID | FC | LEN | UINT16_AB1 | UINT16_AB2 | CRC   |", color=lightyellow, width=540, colwidth=2, shape = roundedbox ,group=16bit_packets];
+        rsp_u16_frm1[label="RX:| 01  | 03 | 04 | 30 39 | 30 39 | F1 2C |", color=lightgrey, width=540, colwidth=2,group=16bit_packets];
+        rsp_u16_hd2[label= "RX:| UID | FC | LEN | UINT16_BA1 | UINT16_BA2 | CRC   |\n ", color=lightyellow, width=540, colwidth=2, shape = roundedbox, group=16bit_packets];
+        rsp_u16_frm2[label="RX:| 01  | 03 | 04 | 39 30 | 39 30 | E4 E4 |\n", color=lightgrey, width=540, colwidth=2,group=16bit_packets];
+        32bit_notes[label="(UINT32, INT32, FLOAT32) VALUE = 0x4640e400 = 12345.0", width=600, color=lightgreen, shape = roundedbox];
+        req_fl_hd1[label= "TX:| UID | FC | REG_START | REG_LEN | CRC   |", color=lightyellow, width=540, colwidth=2, shape = roundedbox ,group=32bit_packets];
+        req_fl_frm1[label="TX:| 01  | 03 | 00 XX | 00 04 | C5 CB |", color=lightgrey, width=540, colwidth=2,group=32bit_packets];
+        rsp_fl_hd1[label= "RX:| UID | FC | LEN | FLOAT_ABCD1 | FLOAT_ABCD2 | CRC   |", color=lightyellow, width=540, colwidth=2, shape = roundedbox ,group=32bit_packets];
+        rsp_fl_frm1[label="RX:| 01  | 03 | 08 | E4 00 46 40 | E4 00 46 40 | 90 65 |", color=lightgrey, width=540, colwidth=2,group=32bit_packets];
+        rsp_fl_hd2[label= "RX:| UID | FC | LEN | FLOAT_CDAB1 | FLOAT_CDAB2 | CRC   |\n ", color=lightyellow, width=540, colwidth=2, shape = roundedbox, group=32bit_packets];
+        rsp_fl_frm2[label="RX:| 01  | 03 | 08 | 46 40 E4 00 | 46 40 E4 00 | 18 71 |\n", color=lightgrey, width=540, colwidth=2,group=32bit_packets];
+        rsp_fl_hd3[label= "RX:| UID | FC | LEN | FLOAT_BADC1 | FLOAT_BADC2 | CRC   |\n ", color=lightyellow, width=540, colwidth=2, shape = roundedbox, group=32bit_packets];
+        rsp_fl_frm3[label="RX:| 01  | 03 | 08 | 00 E4 40 46 | 00 E4 40 46 | 46 D3 |\n", color=lightgrey, width=540, colwidth=2,group=32bit_packets];
+        rsp_fl_hd4[label= "RX:| UID | FC | LEN | FLOAT_DCAB1 | FLOAT_DCAB2 | CRC   |\n ", color=lightyellow, width=540, colwidth=2, shape = roundedbox, group=32bit_packets];
+        rsp_fl_frm4[label="RX:| 01  | 03 | 08 | 40 46 00 E4 | 40 46 00 E4 | 32 6B |\n", color=lightgrey, width=540, colwidth=2,group=32bit_packets];
+        64bit_notes[label="(UINT64, INT64, FLOAT64) VALUE = 0x40c81c8000000000 = 12345.0", width=600, color=lightblue, shape = roundedbox];
+        req_dbl_hd1[label= "TX:| UID | FC | REG_START | REG_LEN | CRC   |", color=lightyellow, width=540, colwidth=2, shape = roundedbox ,group=64bit_packets];
+        req_dbl_frm1[label="TX:| 01  | 03 | 00 28 | 00 08 | C4 04 |", color=lightgrey, width=540, colwidth=2,group=64bit_packets];
+        rsp_dbl_hd1[label= "RX:| UID | FC | LEN | DOUBLE_ABCDEFGH1 | DOUBLE_ABCDEFGH2 | CRC   |", color=lightyellow, width=540, colwidth=2, shape = roundedbox ,group=64bit_packets];
+        rsp_dbl_frm1[label="RX:| 01  | 03 | 10 | 00 00 00 00 1C 80 40 C8 | 00 00 00 00 1C 80 40 C8 | 9F 4B |", color=lightgrey, width=540, colwidth=2,group=64bit_packets];
+        rsp_dbl_hd2[label= "RX:| UID | FC | LEN | DOUBLE_HGFEDCBA1 | DOUBLE_HGFEDCBA2 | CRC   |\n ", color=lightyellow, width=540, colwidth=2, shape = roundedbox, group=64bit_packets];
+        rsp_dbl_frm2[label="RX:| 01  | 03 | 10 | C8 40 80 1C 00 00 00 00 | C8 40 80 1C 00 00 00 00 | DF D3 |\n", color=lightgrey, width=540, colwidth=2,group=64bit_packets];
+        rsp_dbl_hd3[label= "RX:| UID | FC | LEN | DOUBLE_GHEFCDAB1 | DOUBLE_GHEFCDAB2 | CRC   |\n ", color=lightyellow, width=540, colwidth=2, shape = roundedbox, group=64bit_packets];
+        rsp_dbl_frm3[label="RX:| 01  | 03 | 10 | 40 C8 1C 80 00 00 00 00 | 40 C8 1C 80 00 00 00 00 | B1 9C |\n", color=lightgrey, width=540, colwidth=2,group=64bit_packets];
+        rsp_dbl_hd4[label= "RX:| UID | FC | LEN | DOUBLE_BADCFEHG1 | DOUBLE_BADCFEHG2 | CRC   |\n ", color=lightyellow, width=540, colwidth=2, shape = roundedbox, group=64bit_packets];
+        rsp_dbl_frm4[label="RX:| 01  | 03 | 10 | 00 00 00 00 80 1C C8 40 | 00 00 00 00 80 1C C8 40 | 86 94 |\n", color=lightgrey, width=540, colwidth=2,group=64bit_packets];
 }
diff --git a/docs/generate_docs b/docs/generate_docs
index d9af465..ae86890 100755
--- a/docs/generate_docs
+++ b/docs/generate_docs
@@ -1,7 +1,17 @@
 #!/bin/bash
 
-rm -rf docs
-build-docs --target esp32 --language en
+exit_if_error() {
+  local exit_code=$1
+  shift
+  [[ $exit_code ]] &&               # do nothing if no error code passed
+    ((exit_code != 0)) && {         # do nothing if error code is 0
+      printf 'ERROR: %s\n' "$@" >&2
+      exit "$exit_code"
+    }
+}
+
+rm -rf _build
+build-docs --target esp32 --language en || exit_if_error $? "Documentation build fail."
 
 # Modifes target field of html files
 ELEMENT="<script type='text/javascript'>
@@ -24,4 +34,6 @@ for FILE in ${FILES}
         echo ${ELEMENT} >> "${FILE}"
     done
 
+exit_if_error $? "Documentation build fail."
 
+echo "Documentation build ok."
diff --git a/docs/requirements.txt b/docs/requirements.txt
index 8496b7f..a92951c 100644
--- a/docs/requirements.txt
+++ b/docs/requirements.txt
@@ -1 +1,2 @@
-esp-docs>=1.8,<2.0
\ No newline at end of file
+esp-docs>=1.9.1,<2.0
+Pillow==9.5.0
diff --git a/freemodbus/common/include/esp_modbus_common.h b/freemodbus/common/include/esp_modbus_common.h
index 7c6eefc..e068d02 100644
--- a/freemodbus/common/include/esp_modbus_common.h
+++ b/freemodbus/common/include/esp_modbus_common.h
@@ -130,7 +130,7 @@ typedef union {
         uint32_t baudrate;                      /*!< Modbus baudrate */
         uart_parity_t parity;                   /*!< Modbus UART parity settings */
         uint16_t dummy_port;                    /*!< Dummy field, unused */
-    };
+    }; /*!< Modbus options version 1 */
     // TCP/UDP communication structure
     struct {
         mb_mode_type_t ip_mode;                /*!< Modbus communication mode */
@@ -139,7 +139,7 @@ typedef union {
         mb_tcp_addr_type_t ip_addr_type;       /*!< Modbus address type */
         void* ip_addr;                         /*!< Modbus address table for connection */
         void* ip_netif_ptr;                    /*!< Modbus network interface */
-    };
+    }; /*!< Modbus options version 2 */
 } mb_communication_info_t;
 
 /**
diff --git a/freemodbus/common/include/esp_modbus_master.h b/freemodbus/common/include/esp_modbus_master.h
index 7fc9079..43b187d 100644
--- a/freemodbus/common/include/esp_modbus_master.h
+++ b/freemodbus/common/include/esp_modbus_master.h
@@ -100,12 +100,12 @@ typedef union {
         int opt1;                         /*!< Parameter option1 */
         int opt2;                         /*!< Parameter option2 */
         int opt3;                         /*!< Parameter option3 */
-    };
+    }; /*!< Parameter options version 1 */
     struct {
         int min;                          /*!< Parameter minimum value */
         int max;                          /*!< Parameter maximum value */
         int step;                         /*!< Step of parameter change tracking */
-    };
+    }; /*!< Parameter options version 2 */
 } mb_parameter_opt_t;
 
 /**