fix: Fixed several issues with the new generated-documentation.

plc4j/drivers/ads/src/main/java/org/apache/plc4x/java/ads/configuration/AdsConfiguration.java

@@ -37,7 +37,7 @@ public class AdsConfiguration implements PlcConnectionConfiguration {
     @Required
     @ConfigurationParameter("target-ams-net-id")
     @ParameterConverter(AmsNetIdConverter.class)
-    @Description("AMS-Net-Id of the target.")
+    @Description("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.")
     protected AmsNetId targetAmsNetId;
 
     @Required
@@ -48,7 +48,7 @@ public class AdsConfiguration implements PlcConnectionConfiguration {
     @Required
     @ConfigurationParameter("source-ams-net-id")
     @ParameterConverter(AmsNetIdConverter.class)
-    @Description("AMS-Net-Id of the source.")
+    @Description("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.")
     protected AmsNetId sourceAmsNetId;
 
     @Required

plc4j/drivers/all/pom.xml

@@ -180,5 +180,12 @@
       <version>0.12.0-SNAPSHOT</version>
       <scope>runtime</scope>
     </dependency>
+
+    <dependency>
+      <groupId>org.apache.plc4x</groupId>
+      <artifactId>plc4j-transport-serial</artifactId>
+      <version>0.12.0-SNAPSHOT</version>
+      <scope>runtime</scope>
+    </dependency>
   </dependencies>
 </project>

plc4j/drivers/all/src/site/generated/ab-eth.adoc

@@ -35,7 +35,10 @@
 |Supported Transports 4+|
  - `tcp`
 5+|Config options:
-|`` |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+| - `tcp`
+|`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.
 |===

plc4j/drivers/all/src/site/generated/ads.adoc

@@ -35,13 +35,15 @@
 |Supported Transports 4+|
  - `tcp`
 5+|Config options:
-|`` |STRUCT || |
-|`target-ams-net-id` |STRUCT ||required |AMS-Net-Id of the target.
-|`target-ams-port` |INT ||required |AMS port of the target.
-|`source-ams-net-id` |STRUCT ||required |AMS-Net-Id of the source.
-|`source-ams-port` |INT ||required |AMS port of the source.
+|`target-ams-net-id` |STRING | |required |AMS-Net-Id of the target.
+|`target-ams-port` |INT | |required |AMS port of the target.
+|`source-ams-net-id` |STRING | |required |AMS-Net-Id of the source.
+|`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+| - `tcp`
+|`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.
 |===

plc4j/drivers/all/src/site/generated/bacnet-ip.adoc

@@ -37,11 +37,27 @@
  - `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+| - `udp`
+|`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+| - `tcp`
+|`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+| - `pcap`
 |`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.
 |===

plc4j/drivers/all/src/site/generated/c-bus.adoc

@@ -38,4 +38,7 @@
 |`srchk` |BOOLEAN |false| |Source check.
 5+|Transport config options:
 5+| - `tcp`
+|`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.
 |===

plc4j/drivers/all/src/site/generated/canopen.adoc

@@ -33,8 +33,11 @@
 ----
 |Default Transport 4+|`socketcan`
 |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.
-|`` |BOOLEAN || |Forces PLC4X to send CANopen heartbeat (NMT) messages to the bus.
+|`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+| - `socketcan`
 |===

plc4j/drivers/all/src/site/generated/eip.adoc

@@ -35,9 +35,12 @@
 |Supported Transports 4+|
  - `tcp`
 5+|Config options:
-|`` |INT || |Without using routing information the backplane defaults to 1. This is overridden if communicationPath is provided.
-|`` |INT || |The slot within the backplane the CPU is located.
-|`` |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+| - `tcp`
+|`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.
 |===

plc4j/drivers/all/src/site/generated/firmata.adoc

@@ -37,4 +37,32 @@
 5+|Config options:
 5+|Transport config options:
 5+| - `serial`
+|`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` |STRUCT |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
 |===

plc4j/drivers/all/src/site/generated/genericcan.adoc

@@ -33,7 +33,10 @@
 ----
 |Default Transport 4+|`socketcan`
 |Supported Transports 4+|
+ - `socketcan`
 5+|Config options:
-|`node-id` |INT || |Node id of the target device.
+|`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+| - `socketcan`
 |===

plc4j/drivers/all/src/site/generated/iec-60870-5-104.adoc

@@ -38,4 +38,7 @@
 |`request-timeout` |INT |4000| |Default timeout for all types of requests.
 5+|Transport config options:
 5+| - `tcp`
+|`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.
 |===

plc4j/drivers/all/src/site/generated/knxnet-ip.adoc

@@ -37,8 +37,8 @@
  - `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.
+|`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)}
@@ -53,6 +53,22 @@ The default is 3 levels. If the `knxproj-file-path` this information is provided
 - '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+| - `udp`
+|`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+| - `pcap`
+|`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+| - `raw`
+|`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.
 |===

plc4j/drivers/all/src/site/generated/logix.adoc

@@ -35,9 +35,15 @@
 |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.
+|`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+| - `tcp`
+|`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.
 |===

plc4j/drivers/all/src/site/generated/modbus-ascii.adoc

@@ -40,5 +40,36 @@
 |`unit-identifier` |INT |1| |Unit-identifier that identifies the target PLC (On RS485 multiple Modbus Devices can be listening). Defaults to 1.
 5+|Transport config options:
 5+| - `tcp`
+|`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+| - `serial`
+|`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` |STRUCT |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
 |===

plc4j/drivers/all/src/site/generated/modbus-rtu.adoc

@@ -40,5 +40,36 @@
 |`unit-identifier` |INT |1| |Unit-identifier that identifies the target PLC (On RS485 multiple Modbus Devices can be listening). Defaults to 1.
 5+|Transport config options:
 5+| - `tcp`
+|`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+| - `serial`
+|`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` |STRUCT |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
 |===

plc4j/drivers/all/src/site/generated/modbus-tcp.adoc

@@ -39,4 +39,7 @@
 |`unit-identifier` |INT |1| |Unit-identifier that identifies the target PLC (On RS485 multiple Modbus Devices can be listening). Defaults to 1.
 5+|Transport config options:
 5+| - `tcp`
+|`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.
 |===

plc4j/drivers/all/src/site/generated/opcua.adoc

@@ -35,37 +35,39 @@
 |Supported Transports 4+|
  - `tcp`
 5+|Config options:
-|`protocol-code` |STRING || |
-|`transport-code` |STRING || |
-|`transport-config` |STRING || |
+|`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.
+|`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-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.
+|`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.
-|`` |STRUCT || |
+|`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.
-|`` |STRUCT || |TCP encoding options
+|`encoding` |STRUCT | | |TCP encoding options
 5+|Transport config options:
 5+| - `tcp`
+|`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.
 |===

plc4j/drivers/all/src/site/generated/open-protocol.adoc

@@ -37,4 +37,7 @@
 5+|Config options:
 5+|Transport config options:
 5+| - `tcp`
+|`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.
 |===