You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@plc4x.apache.org by cd...@apache.org on 2024/12/28 11:53:14 UTC

(plc4x) branch develop updated: docs: Updated the annotations for generating the S7 configuration adoc

This is an automated email from the ASF dual-hosted git repository.

cdutz pushed a commit to branch develop
in repository https://gitbox.apache.org/repos/asf/plc4x.git


The following commit(s) were added to refs/heads/develop by this push:
     new 794156a7f6 docs: Updated the annotations for generating the S7 configuration adoc
794156a7f6 is described below

commit 794156a7f64e8f665d6507c9ac15230e71d4ab13
Author: Christofer Dutz <ch...@c-ware.de>
AuthorDate: Sat Dec 28 12:53:05 2024 +0100

    docs: Updated the annotations for generating the S7 configuration adoc
---
 .../plc4x/java/s7/readwrite/configuration/S7Configuration.java    | 6 +++---
 website/generated/ab-eth.adoc                                     | 2 +-
 website/generated/ads.adoc                                        | 2 +-
 website/generated/bacnet-ip.adoc                                  | 2 +-
 website/generated/c-bus.adoc                                      | 2 +-
 website/generated/canopen.adoc                                    | 2 +-
 website/generated/eip.adoc                                        | 2 +-
 website/generated/firmata.adoc                                    | 2 +-
 website/generated/genericcan.adoc                                 | 2 +-
 website/generated/iec-60870-5-104.adoc                            | 2 +-
 website/generated/knxnet-ip.adoc                                  | 2 +-
 website/generated/logix.adoc                                      | 2 +-
 website/generated/modbus-ascii.adoc                               | 2 +-
 website/generated/modbus-rtu.adoc                                 | 2 +-
 website/generated/modbus-tcp.adoc                                 | 2 +-
 website/generated/opcua.adoc                                      | 2 +-
 website/generated/open-protocol.adoc                              | 2 +-
 website/generated/plc4x.adoc                                      | 2 +-
 website/generated/profinet.adoc                                   | 2 +-
 website/generated/s7.adoc                                         | 8 ++++----
 website/generated/simulated.adoc                                  | 2 +-
 21 files changed, 26 insertions(+), 26 deletions(-)

diff --git a/plc4j/drivers/s7/src/main/java/org/apache/plc4x/java/s7/readwrite/configuration/S7Configuration.java b/plc4j/drivers/s7/src/main/java/org/apache/plc4x/java/s7/readwrite/configuration/S7Configuration.java
index 512d01f6dd..5fdb12e65d 100644
--- a/plc4j/drivers/s7/src/main/java/org/apache/plc4x/java/s7/readwrite/configuration/S7Configuration.java
+++ b/plc4j/drivers/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
index 5e168930bb..e345f4c29f 100644
--- 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
index 3412f6097c..ae4fd474d2 100644
--- 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
index 0e6150f14f..f6f6c6bcb6 100644
--- 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
index 98da125d16..b19dc5fc63 100644
--- 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
index ff87b26c63..fd9b02c874 100644
--- 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
index 9380b23e8b..1f8d2bbf1a 100644
--- 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
index 89061a08c9..551e1a2b61 100644
--- 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
index 193c38fe04..b49a50d4ad 100644
--- 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
index 8368dee5c5..982376f3f8 100644
--- 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
index 482254e81f..2e5c1435d2 100644
--- 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
index 773e9d3934..6bea88dbc3 100644
--- 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
index 22f7ebe060..0187e48935 100644
--- 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
index 589e96f7db..2c045d71da 100644
--- 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
index 0d8c3d8d10..5b4bb7c367 100644
--- 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
index 5f151091fe..7967387d35 100644
--- 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
index 164ee59d75..7291d8cf21 100644
--- 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
index 4c50a337c8..3eff6a20e0 100644
--- 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
index 116490b384..aca4434a6f 100644
--- 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
index 8b3050507a..2e730915b4 100644
--- 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
index c2ed88f83f..1bf4acf1e1 100644
--- 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+|