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/04/19 07:58:09 UTC
(plc4x) branch develop updated (57f7730899 -> 8163b9ed8f)
This is an automated email from the ASF dual-hosted git repository.
cdutz pushed a change to branch develop
in repository https://gitbox.apache.org/repos/asf/plc4x.git
from 57f7730899 build(deps): bump org.apache.commons:commons-text from 1.11.0 to 1.12.0 (#1543)
new ec66f21d24 chore: Made line-breaks in the configuration option descriptions get output as line-breaks
new 7800fd1ac1 chore: Updated vendor ids
new 8163b9ed8f feat: Added device-group options for local, remote and remote2 to the S7 config.
The 3 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails. The revisions
listed as "add" were already present in the repository and have only
been added to this reference.
Summary of changes:
.../knxnetip/readwrite/model/KnxManufacturer.go | 42 +++++++++----
plc4j/drivers/all/src/site/generated/ab-eth.adoc | 8 +--
plc4j/drivers/all/src/site/generated/ads.adoc | 18 +++---
.../drivers/all/src/site/generated/bacnet-ip.adoc | 38 ++++++------
plc4j/drivers/all/src/site/generated/c-bus.adoc | 8 +--
plc4j/drivers/all/src/site/generated/canopen.adoc | 6 +-
plc4j/drivers/all/src/site/generated/eip.adoc | 12 ++--
plc4j/drivers/all/src/site/generated/firmata.adoc | 56 ++++++++---------
.../drivers/all/src/site/generated/genericcan.adoc | 4 +-
.../all/src/site/generated/iec-60870-5-104.adoc | 8 +--
.../drivers/all/src/site/generated/knxnet-ip.adoc | 60 +++++++++---------
plc4j/drivers/all/src/site/generated/logix.adoc | 18 +++---
.../all/src/site/generated/modbus-ascii.adoc | 70 +++++++++++----------
.../drivers/all/src/site/generated/modbus-rtu.adoc | 70 +++++++++++----------
.../drivers/all/src/site/generated/modbus-tcp.adoc | 16 +++--
plc4j/drivers/all/src/site/generated/opcua.adoc | 72 +++++++++++-----------
.../all/src/site/generated/open-protocol.adoc | 6 +-
plc4j/drivers/all/src/site/generated/plc4x.adoc | 10 +--
plc4j/drivers/all/src/site/generated/profinet.adoc | 12 ++--
plc4j/drivers/all/src/site/generated/s7.adoc | 61 +++++++++++-------
.../groovy/generate-config-documentation.groovy | 4 +-
.../java/knxnetip/readwrite/KnxManufacturer.java | 7 ++-
.../readwrite/configuration/S7Configuration.java | 51 +++++++++++++--
.../java/s7/readwrite/context/S7DriverContext.java | 7 +--
.../knxnetip/readwrite/model/KnxManufacturer.cs | 27 +++++---
.../protocols/knxnetip/knx-master-data.mspec | 7 ++-
26 files changed, 396 insertions(+), 302 deletions(-)
(plc4x) 02/03: chore: Updated vendor ids
Posted by cd...@apache.org.
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
commit 7800fd1ac1f3adf36a8a2b7347557477ab84ed18
Author: Christofer Dutz <cd...@apache.org>
AuthorDate: Fri Apr 19 09:56:51 2024 +0200
chore: Updated vendor ids
---
.../knxnetip/readwrite/model/KnxManufacturer.go | 42 +++++++++++++++-------
.../java/knxnetip/readwrite/KnxManufacturer.java | 7 ++--
.../knxnetip/readwrite/model/KnxManufacturer.cs | 27 ++++++++------
.../protocols/knxnetip/knx-master-data.mspec | 7 ++--
4 files changed, 54 insertions(+), 29 deletions(-)
diff --git a/plc4go/protocols/knxnetip/readwrite/model/KnxManufacturer.go b/plc4go/protocols/knxnetip/readwrite/model/KnxManufacturer.go
index eef147cc0f..5615a293c0 100644
--- a/plc4go/protocols/knxnetip/readwrite/model/KnxManufacturer.go
+++ b/plc4go/protocols/knxnetip/readwrite/model/KnxManufacturer.go
@@ -547,7 +547,7 @@ const (
KnxManufacturer_M_AUTOMATIONPlus KnxManufacturer = 501
KnxManufacturer_M_BLUE_AND_RED KnxManufacturer = 502
KnxManufacturer_M_FROGBLUE KnxManufacturer = 503
- KnxManufacturer_M_SAVESOR KnxManufacturer = 504
+ KnxManufacturer_M_LUXIO KnxManufacturer = 504
KnxManufacturer_M_APP_TECH KnxManufacturer = 505
KnxManufacturer_M_SENSORTEC_AG KnxManufacturer = 506
KnxManufacturer_M_NYSA_TECHNOLOGY_AND_SOLUTIONS KnxManufacturer = 507
@@ -716,8 +716,9 @@ const (
KnxManufacturer_M_MARLEY_DEUTSCHLAND_GMBH KnxManufacturer = 670
KnxManufacturer_M_CREATROL KnxManufacturer = 671
KnxManufacturer_M_EUTELSAT KnxManufacturer = 672
- KnxManufacturer_M_ABB___RESERVED KnxManufacturer = 673
- KnxManufacturer_M_BUSCH_JAEGER_ELEKTRO___RESERVED KnxManufacturer = 674
+ KnxManufacturer_M_TECNIKABEL KnxManufacturer = 673
+ KnxManufacturer_M_ABB___RESERVED KnxManufacturer = 674
+ KnxManufacturer_M_BUSCH_JAEGER_ELEKTRO___RESERVED KnxManufacturer = 675
)
var KnxManufacturerValues []KnxManufacturer
@@ -1229,7 +1230,7 @@ func init() {
KnxManufacturer_M_AUTOMATIONPlus,
KnxManufacturer_M_BLUE_AND_RED,
KnxManufacturer_M_FROGBLUE,
- KnxManufacturer_M_SAVESOR,
+ KnxManufacturer_M_LUXIO,
KnxManufacturer_M_APP_TECH,
KnxManufacturer_M_SENSORTEC_AG,
KnxManufacturer_M_NYSA_TECHNOLOGY_AND_SOLUTIONS,
@@ -1398,6 +1399,7 @@ func init() {
KnxManufacturer_M_MARLEY_DEUTSCHLAND_GMBH,
KnxManufacturer_M_CREATROL,
KnxManufacturer_M_EUTELSAT,
+ KnxManufacturer_M_TECNIKABEL,
KnxManufacturer_M_ABB___RESERVED,
KnxManufacturer_M_BUSCH_JAEGER_ELEKTRO___RESERVED,
}
@@ -3959,10 +3961,14 @@ func (e KnxManufacturer) Number() uint16 {
}
case 673:
{ /* '673' */
- return 43954
+ return 731
}
case 674:
{ /* '674' */
+ return 43954
+ }
+ case 675:
+ { /* '675' */
return 43959
}
case 68:
@@ -5929,7 +5935,7 @@ func (e KnxManufacturer) Name() string {
}
case 504:
{ /* '504' */
- return "SAVESOR"
+ return "LUXIO"
}
case 505:
{ /* '505' */
@@ -6677,10 +6683,14 @@ func (e KnxManufacturer) Name() string {
}
case 673:
{ /* '673' */
- return "ABB - reserved"
+ return "TECNIKABEL"
}
case 674:
{ /* '674' */
+ return "ABB - reserved"
+ }
+ case 675:
+ { /* '675' */
return "Busch-Jaeger Elektro - reserved"
}
case 68:
@@ -7743,7 +7753,7 @@ func KnxManufacturerByValue(value uint16) (enum KnxManufacturer, ok bool) {
case 503:
return KnxManufacturer_M_FROGBLUE, true
case 504:
- return KnxManufacturer_M_SAVESOR, true
+ return KnxManufacturer_M_LUXIO, true
case 505:
return KnxManufacturer_M_APP_TECH, true
case 506:
@@ -8117,8 +8127,10 @@ func KnxManufacturerByValue(value uint16) (enum KnxManufacturer, ok bool) {
case 672:
return KnxManufacturer_M_EUTELSAT, true
case 673:
- return KnxManufacturer_M_ABB___RESERVED, true
+ return KnxManufacturer_M_TECNIKABEL, true
case 674:
+ return KnxManufacturer_M_ABB___RESERVED, true
+ case 675:
return KnxManufacturer_M_BUSCH_JAEGER_ELEKTRO___RESERVED, true
case 68:
return KnxManufacturer_M_WAREMA_RENKHOFF_SE, true
@@ -9098,8 +9110,8 @@ func KnxManufacturerByName(value string) (enum KnxManufacturer, ok bool) {
return KnxManufacturer_M_BLUE_AND_RED, true
case "M_FROGBLUE":
return KnxManufacturer_M_FROGBLUE, true
- case "M_SAVESOR":
- return KnxManufacturer_M_SAVESOR, true
+ case "M_LUXIO":
+ return KnxManufacturer_M_LUXIO, true
case "M_APP_TECH":
return KnxManufacturer_M_APP_TECH, true
case "M_SENSORTEC_AG":
@@ -9472,6 +9484,8 @@ func KnxManufacturerByName(value string) (enum KnxManufacturer, ok bool) {
return KnxManufacturer_M_CREATROL, true
case "M_EUTELSAT":
return KnxManufacturer_M_EUTELSAT, true
+ case "M_TECNIKABEL":
+ return KnxManufacturer_M_TECNIKABEL, true
case "M_ABB___RESERVED":
return KnxManufacturer_M_ABB___RESERVED, true
case "M_BUSCH_JAEGER_ELEKTRO___RESERVED":
@@ -10515,8 +10529,8 @@ func (e KnxManufacturer) PLC4XEnumName() string {
return "M_BLUE_AND_RED"
case KnxManufacturer_M_FROGBLUE:
return "M_FROGBLUE"
- case KnxManufacturer_M_SAVESOR:
- return "M_SAVESOR"
+ case KnxManufacturer_M_LUXIO:
+ return "M_LUXIO"
case KnxManufacturer_M_APP_TECH:
return "M_APP_TECH"
case KnxManufacturer_M_SENSORTEC_AG:
@@ -10889,6 +10903,8 @@ func (e KnxManufacturer) PLC4XEnumName() string {
return "M_CREATROL"
case KnxManufacturer_M_EUTELSAT:
return "M_EUTELSAT"
+ case KnxManufacturer_M_TECNIKABEL:
+ return "M_TECNIKABEL"
case KnxManufacturer_M_ABB___RESERVED:
return "M_ABB___RESERVED"
case KnxManufacturer_M_BUSCH_JAEGER_ELEKTRO___RESERVED:
diff --git a/plc4j/drivers/knxnetip/src/main/generated/org/apache/plc4x/java/knxnetip/readwrite/KnxManufacturer.java b/plc4j/drivers/knxnetip/src/main/generated/org/apache/plc4x/java/knxnetip/readwrite/KnxManufacturer.java
index a19f2ac8fe..5331d303a4 100644
--- a/plc4j/drivers/knxnetip/src/main/generated/org/apache/plc4x/java/knxnetip/readwrite/KnxManufacturer.java
+++ b/plc4j/drivers/knxnetip/src/main/generated/org/apache/plc4x/java/knxnetip/readwrite/KnxManufacturer.java
@@ -578,7 +578,7 @@ public enum KnxManufacturer {
M_AUTOMATIONPlus((int) 501, (int) 556, (String) "Automation+"),
M_BLUE_AND_RED((int) 502, (int) 557, (String) "blue and red"),
M_FROGBLUE((int) 503, (int) 558, (String) "frogblue"),
- M_SAVESOR((int) 504, (int) 559, (String) "SAVESOR"),
+ M_LUXIO((int) 504, (int) 559, (String) "LUXIO"),
M_APP_TECH((int) 505, (int) 560, (String) "App Tech"),
M_SENSORTEC_AG((int) 506, (int) 561, (String) "sensortec AG"),
M_NYSA_TECHNOLOGY_AND_SOLUTIONS((int) 507, (int) 562, (String) "nysa technology & solutions"),
@@ -776,9 +776,10 @@ public enum KnxManufacturer {
M_MARLEY_DEUTSCHLAND_GMBH((int) 670, (int) 728, (String) "Marley Deutschland GmbH"),
M_CREATROL((int) 671, (int) 729, (String) "Creatrol"),
M_EUTELSAT((int) 672, (int) 730, (String) "EUTELSAT"),
- M_ABB___RESERVED((int) 673, (int) 43954, (String) "ABB - reserved"),
+ M_TECNIKABEL((int) 673, (int) 731, (String) "TECNIKABEL"),
+ M_ABB___RESERVED((int) 674, (int) 43954, (String) "ABB - reserved"),
M_BUSCH_JAEGER_ELEKTRO___RESERVED(
- (int) 674, (int) 43959, (String) "Busch-Jaeger Elektro - reserved");
+ (int) 675, (int) 43959, (String) "Busch-Jaeger Elektro - reserved");
private static final Map<Integer, KnxManufacturer> map;
static {
diff --git a/plc4net/drivers/knxnetip/src/drivers/knxnetip/readwrite/model/KnxManufacturer.cs b/plc4net/drivers/knxnetip/src/drivers/knxnetip/readwrite/model/KnxManufacturer.cs
index b96d4ab701..2e9f98e3a6 100644
--- a/plc4net/drivers/knxnetip/src/drivers/knxnetip/readwrite/model/KnxManufacturer.cs
+++ b/plc4net/drivers/knxnetip/src/drivers/knxnetip/readwrite/model/KnxManufacturer.cs
@@ -528,7 +528,7 @@ namespace org.apache.plc4net.drivers.knxnetip.readwrite.model
M_AUTOMATIONPlus = 501,
M_BLUE_AND_RED = 502,
M_FROGBLUE = 503,
- M_SAVESOR = 504,
+ M_LUXIO = 504,
M_APP_TECH = 505,
M_SENSORTEC_AG = 506,
M_NYSA_TECHNOLOGY_AND_SOLUTIONS = 507,
@@ -697,8 +697,9 @@ namespace org.apache.plc4net.drivers.knxnetip.readwrite.model
M_MARLEY_DEUTSCHLAND_GMBH = 670,
M_CREATROL = 671,
M_EUTELSAT = 672,
- M_ABB___RESERVED = 673,
- M_BUSCH_JAEGER_ELEKTRO___RESERVED = 674,
+ M_TECNIKABEL = 673,
+ M_ABB___RESERVED = 674,
+ M_BUSCH_JAEGER_ELEKTRO___RESERVED = 675,
}
public static class KnxManufacturerInfo
@@ -2061,7 +2062,7 @@ namespace org.apache.plc4net.drivers.knxnetip.readwrite.model
case KnxManufacturer.M_FROGBLUE: { /* '503' */
return 558;
}
- case KnxManufacturer.M_SAVESOR: { /* '504' */
+ case KnxManufacturer.M_LUXIO: { /* '504' */
return 559;
}
case KnxManufacturer.M_APP_TECH: { /* '505' */
@@ -2622,10 +2623,13 @@ namespace org.apache.plc4net.drivers.knxnetip.readwrite.model
case KnxManufacturer.M_EUTELSAT: { /* '672' */
return 730;
}
- case KnxManufacturer.M_ABB___RESERVED: { /* '673' */
+ case KnxManufacturer.M_TECNIKABEL: { /* '673' */
+ return 731;
+ }
+ case KnxManufacturer.M_ABB___RESERVED: { /* '674' */
return 43954;
}
- case KnxManufacturer.M_BUSCH_JAEGER_ELEKTRO___RESERVED: { /* '674' */
+ case KnxManufacturer.M_BUSCH_JAEGER_ELEKTRO___RESERVED: { /* '675' */
return 43959;
}
case KnxManufacturer.M_WAREMA_RENKHOFF_SE: { /* '68' */
@@ -4096,8 +4100,8 @@ namespace org.apache.plc4net.drivers.knxnetip.readwrite.model
case KnxManufacturer.M_FROGBLUE: { /* '503' */
return "frogblue";
}
- case KnxManufacturer.M_SAVESOR: { /* '504' */
- return "SAVESOR";
+ case KnxManufacturer.M_LUXIO: { /* '504' */
+ return "LUXIO";
}
case KnxManufacturer.M_APP_TECH: { /* '505' */
return "App Tech";
@@ -4657,10 +4661,13 @@ namespace org.apache.plc4net.drivers.knxnetip.readwrite.model
case KnxManufacturer.M_EUTELSAT: { /* '672' */
return "EUTELSAT";
}
- case KnxManufacturer.M_ABB___RESERVED: { /* '673' */
+ case KnxManufacturer.M_TECNIKABEL: { /* '673' */
+ return "TECNIKABEL";
+ }
+ case KnxManufacturer.M_ABB___RESERVED: { /* '674' */
return "ABB - reserved";
}
- case KnxManufacturer.M_BUSCH_JAEGER_ELEKTRO___RESERVED: { /* '674' */
+ case KnxManufacturer.M_BUSCH_JAEGER_ELEKTRO___RESERVED: { /* '675' */
return "Busch-Jaeger Elektro - reserved";
}
case KnxManufacturer.M_WAREMA_RENKHOFF_SE: { /* '68' */
diff --git a/protocols/knxnetip/src/main/generated/protocols/knxnetip/knx-master-data.mspec b/protocols/knxnetip/src/main/generated/protocols/knxnetip/knx-master-data.mspec
index 88970fb19c..2d542518f7 100644
--- a/protocols/knxnetip/src/main/generated/protocols/knxnetip/knx-master-data.mspec
+++ b/protocols/knxnetip/src/main/generated/protocols/knxnetip/knx-master-data.mspec
@@ -1252,7 +1252,7 @@
['501' M_AUTOMATIONPlus ['556', '"Automation+"']]
['502' M_BLUE_AND_RED ['557', '"blue and red"']]
['503' M_FROGBLUE ['558', '"frogblue"']]
- ['504' M_SAVESOR ['559', '"SAVESOR"']]
+ ['504' M_LUXIO ['559', '"LUXIO"']]
['505' M_APP_TECH ['560', '"App Tech"']]
['506' M_SENSORTEC_AG ['561', '"sensortec AG"']]
['507' M_NYSA_TECHNOLOGY_AND_SOLUTIONS ['562', '"nysa technology & solutions"']]
@@ -1421,8 +1421,9 @@
['670' M_MARLEY_DEUTSCHLAND_GMBH ['728', '"Marley Deutschland GmbH"']]
['671' M_CREATROL ['729', '"Creatrol"']]
['672' M_EUTELSAT ['730', '"EUTELSAT"']]
- ['673' M_ABB___RESERVED ['43954', '"ABB - reserved"']]
- ['674' M_BUSCH_JAEGER_ELEKTRO___RESERVED ['43959', '"Busch-Jaeger Elektro - reserved"']]
+ ['673' M_TECNIKABEL ['731', '"TECNIKABEL"']]
+ ['674' M_ABB___RESERVED ['43954', '"ABB - reserved"']]
+ ['675' M_BUSCH_JAEGER_ELEKTRO___RESERVED ['43959', '"Busch-Jaeger Elektro - reserved"']]
]
(plc4x) 01/03: chore: Made line-breaks in the configuration option descriptions get output as line-breaks
Posted by cd...@apache.org.
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
commit ec66f21d246b19aaeec8c950b8d39dc6683c1296
Author: Christofer Dutz <cd...@apache.org>
AuthorDate: Fri Apr 19 09:56:27 2024 +0200
chore: Made line-breaks in the configuration option descriptions get output as line-breaks
---
plc4j/drivers/all/src/site/generated/ab-eth.adoc | 8 +--
plc4j/drivers/all/src/site/generated/ads.adoc | 18 +++---
.../drivers/all/src/site/generated/bacnet-ip.adoc | 38 ++++++------
plc4j/drivers/all/src/site/generated/c-bus.adoc | 8 +--
plc4j/drivers/all/src/site/generated/canopen.adoc | 6 +-
plc4j/drivers/all/src/site/generated/eip.adoc | 12 ++--
plc4j/drivers/all/src/site/generated/firmata.adoc | 56 ++++++++---------
.../drivers/all/src/site/generated/genericcan.adoc | 4 +-
.../all/src/site/generated/iec-60870-5-104.adoc | 8 +--
.../drivers/all/src/site/generated/knxnet-ip.adoc | 60 +++++++++---------
plc4j/drivers/all/src/site/generated/logix.adoc | 18 +++---
.../all/src/site/generated/modbus-ascii.adoc | 70 +++++++++++----------
.../drivers/all/src/site/generated/modbus-rtu.adoc | 70 +++++++++++----------
.../drivers/all/src/site/generated/modbus-tcp.adoc | 16 +++--
plc4j/drivers/all/src/site/generated/opcua.adoc | 72 +++++++++++-----------
.../all/src/site/generated/open-protocol.adoc | 6 +-
plc4j/drivers/all/src/site/generated/plc4x.adoc | 10 +--
plc4j/drivers/all/src/site/generated/profinet.adoc | 12 ++--
plc4j/drivers/all/src/site/generated/s7.adoc | 61 +++++++++++-------
.../groovy/generate-config-documentation.groovy | 4 +-
20 files changed, 293 insertions(+), 264 deletions(-)
diff --git a/plc4j/drivers/all/src/site/generated/ab-eth.adoc b/plc4j/drivers/all/src/site/generated/ab-eth.adoc
index 5e168930bb..a3ea6d4f06 100644
--- a/plc4j/drivers/all/src/site/generated/ab-eth.adoc
+++ b/plc4j/drivers/all/src/site/generated/ab-eth.adoc
@@ -36,13 +36,13 @@
|Supported Transports 4+|
- `tcp`
5+|Config options:
-|`station` |INT | | |Id of the station we want to connect to
+|`station` |INT | | |Id of the station we want to connect to)
5+|Transport config options:
5+|
+++
<h4>tcp</h4>
+++
-|`tcp.keep-alive` |BOOLEAN |false| |Should keep-alive packets be sent?
-|`tcp.no-delay` |BOOLEAN |true| |Should packets be sent instantly or should we give the OS some time to aggregate data.
-|`tcp.default-timeout` |INT |1000| |Timeout after which a connection will be treated as disconnected.
+|`tcp.keep-alive` |BOOLEAN |false| |Should keep-alive packets be sent?)
+|`tcp.no-delay` |BOOLEAN |true| |Should packets be sent instantly or should we give the OS some time to aggregate data.)
+|`tcp.default-timeout` |INT |1000| |Timeout after which a connection will be treated as disconnected.)
|===
diff --git a/plc4j/drivers/all/src/site/generated/ads.adoc b/plc4j/drivers/all/src/site/generated/ads.adoc
index 3412f6097c..0f3f949eef 100644
--- a/plc4j/drivers/all/src/site/generated/ads.adoc
+++ b/plc4j/drivers/all/src/site/generated/ads.adoc
@@ -36,18 +36,18 @@
|Supported Transports 4+|
- `tcp`
5+|Config options:
-|`target-ams-net-id` |STRING | |required |AMS-Net-Id of the target. An AMS-Net-Id has the regular format of an IPv4 IP-Address, however with 6 segments instead of 4.
-|`target-ams-port` |INT | |required |AMS port of the target.
-|`source-ams-net-id` |STRING | |required |AMS-Net-Id of the source. An AMS-Net-Id has the regular format of an IPv4 IP-Address, however with 6 segments instead of 4.
-|`source-ams-port` |INT | |required |AMS port of the source.
-|`timeout-request` |INT |4000| |Default timeout for all types of requests.
-|`load-symbol-and-data-type-tables` |BOOLEAN |true| |Configures, if when connecting the data-type- and symbol-table should be read. This is an optimization that can help in cases, where the PLC program is pretty large and downloading the full tables is causing problems. When disabled, symbolic addresses will manually be resolved as soon as an address is used.
+|`target-ams-net-id` |STRING | |required |AMS-Net-Id of the target. An AMS-Net-Id has the regular format of an IPv4 IP-Address, however with 6 segments instead of 4.)
+|`target-ams-port` |INT | |required |AMS port of the target.)
+|`source-ams-net-id` |STRING | |required |AMS-Net-Id of the source. An AMS-Net-Id has the regular format of an IPv4 IP-Address, however with 6 segments instead of 4.)
+|`source-ams-port` |INT | |required |AMS port of the source.)
+|`timeout-request` |INT |4000| |Default timeout for all types of requests.)
+|`load-symbol-and-data-type-tables` |BOOLEAN |true| |Configures, if when connecting the data-type- and symbol-table should be read. This is an optimization that can help in cases, where the PLC program is pretty large and downloading the full tables is causing problems. When disabled, symbolic addresses will manually be resolved as soon as an address is used.)
5+|Transport config options:
5+|
+++
<h4>tcp</h4>
+++
-|`tcp.keep-alive` |BOOLEAN |false| |Should keep-alive packets be sent?
-|`tcp.no-delay` |BOOLEAN |true| |Should packets be sent instantly or should we give the OS some time to aggregate data.
-|`tcp.default-timeout` |INT |1000| |Timeout after which a connection will be treated as disconnected.
+|`tcp.keep-alive` |BOOLEAN |false| |Should keep-alive packets be sent?)
+|`tcp.no-delay` |BOOLEAN |true| |Should packets be sent instantly or should we give the OS some time to aggregate data.)
+|`tcp.default-timeout` |INT |1000| |Timeout after which a connection will be treated as disconnected.)
|===
diff --git a/plc4j/drivers/all/src/site/generated/bacnet-ip.adoc b/plc4j/drivers/all/src/site/generated/bacnet-ip.adoc
index 297ae73ef8..30887ce375 100644
--- a/plc4j/drivers/all/src/site/generated/bacnet-ip.adoc
+++ b/plc4j/drivers/all/src/site/generated/bacnet-ip.adoc
@@ -38,36 +38,36 @@
- `tcp`
- `pcap`
5+|Config options:
-|`ede-file-path` |STRING | | |Path to the location of a single EDE file, that contains the descriptor for the target device.
-|`ede-directory-path` |STRING | | |Path to the directory used for storing multiple EDE files. These files contain the descriptors for the possible target devices.
+|`ede-file-path` |STRING | | |Path to the location of a single EDE file, that contains the descriptor for the target device.)
+|`ede-directory-path` |STRING | | |Path to the directory used for storing multiple EDE files. These files contain the descriptors for the possible target devices.)
5+|Transport config options:
5+|
+++
<h4>udp</h4>
+++
-|`udp.local-port` |INT |-1| |Some connections require a UDP listener to listen on a fixed port.
-Use this configuration option in order to define the port number of the local port.
+|`udp.local-port` |INT |-1| |Some connections require a UDP listener to listen on a fixed port. +
+Use this configuration option in order to define the port number of the local port.)
5+|
+++
<h4>tcp</h4>
+++
-|`tcp.keep-alive` |BOOLEAN |false| |Should keep-alive packets be sent?
-|`tcp.no-delay` |BOOLEAN |true| |Should packets be sent instantly or should we give the OS some time to aggregate data.
-|`tcp.default-timeout` |INT |1000| |Timeout after which a connection will be treated as disconnected.
+|`tcp.keep-alive` |BOOLEAN |false| |Should keep-alive packets be sent?)
+|`tcp.no-delay` |BOOLEAN |true| |Should packets be sent instantly or should we give the OS some time to aggregate data.)
+|`tcp.default-timeout` |INT |1000| |Timeout after which a connection will be treated as disconnected.)
5+|
+++
<h4>pcap</h4>
+++
-|`pcap.support-vlans` |BOOLEAN |false| |Enables support for VLans
-|`pcap.replay-speed-factor` |FLOAT |1.0| |Numeric value for changing the replay speed:
-- 1 = Normal speed (default)
-- 0 = Maximum speed
-- 0.5 = Half speed
-- 2 = Double speed
-|`pcap.loop` |BOOLEAN |false| |Should the replay start at the beginning of the file as soon as the end is reached?
-- true = Automatically start again
-- false = Stop at the end (default)
-|`pcap.filter` |STRING | | |Filter expression used to filter out unwanted packets from the replay.
-|`pcap.support-vlans` |BOOLEAN |false| |Should VLan packets be automatically unpacked?
-|`pcap.protocol-id` |INT |-1| |When provided, filters all packets to let only packets matching this ethernet protocol-id pass.
+|`pcap.support-vlans` |BOOLEAN |false| |Enables support for VLans)
+|`pcap.replay-speed-factor` |FLOAT |1.0| |Numeric value for changing the replay speed: +
+- 1 = Normal speed (default) +
+- 0 = Maximum speed +
+- 0.5 = Half speed +
+- 2 = Double speed)
+|`pcap.loop` |BOOLEAN |false| |Should the replay start at the beginning of the file as soon as the end is reached? +
+- true = Automatically start again +
+- false = Stop at the end (default))
+|`pcap.filter` |STRING | | |Filter expression used to filter out unwanted packets from the replay.)
+|`pcap.support-vlans` |BOOLEAN |false| |Should VLan packets be automatically unpacked?)
+|`pcap.protocol-id` |INT |-1| |When provided, filters all packets to let only packets matching this ethernet protocol-id pass.)
|===
diff --git a/plc4j/drivers/all/src/site/generated/c-bus.adoc b/plc4j/drivers/all/src/site/generated/c-bus.adoc
index 98da125d16..71418e5d1e 100644
--- a/plc4j/drivers/all/src/site/generated/c-bus.adoc
+++ b/plc4j/drivers/all/src/site/generated/c-bus.adoc
@@ -36,13 +36,13 @@
|Supported Transports 4+|
- `tcp`
5+|Config options:
-|`srchk` |BOOLEAN |false| |Source check.
+|`srchk` |BOOLEAN |false| |Source check.)
5+|Transport config options:
5+|
+++
<h4>tcp</h4>
+++
-|`tcp.keep-alive` |BOOLEAN |false| |Should keep-alive packets be sent?
-|`tcp.no-delay` |BOOLEAN |true| |Should packets be sent instantly or should we give the OS some time to aggregate data.
-|`tcp.default-timeout` |INT |1000| |Timeout after which a connection will be treated as disconnected.
+|`tcp.keep-alive` |BOOLEAN |false| |Should keep-alive packets be sent?)
+|`tcp.no-delay` |BOOLEAN |true| |Should packets be sent instantly or should we give the OS some time to aggregate data.)
+|`tcp.default-timeout` |INT |1000| |Timeout after which a connection will be treated as disconnected.)
|===
diff --git a/plc4j/drivers/all/src/site/generated/canopen.adoc b/plc4j/drivers/all/src/site/generated/canopen.adoc
index ff87b26c63..9ca70d5c9a 100644
--- a/plc4j/drivers/all/src/site/generated/canopen.adoc
+++ b/plc4j/drivers/all/src/site/generated/canopen.adoc
@@ -36,9 +36,9 @@
|Supported Transports 4+|
- `socketcan`
5+|Config options:
-|`node-id` |INT | | |CAN node identifier. Depending on used CAN version it might be 11 or 29 bit unsigned int.
-|`heartbeat` |BOOLEAN | | |Forces PLC4X to send CANopen heartbeat (NMT) messages to the bus.
-|`request-timeout` |INT |1000| |Time after which dispatched BUS operation (ie. SDO request) will be marked as failed.
+|`node-id` |INT | | |CAN node identifier. Depending on used CAN version it might be 11 or 29 bit unsigned int.)
+|`heartbeat` |BOOLEAN | | |Forces PLC4X to send CANopen heartbeat (NMT) messages to the bus.)
+|`request-timeout` |INT |1000| |Time after which dispatched BUS operation (ie. SDO request) will be marked as failed.)
5+|Transport config options:
5+|
+++
diff --git a/plc4j/drivers/all/src/site/generated/eip.adoc b/plc4j/drivers/all/src/site/generated/eip.adoc
index 29b07e1fcd..87c7a29970 100644
--- a/plc4j/drivers/all/src/site/generated/eip.adoc
+++ b/plc4j/drivers/all/src/site/generated/eip.adoc
@@ -36,15 +36,15 @@
|Supported Transports 4+|
- `tcp`
5+|Config options:
-|`backplane` |INT | | |Without using routing information the backplane defaults to 1. This is overridden if communicationPath is provided.
-|`slot` |INT | | |The slot within the backplane the CPU is located.
-|`bigEndian` |BOOLEAN | | |Configure if the connection should be set to transport data in Big-Endian format, or not.
+|`backplane` |INT | | |Without using routing information the backplane defaults to 1. This is overridden if communicationPath is provided.)
+|`slot` |INT | | |The slot within the backplane the CPU is located.)
+|`bigEndian` |BOOLEAN | | |Configure if the connection should be set to transport data in Big-Endian format, or not.)
5+|Transport config options:
5+|
+++
<h4>tcp</h4>
+++
-|`tcp.keep-alive` |BOOLEAN |false| |Should keep-alive packets be sent?
-|`tcp.no-delay` |BOOLEAN |true| |Should packets be sent instantly or should we give the OS some time to aggregate data.
-|`tcp.default-timeout` |INT |1000| |Timeout after which a connection will be treated as disconnected.
+|`tcp.keep-alive` |BOOLEAN |false| |Should keep-alive packets be sent?)
+|`tcp.no-delay` |BOOLEAN |true| |Should packets be sent instantly or should we give the OS some time to aggregate data.)
+|`tcp.default-timeout` |INT |1000| |Timeout after which a connection will be treated as disconnected.)
|===
diff --git a/plc4j/drivers/all/src/site/generated/firmata.adoc b/plc4j/drivers/all/src/site/generated/firmata.adoc
index 3ac163cffc..f0d9d7d646 100644
--- a/plc4j/drivers/all/src/site/generated/firmata.adoc
+++ b/plc4j/drivers/all/src/site/generated/firmata.adoc
@@ -41,32 +41,32 @@
+++
<h4>serial</h4>
+++
-|`serial.baud-rate` |INT |57600| |Baud-rate the serial port is set to.
-Typical values are:
-- 9600
-- 14400
-- 19200
-- 38400
-- 57600
-- 115200
-- 128000
-But can also be smaller or larger values.
-|`serial.num-data-bits` |INT |8| |Number of data-bits used to send data.
-Typical values are:
-- 7
-- 8
-But can also be smaller or larger values.
-|`serial.num-stop-bits` |INT |1| |Number of stop-bits used to terminate data.
-Typical values are:
-- 1
-- 2
-(The theoretical 1.5 stop-bits setting is not supported)
-|`serial.parity` |STRING |NO_PARITY| |Number of bits used to calculate data parity.
-This is used to detect errors in transmission.
-Allowed values are:
-- NO_PARITY
-- ODD_PARITY
-- EVEN_PARITY
-- MARK_PARITY
-- SPACE_PARITY
+|`serial.baud-rate` |INT |57600| |Baud-rate the serial port is set to. +
+Typical values are: +
+- 9600 +
+- 14400 +
+- 19200 +
+- 38400 +
+- 57600 +
+- 115200 +
+- 128000 +
+But can also be smaller or larger values.)
+|`serial.num-data-bits` |INT |8| |Number of data-bits used to send data. +
+Typical values are: +
+- 7 +
+- 8 +
+But can also be smaller or larger values.)
+|`serial.num-stop-bits` |INT |1| |Number of stop-bits used to terminate data. +
+Typical values are: +
+- 1 +
+- 2 +
+(The theoretical 1.5 stop-bits setting is not supported))
+|`serial.parity` |STRING |NO_PARITY| |Number of bits used to calculate data parity. +
+This is used to detect errors in transmission. +
+Allowed values are: +
+- NO_PARITY +
+- ODD_PARITY +
+- EVEN_PARITY +
+- MARK_PARITY +
+- SPACE_PARITY)
|===
diff --git a/plc4j/drivers/all/src/site/generated/genericcan.adoc b/plc4j/drivers/all/src/site/generated/genericcan.adoc
index 193c38fe04..d708f6b299 100644
--- a/plc4j/drivers/all/src/site/generated/genericcan.adoc
+++ b/plc4j/drivers/all/src/site/generated/genericcan.adoc
@@ -36,8 +36,8 @@
|Supported Transports 4+|
- `socketcan`
5+|Config options:
-|`node-id` |INT | | |Node id of the target device.
-|`request-timeout` |INT |1000| |Default timeout for all types of requests.
+|`node-id` |INT | | |Node id of the target device.)
+|`request-timeout` |INT |1000| |Default timeout for all types of requests.)
5+|Transport config options:
5+|
+++
diff --git a/plc4j/drivers/all/src/site/generated/iec-60870-5-104.adoc b/plc4j/drivers/all/src/site/generated/iec-60870-5-104.adoc
index 8368dee5c5..3e79407d11 100644
--- a/plc4j/drivers/all/src/site/generated/iec-60870-5-104.adoc
+++ b/plc4j/drivers/all/src/site/generated/iec-60870-5-104.adoc
@@ -36,13 +36,13 @@
|Supported Transports 4+|
- `tcp`
5+|Config options:
-|`request-timeout` |INT |4000| |Default timeout for all types of requests.
+|`request-timeout` |INT |4000| |Default timeout for all types of requests.)
5+|Transport config options:
5+|
+++
<h4>tcp</h4>
+++
-|`tcp.keep-alive` |BOOLEAN |false| |Should keep-alive packets be sent?
-|`tcp.no-delay` |BOOLEAN |true| |Should packets be sent instantly or should we give the OS some time to aggregate data.
-|`tcp.default-timeout` |INT |1000| |Timeout after which a connection will be treated as disconnected.
+|`tcp.keep-alive` |BOOLEAN |false| |Should keep-alive packets be sent?)
+|`tcp.no-delay` |BOOLEAN |true| |Should packets be sent instantly or should we give the OS some time to aggregate data.)
+|`tcp.default-timeout` |INT |1000| |Timeout after which a connection will be treated as disconnected.)
|===
diff --git a/plc4j/drivers/all/src/site/generated/knxnet-ip.adoc b/plc4j/drivers/all/src/site/generated/knxnet-ip.adoc
index 76feba03d2..95afb77e68 100644
--- a/plc4j/drivers/all/src/site/generated/knxnet-ip.adoc
+++ b/plc4j/drivers/all/src/site/generated/knxnet-ip.adoc
@@ -38,47 +38,47 @@
- `pcap`
- `raw`
5+|Config options:
-|`knxproj-file-path` |STRING | | |Path to the `knxproj` file. The default KNXnet/IP protocol doesn't provide all the information needed to be able to fully decode the messages.
-|`knxproj-password` |STRING | | |Optional password needed to read the knxproj file.
-|`group-address-num-levels` |INT |3| |KNX Addresses can be encoded in multiple ways. Which encoding is used, is too not provided by the protocol itself so it has to be provided externally:
-
-- 3 Levels: {main-group (5 bit)}/{middle-group (3 bit)}/{sub-group (8 bit)}
-- 2 Levels: {main-group (5 bit)}/{sub-group (11 bit)}
-- 1 Level: {sub-group (16 bit)}
-
-The default is 3 levels. If the `knxproj-file-path` this information is provided by the file.
-|`connection-type` |STRING |LINK_LAYER| |Type of connection used to communicate. Possible values are:
-
-- 'LINK_LAYER' (default): The client becomes a participant of the KNX bus and gets it's own individual KNX address.
-- 'RAW': The client gets unmanaged access to the bus (be careful with this)
-- 'BUSMONITOR': The client operates as a busmonitor where he can't actively participate on the bus. Only one 'BUSMONITOR' connection is allowed at the same time on a KNXnet/IP gateway.
+|`knxproj-file-path` |STRING | | |Path to the `knxproj` file. The default KNXnet/IP protocol doesn't provide all the information needed to be able to fully decode the messages.)
+|`knxproj-password` |STRING | | |Optional password needed to read the knxproj file.)
+|`group-address-num-levels` |INT |3| |KNX Addresses can be encoded in multiple ways. Which encoding is used, is too not provided by the protocol itself so it has to be provided externally: +
+ +
+- 3 Levels: {main-group (5 bit)}/{middle-group (3 bit)}/{sub-group (8 bit)} +
+- 2 Levels: {main-group (5 bit)}/{sub-group (11 bit)} +
+- 1 Level: {sub-group (16 bit)} +
+ +
+The default is 3 levels. If the `knxproj-file-path` this information is provided by the file.)
+|`connection-type` |STRING |LINK_LAYER| |Type of connection used to communicate. Possible values are: +
+ +
+- 'LINK_LAYER' (default): The client becomes a participant of the KNX bus and gets it's own individual KNX address. +
+- 'RAW': The client gets unmanaged access to the bus (be careful with this) +
+- 'BUSMONITOR': The client operates as a busmonitor where he can't actively participate on the bus. Only one 'BUSMONITOR' connection is allowed at the same time on a KNXnet/IP gateway.)
5+|Transport config options:
5+|
+++
<h4>udp</h4>
+++
-|`udp.local-port` |INT |-1| |Some connections require a UDP listener to listen on a fixed port.
-Use this configuration option in order to define the port number of the local port.
+|`udp.local-port` |INT |-1| |Some connections require a UDP listener to listen on a fixed port. +
+Use this configuration option in order to define the port number of the local port.)
5+|
+++
<h4>pcap</h4>
+++
-|`pcap.replay-speed-factor` |FLOAT |1.0| |Numeric value for changing the replay speed:
-- 1 = Normal speed (default)
-- 0 = Maximum speed
-- 0.5 = Half speed
-- 2 = Double speed
-|`pcap.loop` |BOOLEAN |false| |Should the replay start at the beginning of the file as soon as the end is reached?
-- true = Automatically start again
-- false = Stop at the end (default)
-|`pcap.filter` |STRING | | |Filter expression used to filter out unwanted packets from the replay.
-|`pcap.support-vlans` |BOOLEAN |false| |Should VLan packets be automatically unpacked?
-|`pcap.protocol-id` |INT |-1| |When provided, filters all packets to let only packets matching this ethernet protocol-id pass.
+|`pcap.replay-speed-factor` |FLOAT |1.0| |Numeric value for changing the replay speed: +
+- 1 = Normal speed (default) +
+- 0 = Maximum speed +
+- 0.5 = Half speed +
+- 2 = Double speed)
+|`pcap.loop` |BOOLEAN |false| |Should the replay start at the beginning of the file as soon as the end is reached? +
+- true = Automatically start again +
+- false = Stop at the end (default))
+|`pcap.filter` |STRING | | |Filter expression used to filter out unwanted packets from the replay.)
+|`pcap.support-vlans` |BOOLEAN |false| |Should VLan packets be automatically unpacked?)
+|`pcap.protocol-id` |INT |-1| |When provided, filters all packets to let only packets matching this ethernet protocol-id pass.)
5+|
+++
<h4>raw</h4>
+++
-|`raw.resolve-mac-address` |BOOLEAN | | |If set to true, the transport will automatically resolve the MAC address for a given IP address (Allows connecting to a raw-socket device using the devices host-name or ip-address).
-|`raw.support-vlans` |BOOLEAN |false| |Should VLan packets be automatically unpacked?
-|`raw.protocol-id` |INT |-1| |When provided, filters all packets to let only packets matching this ethernet protocol-id pass.
+|`raw.resolve-mac-address` |BOOLEAN | | |If set to true, the transport will automatically resolve the MAC address for a given IP address (Allows connecting to a raw-socket device using the devices host-name or ip-address).)
+|`raw.support-vlans` |BOOLEAN |false| |Should VLan packets be automatically unpacked?)
+|`raw.protocol-id` |INT |-1| |When provided, filters all packets to let only packets matching this ethernet protocol-id pass.)
|===
diff --git a/plc4j/drivers/all/src/site/generated/logix.adoc b/plc4j/drivers/all/src/site/generated/logix.adoc
index 92362248bf..a51893ac03 100644
--- a/plc4j/drivers/all/src/site/generated/logix.adoc
+++ b/plc4j/drivers/all/src/site/generated/logix.adoc
@@ -36,18 +36,18 @@
|Supported Transports 4+|
- `tcp`
5+|Config options:
-|`communication-path` |STRING | | |The communication path allows for connection routing across multiple backplanes. It uses a common format found in Logix controllers.
-It consists of pairs of values, each pair begins with either 1 (Backplane) or 2 (Ethernet), followed by a slot in the case of a backplane address,
-or if using Ethernet an ip address. e.g. [1,4,2,192.168.0.1,1,1] - Routes to the 4th slot in the first rack, which is a ethernet module, it then connects to the address 192.168.0.1, then finds the module in slot 1.
-|`backplane` |INT | | |Without using routing information the backplane defaults to 1. This is overridden if communicationPath is provided.
-|`slot` |INT | | |The slot within the backplane the CPU is located.
-|`bigEndian` |BOOLEAN | | |Configure if the connection should be set to transport data in Big-Endian format, or not.
+|`communication-path` |STRING | | |The communication path allows for connection routing across multiple backplanes. It uses a common format found in Logix controllers. +
+It consists of pairs of values, each pair begins with either 1 (Backplane) or 2 (Ethernet), followed by a slot in the case of a backplane address, +
+or if using Ethernet an ip address. e.g. [1,4,2,192.168.0.1,1,1] - Routes to the 4th slot in the first rack, which is a ethernet module, it then connects to the address 192.168.0.1, then finds the module in slot 1.)
+|`backplane` |INT | | |Without using routing information the backplane defaults to 1. This is overridden if communicationPath is provided.)
+|`slot` |INT | | |The slot within the backplane the CPU is located.)
+|`bigEndian` |BOOLEAN | | |Configure if the connection should be set to transport data in Big-Endian format, or not.)
5+|Transport config options:
5+|
+++
<h4>tcp</h4>
+++
-|`tcp.keep-alive` |BOOLEAN |false| |Should keep-alive packets be sent?
-|`tcp.no-delay` |BOOLEAN |true| |Should packets be sent instantly or should we give the OS some time to aggregate data.
-|`tcp.default-timeout` |INT |1000| |Timeout after which a connection will be treated as disconnected.
+|`tcp.keep-alive` |BOOLEAN |false| |Should keep-alive packets be sent?)
+|`tcp.no-delay` |BOOLEAN |true| |Should packets be sent instantly or should we give the OS some time to aggregate data.)
+|`tcp.default-timeout` |INT |1000| |Timeout after which a connection will be treated as disconnected.)
|===
diff --git a/plc4j/drivers/all/src/site/generated/modbus-ascii.adoc b/plc4j/drivers/all/src/site/generated/modbus-ascii.adoc
index 5828f74ad3..6f2a836564 100644
--- a/plc4j/drivers/all/src/site/generated/modbus-ascii.adoc
+++ b/plc4j/drivers/all/src/site/generated/modbus-ascii.adoc
@@ -37,46 +37,50 @@
- `tcp`
- `serial`
5+|Config options:
-|`request-timeout` |INT |5000| |Default timeout for all types of requests.
-|`default-unit-identifier` |STRUCT |1| |Unit-identifier or slave-id that identifies the target PLC (On RS485 multiple Modbus Devices can be listening). Defaults to 1.
+|`request-timeout` |INT |5000| |Default timeout for all types of requests.)
+|`default-unit-identifier` |STRUCT |1| |Unit-identifier or slave-id that identifies the target PLC (On RS485 multiple Modbus Devices can be listening). Defaults to 1.)
+|`default-payload-byte-order` |STRING |BIG_ENDIAN| |Default encoding used for transporting register values (Defaults to BIG_ENDIAN). +
+Allowed values are: +
+ - BIG_ENDIAN +
+ - LITTLE_ENDIAN)
5+|Transport config options:
5+|
+++
<h4>tcp</h4>
+++
-|`tcp.keep-alive` |BOOLEAN |false| |Should keep-alive packets be sent?
-|`tcp.no-delay` |BOOLEAN |true| |Should packets be sent instantly or should we give the OS some time to aggregate data.
-|`tcp.default-timeout` |INT |1000| |Timeout after which a connection will be treated as disconnected.
+|`tcp.keep-alive` |BOOLEAN |false| |Should keep-alive packets be sent?)
+|`tcp.no-delay` |BOOLEAN |true| |Should packets be sent instantly or should we give the OS some time to aggregate data.)
+|`tcp.default-timeout` |INT |1000| |Timeout after which a connection will be treated as disconnected.)
5+|
+++
<h4>serial</h4>
+++
-|`serial.baud-rate` |INT |57600| |Baud-rate the serial port is set to.
-Typical values are:
-- 9600
-- 14400
-- 19200
-- 38400
-- 57600
-- 115200
-- 128000
-But can also be smaller or larger values.
-|`serial.num-data-bits` |INT |8| |Number of data-bits used to send data.
-Typical values are:
-- 7
-- 8
-But can also be smaller or larger values.
-|`serial.num-stop-bits` |INT |1| |Number of stop-bits used to terminate data.
-Typical values are:
-- 1
-- 2
-(The theoretical 1.5 stop-bits setting is not supported)
-|`serial.parity` |STRING |NO_PARITY| |Number of bits used to calculate data parity.
-This is used to detect errors in transmission.
-Allowed values are:
-- NO_PARITY
-- ODD_PARITY
-- EVEN_PARITY
-- MARK_PARITY
-- SPACE_PARITY
+|`serial.baud-rate` |INT |57600| |Baud-rate the serial port is set to. +
+Typical values are: +
+- 9600 +
+- 14400 +
+- 19200 +
+- 38400 +
+- 57600 +
+- 115200 +
+- 128000 +
+But can also be smaller or larger values.)
+|`serial.num-data-bits` |INT |8| |Number of data-bits used to send data. +
+Typical values are: +
+- 7 +
+- 8 +
+But can also be smaller or larger values.)
+|`serial.num-stop-bits` |INT |1| |Number of stop-bits used to terminate data. +
+Typical values are: +
+- 1 +
+- 2 +
+(The theoretical 1.5 stop-bits setting is not supported))
+|`serial.parity` |STRING |NO_PARITY| |Number of bits used to calculate data parity. +
+This is used to detect errors in transmission. +
+Allowed values are: +
+- NO_PARITY +
+- ODD_PARITY +
+- EVEN_PARITY +
+- MARK_PARITY +
+- SPACE_PARITY)
|===
diff --git a/plc4j/drivers/all/src/site/generated/modbus-rtu.adoc b/plc4j/drivers/all/src/site/generated/modbus-rtu.adoc
index 0932a4bb6e..40e62f1079 100644
--- a/plc4j/drivers/all/src/site/generated/modbus-rtu.adoc
+++ b/plc4j/drivers/all/src/site/generated/modbus-rtu.adoc
@@ -37,46 +37,50 @@
- `tcp`
- `serial`
5+|Config options:
-|`request-timeout` |INT |5000| |Default timeout for all types of requests.
-|`default-unit-identifier` |INT |1| |Unit-identifier or slave-id that identifies the target PLC (On RS485 multiple Modbus Devices can be listening). Defaults to 1.
+|`request-timeout` |INT |5000| |Default timeout for all types of requests.)
+|`default-unit-identifier` |INT |1| |Unit-identifier or slave-id that identifies the target PLC (On RS485 multiple Modbus Devices can be listening). Defaults to 1.)
+|`default-payload-byte-order` |STRING |BIG_ENDIAN| |Default encoding used for transporting register values (Defaults to BIG_ENDIAN). +
+Allowed values are: +
+ - BIG_ENDIAN +
+ - LITTLE_ENDIAN)
5+|Transport config options:
5+|
+++
<h4>tcp</h4>
+++
-|`tcp.keep-alive` |BOOLEAN |false| |Should keep-alive packets be sent?
-|`tcp.no-delay` |BOOLEAN |true| |Should packets be sent instantly or should we give the OS some time to aggregate data.
-|`tcp.default-timeout` |INT |1000| |Timeout after which a connection will be treated as disconnected.
+|`tcp.keep-alive` |BOOLEAN |false| |Should keep-alive packets be sent?)
+|`tcp.no-delay` |BOOLEAN |true| |Should packets be sent instantly or should we give the OS some time to aggregate data.)
+|`tcp.default-timeout` |INT |1000| |Timeout after which a connection will be treated as disconnected.)
5+|
+++
<h4>serial</h4>
+++
-|`serial.baud-rate` |INT |57600| |Baud-rate the serial port is set to.
-Typical values are:
-- 9600
-- 14400
-- 19200
-- 38400
-- 57600
-- 115200
-- 128000
-But can also be smaller or larger values.
-|`serial.num-data-bits` |INT |8| |Number of data-bits used to send data.
-Typical values are:
-- 7
-- 8
-But can also be smaller or larger values.
-|`serial.num-stop-bits` |INT |1| |Number of stop-bits used to terminate data.
-Typical values are:
-- 1
-- 2
-(The theoretical 1.5 stop-bits setting is not supported)
-|`serial.parity` |STRING |NO_PARITY| |Number of bits used to calculate data parity.
-This is used to detect errors in transmission.
-Allowed values are:
-- NO_PARITY
-- ODD_PARITY
-- EVEN_PARITY
-- MARK_PARITY
-- SPACE_PARITY
+|`serial.baud-rate` |INT |57600| |Baud-rate the serial port is set to. +
+Typical values are: +
+- 9600 +
+- 14400 +
+- 19200 +
+- 38400 +
+- 57600 +
+- 115200 +
+- 128000 +
+But can also be smaller or larger values.)
+|`serial.num-data-bits` |INT |8| |Number of data-bits used to send data. +
+Typical values are: +
+- 7 +
+- 8 +
+But can also be smaller or larger values.)
+|`serial.num-stop-bits` |INT |1| |Number of stop-bits used to terminate data. +
+Typical values are: +
+- 1 +
+- 2 +
+(The theoretical 1.5 stop-bits setting is not supported))
+|`serial.parity` |STRING |NO_PARITY| |Number of bits used to calculate data parity. +
+This is used to detect errors in transmission. +
+Allowed values are: +
+- NO_PARITY +
+- ODD_PARITY +
+- EVEN_PARITY +
+- MARK_PARITY +
+- SPACE_PARITY)
|===
diff --git a/plc4j/drivers/all/src/site/generated/modbus-tcp.adoc b/plc4j/drivers/all/src/site/generated/modbus-tcp.adoc
index c8cbfb62cd..2a4ad37a1b 100644
--- a/plc4j/drivers/all/src/site/generated/modbus-tcp.adoc
+++ b/plc4j/drivers/all/src/site/generated/modbus-tcp.adoc
@@ -36,15 +36,19 @@
|Supported Transports 4+|
- `tcp`
5+|Config options:
-|`request-timeout` |INT |5000| |Default timeout for all types of requests.
-|`default-unit-identifier` |INT |1| |Unit-identifier or slave-id that identifies the target PLC (On RS485 multiple Modbus Devices can be listening). Defaults to 1.
-|`ping-address` |STRING |4x00001:BOOL| |Simple address, that the driver will use to check, if the connection to a given device is active (Defaults to reading holding-register 1).
+|`request-timeout` |INT |5000| |Default timeout for all types of requests.)
+|`default-unit-identifier` |INT |1| |Unit-identifier or slave-id that identifies the target PLC (On RS485 multiple Modbus Devices can be listening). Defaults to 1.)
+|`ping-address` |STRING |4x00001:BOOL| |Simple address, that the driver will use to check, if the connection to a given device is active (Defaults to reading holding-register 1).)
+|`default-payload-byte-order` |STRING |BIG_ENDIAN| |Default encoding used for transporting register values (Defaults to BIG_ENDIAN). +
+Allowed values are: +
+ - BIG_ENDIAN +
+ - LITTLE_ENDIAN)
5+|Transport config options:
5+|
+++
<h4>tcp</h4>
+++
-|`tcp.keep-alive` |BOOLEAN |false| |Should keep-alive packets be sent?
-|`tcp.no-delay` |BOOLEAN |true| |Should packets be sent instantly or should we give the OS some time to aggregate data.
-|`tcp.default-timeout` |INT |1000| |Timeout after which a connection will be treated as disconnected.
+|`tcp.keep-alive` |BOOLEAN |false| |Should keep-alive packets be sent?)
+|`tcp.no-delay` |BOOLEAN |true| |Should packets be sent instantly or should we give the OS some time to aggregate data.)
+|`tcp.default-timeout` |INT |1000| |Timeout after which a connection will be treated as disconnected.)
|===
diff --git a/plc4j/drivers/all/src/site/generated/opcua.adoc b/plc4j/drivers/all/src/site/generated/opcua.adoc
index a04a993a85..06f2ea0d1a 100644
--- a/plc4j/drivers/all/src/site/generated/opcua.adoc
+++ b/plc4j/drivers/all/src/site/generated/opcua.adoc
@@ -36,45 +36,45 @@
|Supported Transports 4+|
- `tcp`
5+|Config options:
-|`protocol-code` |STRING | | |
-|`transport-code` |STRING | | |
-|`transport-config` |STRING | | |
-|`discovery` |BOOLEAN |true| |Controls the feature of the discovery endpoint of an OPC UA server which every server
-will propagate over an '<address>/discovery' endpoint. The most common issue here is that most servers are not correctly
-configured and propagate the wrong external IP or URL address. If that is the case you can disable the discovery by
-configuring it with a `false` value.
-
-The discovery phase is always conducted using `NONE` security policy.
-|`username` |STRING | | |A username to authenticate to the OPCUA server with.
-|`password` |STRING | | |A password to authenticate to the OPCUA server with.
-|`security-policy` |STRING |NONE| |The security policy applied to communication channel between driver and OPC UA server.
-Default value assumes. Possible options are `NONE`, `Basic128Rsa15`, `Basic256`, `Basic256Sha256`, `Aes128_Sha256_RsaOaep`, `Aes256_Sha256_RsaPss`.
-|`message-security` |STRING |SIGN_ENCRYPT| |The security policy applied to messages exchanged after handshake phase.
-Possible options are `NONE`, `SIGN`, `SIGN_ENCRYPT`.
-This option is effective only when `securityPolicy` turns encryption (anything beyond `NONE`).
-|`key-store-file` |STRING | | |The Keystore file used to lookup client certificate and its private key.
-|`key-store-type` |STRING |pkcs12| |Keystore type used to access keystore and private key, defaults to PKCS (for Java 11+).
-Possible values are between others `jks`, `pkcs11`, `dks`, `jceks`.
-|`key-store-password` |STRING | | |Java keystore password used to access keystore and private key.
-|`server-certificate-file` |STRING | | |Filesystem location where server certificate is located, supported formats are `DER` and `PEM`.
-|`trust-store-file` |STRING | | |The trust store file used to verify server certificates and its chain.
-|`trust-store-type` |STRING |pkcs12| |Keystore type used to access keystore and private key, defaults to PKCS (for Java 11+).
-Possible values are between others `jks`, `pkcs11`, `dks`, `jceks`.
-|`trust-store-password` |STRING | | |Password used to open trust store.
-|`channel-lifetime` |LONG |3600000| |Time for which negotiated secure channel, its keys and session remains open. Value in milliseconds, by default 60 minutes.
-|`session-timeout` |LONG |120000| |Expiry time for opened secure session, value in milliseconds. Defaults to 2 minutes.
-|`negotiation-timeout` |LONG |60000| |Timeout for all negotiation steps prior acceptance of application level operations - this timeout applies to open secure channel, create session and close calls. Defaults to 60 seconds.
-|`request-timeout` |LONG |30000| |Timeout for read/write/subscribe calls. Value in milliseconds.
-|`encoding.receive-buffer-size` |INT |65535| |Maximum size of received TCP transport message chunk value in bytes.
-|`encoding.send-buffer-size` |INT |65535| |Maximum size of sent transport message chunk.
-|`encoding.max-message-size` |INT |2097152| |Maximum size of complete message.
-|`encoding.max-chunk-count` |INT |64| |Maximum number of chunks for both sent and received messages.
+|`protocol-code` |STRING | | |)
+|`transport-code` |STRING | | |)
+|`transport-config` |STRING | | |)
+|`discovery` |BOOLEAN |true| |Controls the feature of the discovery endpoint of an OPC UA server which every server +
+will propagate over an '<address>/discovery' endpoint. The most common issue here is that most servers are not correctly +
+configured and propagate the wrong external IP or URL address. If that is the case you can disable the discovery by +
+configuring it with a `false` value. +
+ +
+The discovery phase is always conducted using `NONE` security policy.)
+|`username` |STRING | | |A username to authenticate to the OPCUA server with.)
+|`password` |STRING | | |A password to authenticate to the OPCUA server with.)
+|`security-policy` |STRING |NONE| |The security policy applied to communication channel between driver and OPC UA server. +
+Default value assumes. Possible options are `NONE`, `Basic128Rsa15`, `Basic256`, `Basic256Sha256`, `Aes128_Sha256_RsaOaep`, `Aes256_Sha256_RsaPss`.)
+|`message-security` |STRING |SIGN_ENCRYPT| |The security policy applied to messages exchanged after handshake phase. +
+Possible options are `NONE`, `SIGN`, `SIGN_ENCRYPT`. +
+This option is effective only when `securityPolicy` turns encryption (anything beyond `NONE`).)
+|`key-store-file` |STRING | | |The Keystore file used to lookup client certificate and its private key.)
+|`key-store-type` |STRING |pkcs12| |Keystore type used to access keystore and private key, defaults to PKCS (for Java 11+). +
+Possible values are between others `jks`, `pkcs11`, `dks`, `jceks`.)
+|`key-store-password` |STRING | | |Java keystore password used to access keystore and private key.)
+|`server-certificate-file` |STRING | | |Filesystem location where server certificate is located, supported formats are `DER` and `PEM`.)
+|`trust-store-file` |STRING | | |The trust store file used to verify server certificates and its chain.)
+|`trust-store-type` |STRING |pkcs12| |Keystore type used to access keystore and private key, defaults to PKCS (for Java 11+). +
+Possible values are between others `jks`, `pkcs11`, `dks`, `jceks`.)
+|`trust-store-password` |STRING | | |Password used to open trust store.)
+|`channel-lifetime` |LONG |3600000| |Time for which negotiated secure channel, its keys and session remains open. Value in milliseconds, by default 60 minutes.)
+|`session-timeout` |LONG |120000| |Expiry time for opened secure session, value in milliseconds. Defaults to 2 minutes.)
+|`negotiation-timeout` |LONG |60000| |Timeout for all negotiation steps prior acceptance of application level operations - this timeout applies to open secure channel, create session and close calls. Defaults to 60 seconds.)
+|`request-timeout` |LONG |30000| |Timeout for read/write/subscribe calls. Value in milliseconds.)
+|`encoding.receive-buffer-size` |INT |65535| |Maximum size of received TCP transport message chunk value in bytes.)
+|`encoding.send-buffer-size` |INT |65535| |Maximum size of sent transport message chunk.)
+|`encoding.max-message-size` |INT |2097152| |Maximum size of complete message.)
+|`encoding.max-chunk-count` |INT |64| |Maximum number of chunks for both sent and received messages.)
5+|Transport config options:
5+|
+++
<h4>tcp</h4>
+++
-|`tcp.keep-alive` |BOOLEAN |false| |Should keep-alive packets be sent?
-|`tcp.no-delay` |BOOLEAN |true| |Should packets be sent instantly or should we give the OS some time to aggregate data.
-|`tcp.default-timeout` |INT |1000| |Timeout after which a connection will be treated as disconnected.
+|`tcp.keep-alive` |BOOLEAN |false| |Should keep-alive packets be sent?)
+|`tcp.no-delay` |BOOLEAN |true| |Should packets be sent instantly or should we give the OS some time to aggregate data.)
+|`tcp.default-timeout` |INT |1000| |Timeout after which a connection will be treated as disconnected.)
|===
diff --git a/plc4j/drivers/all/src/site/generated/open-protocol.adoc b/plc4j/drivers/all/src/site/generated/open-protocol.adoc
index 164ee59d75..11d4ebe2e3 100644
--- a/plc4j/drivers/all/src/site/generated/open-protocol.adoc
+++ b/plc4j/drivers/all/src/site/generated/open-protocol.adoc
@@ -41,7 +41,7 @@
+++
<h4>tcp</h4>
+++
-|`tcp.keep-alive` |BOOLEAN |false| |Should keep-alive packets be sent?
-|`tcp.no-delay` |BOOLEAN |true| |Should packets be sent instantly or should we give the OS some time to aggregate data.
-|`tcp.default-timeout` |INT |1000| |Timeout after which a connection will be treated as disconnected.
+|`tcp.keep-alive` |BOOLEAN |false| |Should keep-alive packets be sent?)
+|`tcp.no-delay` |BOOLEAN |true| |Should packets be sent instantly or should we give the OS some time to aggregate data.)
+|`tcp.default-timeout` |INT |1000| |Timeout after which a connection will be treated as disconnected.)
|===
diff --git a/plc4j/drivers/all/src/site/generated/plc4x.adoc b/plc4j/drivers/all/src/site/generated/plc4x.adoc
index 4c50a337c8..2d2798af83 100644
--- a/plc4j/drivers/all/src/site/generated/plc4x.adoc
+++ b/plc4j/drivers/all/src/site/generated/plc4x.adoc
@@ -36,14 +36,14 @@
|Supported Transports 4+|
- `tcp`
5+|Config options:
-|`remote-connection-string` |STRING | | |URL-Encoded connection string to use on the proxy side to reach the given PLC.
-|`request-timeout` |INT |5000| |Default timeout for all types of requests.
+|`remote-connection-string` |STRING | | |URL-Encoded connection string to use on the proxy side to reach the given PLC.)
+|`request-timeout` |INT |5000| |Default timeout for all types of requests.)
5+|Transport config options:
5+|
+++
<h4>tcp</h4>
+++
-|`tcp.keep-alive` |BOOLEAN |false| |Should keep-alive packets be sent?
-|`tcp.no-delay` |BOOLEAN |true| |Should packets be sent instantly or should we give the OS some time to aggregate data.
-|`tcp.default-timeout` |INT |1000| |Timeout after which a connection will be treated as disconnected.
+|`tcp.keep-alive` |BOOLEAN |false| |Should keep-alive packets be sent?)
+|`tcp.no-delay` |BOOLEAN |true| |Should packets be sent instantly or should we give the OS some time to aggregate data.)
+|`tcp.default-timeout` |INT |1000| |Timeout after which a connection will be treated as disconnected.)
|===
diff --git a/plc4j/drivers/all/src/site/generated/profinet.adoc b/plc4j/drivers/all/src/site/generated/profinet.adoc
index 116490b384..4c6c787744 100644
--- a/plc4j/drivers/all/src/site/generated/profinet.adoc
+++ b/plc4j/drivers/all/src/site/generated/profinet.adoc
@@ -36,15 +36,15 @@
|Supported Transports 4+|
- `raw`
5+|Config options:
-|`gsd-directory` |STRING |~/.gsd|required |
-|`dap-id` |STRING | | |
-|`ip-address` |STRING | | |
+|`gsd-directory` |STRING |~/.gsd|required |)
+|`dap-id` |STRING | | |)
+|`ip-address` |STRING | | |)
5+|Transport config options:
5+|
+++
<h4>raw</h4>
+++
-|`raw.resolve-mac-address` |BOOLEAN | | |If set to true, the transport will automatically resolve the MAC address for a given IP address (Allows connecting to a raw-socket device using the devices host-name or ip-address).
-|`raw.support-vlans` |BOOLEAN |false| |Should VLan packets be automatically unpacked?
-|`raw.protocol-id` |INT |-1| |When provided, filters all packets to let only packets matching this ethernet protocol-id pass.
+|`raw.resolve-mac-address` |BOOLEAN | | |If set to true, the transport will automatically resolve the MAC address for a given IP address (Allows connecting to a raw-socket device using the devices host-name or ip-address).)
+|`raw.support-vlans` |BOOLEAN |false| |Should VLan packets be automatically unpacked?)
+|`raw.protocol-id` |INT |-1| |When provided, filters all packets to let only packets matching this ethernet protocol-id pass.)
|===
diff --git a/plc4j/drivers/all/src/site/generated/s7.adoc b/plc4j/drivers/all/src/site/generated/s7.adoc
index a6717a119e..87d225430e 100644
--- a/plc4j/drivers/all/src/site/generated/s7.adoc
+++ b/plc4j/drivers/all/src/site/generated/s7.adoc
@@ -36,32 +36,47 @@
|Supported Transports 4+|
- `tcp`
5+|Config options:
-|`local-rack` |INT |1| |Rack value for the client (PLC4X device).
-|`local-slot` |INT |1| |Slot value for the client (PLC4X device).
-|`local-tsap` |INT |0| |Local Transport Service Access Point.
-|`remote-rack` |INT |0| |Rack value for the remote main CPU (PLC).
-|`remote-slot` |INT |0| |Slot value for the remote main CPU (PLC).
-|`remote-rack2` |INT |0| |Rack value for the remote secondary CPU (PLC).
-|`remote-slot2` |INT |0| |Slot value for the remote secondary CPU (PLC).
-|`remote-tsap` |INT |0| |Remote Transport Service Access Point.
-|`pdu-size` |INT |1024| |Maximum size of a data-packet sent to and received from the remote PLC. During the connection process both parties will negotiate a maximum size both parties can work with and is equal or smaller than the given value is used. The driver will automatically split up large requests to not exceed this value in a request or expected response.
-|`max-amq-caller` |INT |8| |Maximum number of unconfirmed requests the PLC will accept in parallel before discarding with errors. This parameter also will be negotiated during the connection process and the maximum both parties can work with and is equal or smaller than the given value is used. The driver will automatically take care not exceeding this value while processing requests. Too many requests can cause a growing queue.
-|`max-amq-callee` |INT |8| |Maximum number of unconfirmed responses or requests PLC4X will accept in parallel before discarding with errors. This option is available for completeness and is correctly handled out during the connection process, however it is currently not enforced on PLC4X’s side. So if a PLC would send more messages than agreed upon, these would still be processed.
-|`controller-type` |STRING | | |As part of the connection process, usually the PLC4X S7 driver would try to identify the remote device. However some devices seem to have problems with this and hang up or cause other problems. In such a case, providing the controller-type will skip the identification process and hereby avoid this type of problem. Possible values are:/n- S7_300
-- S7_400
-- S7_1200
-- 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).
+|`local-rack` |INT |1| |Rack value for the client (PLC4X device).)
+|`local-slot` |INT |1| |Slot value for the client (PLC4X device).)
+|`local-device-group` |STRING |OTHERS| |Local Device Group. (Defaults to 'OTHERS'). +
+Allowed values: +
+ - PG_OR_PC +
+ - OS +
+ - OTHERS)
+|`local-tsap` |INT |0| |Local Transport Service Access Point. (Overrides settings made in local-rack, local-slot and local-device-group. Be sure to convert into integer representation))
+|`remote-rack` |INT |0| |Rack value for the remote main CPU (PLC).)
+|`remote-slot` |INT |0| |Slot value for the remote main CPU (PLC).)
+|`remote-device-group` |STRING |PG_OR_PC| |Remote Device Group (Defaults to 'PG_OR_PC'). +
+Allowed values: +
+ - PG_OR_PC +
+ - OS +
+ - OTHERS)
+|`remote-tsap` |INT |0| |Remote Transport Service Access Point. (Overrides settings made in remote-rack, remote-slot and remote-device-group. Be sure to convert into integer representation))
+|`remote-rack2` |INT |0| |Rack value for the remote secondary CPU (PLC).)
+|`remote-slot2` |INT |0| |Slot value for the remote secondary CPU (PLC).)
+|`remote-device-group2` |STRING |PG_OR_PC| |Remote Device Group. (Defaults to 'PG_OR_PC'). +
+Allowed values: +
+ - PG_OR_PC +
+ - OS +
+ - OTHERS)
+|`pdu-size` |INT |1024| |Maximum size of a data-packet sent to and received from the remote PLC. During the connection process both parties will negotiate a maximum size both parties can work with and is equal or smaller than the given value is used. The driver will automatically split up large requests to not exceed this value in a request or expected response.)
+|`max-amq-caller` |INT |8| |Maximum number of unconfirmed requests the PLC will accept in parallel before discarding with errors. This parameter also will be negotiated during the connection process and the maximum both parties can work with and is equal or smaller than the given value is used. The driver will automatically take care not exceeding this value while processing requests. Too many requests can cause a growing queue.)
+|`max-amq-callee` |INT |8| |Maximum number of unconfirmed responses or requests PLC4X will accept in parallel before discarding with errors. This option is available for completeness and is correctly handled out during the connection process, however it is currently not enforced on PLC4X’s side. So if a PLC would send more messages than agreed upon, these would still be processed.)
+|`controller-type` |STRING | | |As part of the connection process, usually the PLC4X S7 driver would try to identify the remote device. However some devices seem to have problems with this and hang up or cause other problems. In such a case, providing the controller-type will skip the identification process and hereby avoid this type of problem. Possible values are:/n- S7_300 +
+- S7_400 +
+- S7_1200 +
+- 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).)
5+|Transport config options:
5+|
+++
<h4>tcp</h4>
+++
-|`tcp.keep-alive` |BOOLEAN |false| |Should keep-alive packets be sent?
-|`tcp.no-delay` |BOOLEAN |true| |Should packets be sent instantly or should we give the OS some time to aggregate data.
-|`tcp.default-timeout` |INT |1000| |Timeout after which a connection will be treated as disconnected.
+|`tcp.keep-alive` |BOOLEAN |false| |Should keep-alive packets be sent?)
+|`tcp.no-delay` |BOOLEAN |true| |Should packets be sent instantly or should we give the OS some time to aggregate data.)
+|`tcp.default-timeout` |INT |1000| |Timeout after which a connection will be treated as disconnected.)
|===
diff --git a/plc4j/drivers/all/src/site/groovy/generate-config-documentation.groovy b/plc4j/drivers/all/src/site/groovy/generate-config-documentation.groovy
index ba2e0c63f8..64ebcd1855 100644
--- a/plc4j/drivers/all/src/site/groovy/generate-config-documentation.groovy
+++ b/plc4j/drivers/all/src/site/groovy/generate-config-documentation.groovy
@@ -24,7 +24,9 @@ import org.apache.plc4x.java.api.metadata.Option
def static outputOptions(List<Option> options, String prefix, PrintStream printStream) {
options.each {option->
def name = prefix?"$prefix.$option.key":option.key
- printStream.println "|`$name` |$option.type |${option.defaultValue.orElse(' ')}|${option.required?'required':''} |$option.description"
+ // Convert java line-breaks into asciidoctor line-breaks.
+ def description = option.description.replaceAll('\n', " +\n")
+ printStream.println "|`$name` |$option.type |${option.defaultValue.orElse(' ')}|${option.required?'required':''} |$description)"
}
}
(plc4x) 03/03: feat: Added device-group options for local, remote and remote2 to the S7 config.
Posted by cd...@apache.org.
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
commit 8163b9ed8fa481a1e3c5f59be7bb822ade4e0bf1
Author: Christofer Dutz <cd...@apache.org>
AuthorDate: Fri Apr 19 09:57:53 2024 +0200
feat: Added device-group options for local, remote and remote2 to the S7 config.
---
.../readwrite/configuration/S7Configuration.java | 51 +++++++++++++++++++---
.../java/s7/readwrite/context/S7DriverContext.java | 7 ++-
2 files changed, 49 insertions(+), 9 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 b080da97ed..1b62b06823 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
@@ -18,11 +18,13 @@
*/
package org.apache.plc4x.java.s7.readwrite.configuration;
+import org.apache.plc4x.java.s7.readwrite.DeviceGroup;
import org.apache.plc4x.java.spi.configuration.PlcConnectionConfiguration;
import org.apache.plc4x.java.spi.configuration.annotations.ConfigurationParameter;
import org.apache.plc4x.java.spi.configuration.annotations.Description;
import org.apache.plc4x.java.spi.configuration.annotations.defaults.BooleanDefaultValue;
import org.apache.plc4x.java.spi.configuration.annotations.defaults.IntDefaultValue;
+import org.apache.plc4x.java.spi.configuration.annotations.defaults.StringDefaultValue;
public class S7Configuration implements PlcConnectionConfiguration {
@@ -36,9 +38,14 @@ public class S7Configuration implements PlcConnectionConfiguration {
@Description("Slot value for the client (PLC4X device).")
public int localSlot = 1;
+ @ConfigurationParameter("local-device-group")
+ @StringDefaultValue("OTHERS")
+ @Description("Local Device Group. (Defaults to 'OTHERS').\nAllowed values:\n - PG_OR_PC\n - OS\n - OTHERS")
+ public DeviceGroup localDeviceGroup;
+
@ConfigurationParameter("local-tsap")
@IntDefaultValue(0)
- @Description("Local Transport Service Access Point.")
+ @Description("Local Transport Service Access Point. (Overrides settings made in local-rack, local-slot and local-device-group. Be sure to convert into integer representation)")
public int localTsap = 0;
@ConfigurationParameter("remote-rack")
@@ -51,6 +58,16 @@ public class S7Configuration implements PlcConnectionConfiguration {
@Description("Slot value for the remote main CPU (PLC).")
public int remoteSlot = 0;
+ @ConfigurationParameter("remote-device-group")
+ @StringDefaultValue("PG_OR_PC")
+ @Description("Remote Device Group (Defaults to 'PG_OR_PC').\nAllowed values:\n - PG_OR_PC\n - OS\n - OTHERS")
+ public DeviceGroup remoteDeviceGroup;
+
+ @ConfigurationParameter("remote-tsap")
+ @IntDefaultValue(0)
+ @Description("Remote Transport Service Access Point. (Overrides settings made in remote-rack, remote-slot and remote-device-group. Be sure to convert into integer representation)")
+ public int remoteTsap = 0;
+
@ConfigurationParameter("remote-rack2")
@IntDefaultValue(0)
@Description("Rack value for the remote secondary CPU (PLC).")
@@ -61,10 +78,10 @@ public class S7Configuration implements PlcConnectionConfiguration {
@Description("Slot value for the remote secondary CPU (PLC).")
public int remoteSlot2 = 0;
- @ConfigurationParameter("remote-tsap")
- @IntDefaultValue(0)
- @Description("Remote Transport Service Access Point.")
- public int remoteTsap = 0;
+ @ConfigurationParameter("remote-device-group2")
+ @StringDefaultValue("PG_OR_PC")
+ @Description("Remote Device Group. (Defaults to 'PG_OR_PC').\nAllowed values:\n - PG_OR_PC\n - OS\n - OTHERS")
+ public DeviceGroup remoteDeviceGroup2;
@ConfigurationParameter("pdu-size")
@IntDefaultValue(1024)
@@ -121,6 +138,14 @@ public class S7Configuration implements PlcConnectionConfiguration {
this.localSlot = localSlot;
}
+ public DeviceGroup getLocalDeviceGroup() {
+ return localDeviceGroup;
+ }
+
+ public void setLocalDeviceGroup(DeviceGroup localDeviceGroup) {
+ this.localDeviceGroup = localDeviceGroup;
+ }
+
public int getLocalTsap() {
return localTsap;
}
@@ -145,6 +170,14 @@ public class S7Configuration implements PlcConnectionConfiguration {
this.remoteSlot = remoteSlot;
}
+ public DeviceGroup getRemoteDeviceGroup() {
+ return remoteDeviceGroup;
+ }
+
+ public void setRemoteDeviceGroup(DeviceGroup remoteDeviceGroup) {
+ this.remoteDeviceGroup = remoteDeviceGroup;
+ }
+
public int getRemoteRack2() {
return remoteRack2;
}
@@ -153,6 +186,14 @@ public class S7Configuration implements PlcConnectionConfiguration {
this.remoteRack2 = remoteRack2;
}
+ public DeviceGroup getRemoteDeviceGroup2() {
+ return remoteDeviceGroup2;
+ }
+
+ public void setRemoteDeviceGroup2(DeviceGroup remoteDeviceGroup2) {
+ this.remoteDeviceGroup2 = remoteDeviceGroup2;
+ }
+
public int getRemoteSlot2() {
return remoteSlot2;
}
diff --git a/plc4j/drivers/s7/src/main/java/org/apache/plc4x/java/s7/readwrite/context/S7DriverContext.java b/plc4j/drivers/s7/src/main/java/org/apache/plc4x/java/s7/readwrite/context/S7DriverContext.java
index 1a30d7d55f..8f29a946ec 100644
--- a/plc4j/drivers/s7/src/main/java/org/apache/plc4x/java/s7/readwrite/context/S7DriverContext.java
+++ b/plc4j/drivers/s7/src/main/java/org/apache/plc4x/java/s7/readwrite/context/S7DriverContext.java
@@ -46,15 +46,14 @@ public class S7DriverContext implements DriverContext, HasConfiguration<S7Config
@Override
public void setConfiguration(S7Configuration configuration) {
- this.callingTsapId = S7TsapIdEncoder.encodeS7TsapId(DeviceGroup.OTHERS,
+ this.callingTsapId = S7TsapIdEncoder.encodeS7TsapId(configuration.localDeviceGroup,
configuration.localRack, configuration.localSlot);
- this.calledTsapId = S7TsapIdEncoder.encodeS7TsapId(DeviceGroup.PG_OR_PC,
+ this.calledTsapId = S7TsapIdEncoder.encodeS7TsapId(configuration.remoteDeviceGroup,
configuration.remoteRack, configuration.remoteSlot);
- this.calledTsapId2 = S7TsapIdEncoder.encodeS7TsapId(DeviceGroup.PG_OR_PC,
+ this.calledTsapId2 = S7TsapIdEncoder.encodeS7TsapId(configuration.remoteDeviceGroup2,
configuration.remoteRack2, configuration.remoteSlot2);
-
if (configuration.localTsap > 0) {
this.callingTsapId = configuration.localTsap;
}