docs: Updated the annotations for generating the S7 configuration adoc

apache · Dec 28, 2024 · 794156a · 794156a
1 parent 6544b5d
commit 794156a
Show file tree

Hide file tree

Showing 21 changed files with 26 additions and 26 deletions.
diff --git a/...rs/s7/src/main/java/org/apache/plc4x/java/s7/readwrite/configuration/S7Configuration.java b/...rs/s7/src/main/java/org/apache/plc4x/java/s7/readwrite/configuration/S7Configuration.java
@@ -113,17 +113,17 @@ public class S7Configuration implements PlcConnectionConfiguration {
 
     @ConfigurationParameter("ping")
     @BooleanDefaultValue(false)
-    @Description("Time for supervision of TCP channels. If the channel is not active, a safe stop of the EventLoop must be performed, to ensure that no additional tasks are created.")
+    @Description("If your application requires sampling times greater than the set \"read-timeout\" time, it is important that the PING option is activated, this will prevent the TCP channel from being closed unnecessarily.")
     public boolean ping = false;
 
     @ConfigurationParameter("ping-time")
     @IntDefaultValue(0)
-    @Description("If your application requires sampling times greater than the set \"read-timeout\" time, it is important that the PING option is activated, this will prevent the TCP channel from being closed unnecessarily.")
+    @Description("Time value in seconds at which the execution of the PING will be scheduled. Generally set by developer experience, but generally should be the same as (read-timeout / 2).")
     public int pingTime = 0;
 
     @ConfigurationParameter("retry-time")
     @IntDefaultValue(0)
-    @Description("Time value in seconds at which the execution of the PING will be scheduled. Generally set by developer experience, but generally should be the same as (read-timeout / 2).")
+    @Description("Time for supervision of TCP channels. If the channel is not active, a safe stop of the EventLoop must be performed, to ensure that no additional tasks are created.")
     public int retryTime = 0;
 
     public int getLocalRack() {

diff --git a/website/generated/ab-eth.adoc b/website/generated/ab-eth.adoc
@@ -29,7 +29,7 @@
 <dependency>
   <groupId>org.apache.plc4x</groupId>
   <artifactId>plc4j-driver-ab-eth</artifactId>
-  <version>{current-last-released-version}</version>
+  <version>{page-component-version}</version>
 </dependency>
 ----
 |Default Transport 4+|`raw`

diff --git a/website/generated/ads.adoc b/website/generated/ads.adoc
@@ -29,7 +29,7 @@
 <dependency>
   <groupId>org.apache.plc4x</groupId>
   <artifactId>plc4j-driver-ads</artifactId>
-  <version>{current-last-released-version}</version>
+  <version>{page-component-version}</version>
 </dependency>
 ----
 |Default Transport 4+|`tcp`

diff --git a/website/generated/bacnet-ip.adoc b/website/generated/bacnet-ip.adoc
@@ -29,7 +29,7 @@
 <dependency>
   <groupId>org.apache.plc4x</groupId>
   <artifactId>plc4j-driver-bacnet</artifactId>
-  <version>{current-last-released-version}</version>
+  <version>{page-component-version}</version>
 </dependency>
 ----
 |Default Transport 4+|`udp`

diff --git a/website/generated/c-bus.adoc b/website/generated/c-bus.adoc
@@ -29,7 +29,7 @@
 <dependency>
   <groupId>org.apache.plc4x</groupId>
   <artifactId>plc4j-driver-c-bus</artifactId>
-  <version>{current-last-released-version}</version>
+  <version>{page-component-version}</version>
 </dependency>
 ----
 |Default Transport 4+|`tcp`

diff --git a/website/generated/canopen.adoc b/website/generated/canopen.adoc
@@ -29,7 +29,7 @@
 <dependency>
   <groupId>org.apache.plc4x</groupId>
   <artifactId>plc4j-driver-canopen</artifactId>
-  <version>{current-last-released-version}</version>
+  <version>{page-component-version}</version>
 </dependency>
 ----
 |Default Transport 4+|`socketcan`

diff --git a/website/generated/eip.adoc b/website/generated/eip.adoc
@@ -29,7 +29,7 @@
 <dependency>
   <groupId>org.apache.plc4x</groupId>
   <artifactId>plc4j-driver-eip</artifactId>
-  <version>{current-last-released-version}</version>
+  <version>{page-component-version}</version>
 </dependency>
 ----
 |Default Transport 4+|`tcp`

diff --git a/website/generated/firmata.adoc b/website/generated/firmata.adoc
@@ -29,7 +29,7 @@
 <dependency>
   <groupId>org.apache.plc4x</groupId>
   <artifactId>plc4j-driver-firmata</artifactId>
-  <version>{current-last-released-version}</version>
+  <version>{page-component-version}</version>
 </dependency>
 ----
 |Default Transport 4+|`serial`

diff --git a/website/generated/genericcan.adoc b/website/generated/genericcan.adoc
@@ -29,7 +29,7 @@
 <dependency>
   <groupId>org.apache.plc4x</groupId>
   <artifactId>plc4j-driver-can</artifactId>
-  <version>{current-last-released-version}</version>
+  <version>{page-component-version}</version>
 </dependency>
 ----
 |Default Transport 4+|`socketcan`

diff --git a/website/generated/iec-60870-5-104.adoc b/website/generated/iec-60870-5-104.adoc
@@ -29,7 +29,7 @@
 <dependency>
   <groupId>org.apache.plc4x</groupId>
   <artifactId>plc4j-driver-iec-60870</artifactId>
-  <version>{current-last-released-version}</version>
+  <version>{page-component-version}</version>
 </dependency>
 ----
 |Default Transport 4+|`tcp`

diff --git a/website/generated/knxnet-ip.adoc b/website/generated/knxnet-ip.adoc
@@ -29,7 +29,7 @@
 <dependency>
   <groupId>org.apache.plc4x</groupId>
   <artifactId>plc4j-driver-knxnetip</artifactId>
-  <version>{current-last-released-version}</version>
+  <version>{page-component-version}</version>
 </dependency>
 ----
 |Default Transport 4+|`udp`

diff --git a/website/generated/logix.adoc b/website/generated/logix.adoc
@@ -29,7 +29,7 @@
 <dependency>
   <groupId>org.apache.plc4x</groupId>
   <artifactId>plc4j-driver-eip</artifactId>
-  <version>{current-last-released-version}</version>
+  <version>{page-component-version}</version>
 </dependency>
 ----
 |Default Transport 4+|`tcp`

diff --git a/website/generated/modbus-ascii.adoc b/website/generated/modbus-ascii.adoc
@@ -29,7 +29,7 @@
 <dependency>
   <groupId>org.apache.plc4x</groupId>
   <artifactId>plc4j-driver-modbus</artifactId>
-  <version>{current-last-released-version}</version>
+  <version>{page-component-version}</version>
 </dependency>
 ----
 |Default Transport 4+|`serial`

diff --git a/website/generated/modbus-rtu.adoc b/website/generated/modbus-rtu.adoc
@@ -29,7 +29,7 @@
 <dependency>
   <groupId>org.apache.plc4x</groupId>
   <artifactId>plc4j-driver-modbus</artifactId>
-  <version>{current-last-released-version}</version>
+  <version>{page-component-version}</version>
 </dependency>
 ----
 |Default Transport 4+|`serial`

diff --git a/website/generated/modbus-tcp.adoc b/website/generated/modbus-tcp.adoc
@@ -29,7 +29,7 @@
 <dependency>
   <groupId>org.apache.plc4x</groupId>
   <artifactId>plc4j-driver-modbus</artifactId>
-  <version>{current-last-released-version}</version>
+  <version>{page-component-version}</version>
 </dependency>
 ----
 |Default Transport 4+|`tcp`

diff --git a/website/generated/opcua.adoc b/website/generated/opcua.adoc
@@ -29,7 +29,7 @@
 <dependency>
   <groupId>org.apache.plc4x</groupId>
   <artifactId>plc4j-driver-opcua</artifactId>
-  <version>{current-last-released-version}</version>
+  <version>{page-component-version}</version>
 </dependency>
 ----
 |Default Transport 4+|`tcp`

diff --git a/website/generated/open-protocol.adoc b/website/generated/open-protocol.adoc
@@ -29,7 +29,7 @@
 <dependency>
   <groupId>org.apache.plc4x</groupId>
   <artifactId>plc4j-driver-open-protocol</artifactId>
-  <version>{current-last-released-version}</version>
+  <version>{page-component-version}</version>
 </dependency>
 ----
 |Default Transport 4+|`tcp`

diff --git a/website/generated/plc4x.adoc b/website/generated/plc4x.adoc
@@ -29,7 +29,7 @@
 <dependency>
   <groupId>org.apache.plc4x</groupId>
   <artifactId>plc4j-driver-plc4x</artifactId>
-  <version>{current-last-released-version}</version>
+  <version>{page-component-version}</version>
 </dependency>
 ----
 |Default Transport 4+|`tcp`

diff --git a/website/generated/profinet.adoc b/website/generated/profinet.adoc
@@ -29,7 +29,7 @@
 <dependency>
   <groupId>org.apache.plc4x</groupId>
   <artifactId>plc4j-driver-profinet-ng</artifactId>
-  <version>{current-last-released-version}</version>
+  <version>{page-component-version}</version>
 </dependency>
 ----
 |Default Transport 4+|`raw`

diff --git a/website/generated/s7.adoc b/website/generated/s7.adoc
@@ -29,7 +29,7 @@
 <dependency>
   <groupId>org.apache.plc4x</groupId>
   <artifactId>plc4j-driver-s7</artifactId>
-  <version>{current-last-released-version}</version>
+  <version>{page-component-version}</version>
 </dependency>
 ----
 |Default Transport 4+|`tcp`
@@ -71,9 +71,9 @@ Allowed values: +
 - S7-1500 +
 - LOGO
 |`read-timeout` |INT |0| |This is the maximum waiting time for reading on the TCP channel. As there is no traffic, it must be assumed that the connection with the interlocutor was lost and it must be restarted. When the channel is closed, the "fail over" is carried out in case of having the secondary channel, or it is expected that it will be restored automatically, which is done every 4 seconds.
-|`ping` |BOOLEAN |false| |Time for supervision of TCP channels. If the channel is not active, a safe stop of the EventLoop must be performed, to ensure that no additional tasks are created.
-|`ping-time` |INT |0| |If your application requires sampling times greater than the set "read-timeout" time, it is important that the PING option is activated, this will prevent the TCP channel from being closed unnecessarily.
-|`retry-time` |INT |0| |Time value in seconds at which the execution of the PING will be scheduled. Generally set by developer experience, but generally should be the same as (read-timeout / 2).
+|`ping` |BOOLEAN |false| |If your application requires sampling times greater than the set "read-timeout" time, it is important that the PING option is activated, this will prevent the TCP channel from being closed unnecessarily.
+|`ping-time` |INT |0| |Time value in seconds at which the execution of the PING will be scheduled. Generally set by developer experience, but generally should be the same as (read-timeout / 2).
+|`retry-time` |INT |0| |Time for supervision of TCP channels. If the channel is not active, a safe stop of the EventLoop must be performed, to ensure that no additional tasks are created.
 5+|Transport config options:
 5+|
 +++

diff --git a/website/generated/simulated.adoc b/website/generated/simulated.adoc
@@ -29,7 +29,7 @@
 <dependency>
   <groupId>org.apache.plc4x</groupId>
   <artifactId>plc4j-driver-simulated</artifactId>
-  <version>{current-last-released-version}</version>
+  <version>{page-component-version}</version>
 </dependency>
 ----
 |Supported Transports 4+|