Skip to content

Commit

Permalink
docs: Updated the way the headlines of the transport options are high…
Browse files Browse the repository at this point in the history
…lighted to using h4 blocks.
  • Loading branch information
chrisdutz committed Feb 14, 2024
1 parent ccd8bd2 commit b5912bd
Show file tree
Hide file tree
Showing 20 changed files with 103 additions and 26 deletions.
5 changes: 4 additions & 1 deletion plc4j/drivers/all/src/site/generated/ab-eth.adoc
Expand Up @@ -38,7 +38,10 @@
5+|Config options:
|`station` |INT | | |Id of the station we want to connect to
5+|Transport config options:
5+| - `tcp`
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.
Expand Down
5 changes: 4 additions & 1 deletion plc4j/drivers/all/src/site/generated/ads.adoc
Expand Up @@ -43,7 +43,10 @@
|`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`
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.
Expand Down
15 changes: 12 additions & 3 deletions plc4j/drivers/all/src/site/generated/bacnet-ip.adoc
Expand Up @@ -41,14 +41,23 @@
|`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`
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.
5+| - `tcp`
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.
5+| - `pcap`
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)
Expand Down
5 changes: 4 additions & 1 deletion plc4j/drivers/all/src/site/generated/c-bus.adoc
Expand Up @@ -38,7 +38,10 @@
5+|Config options:
|`srchk` |BOOLEAN |false| |Source check.
5+|Transport config options:
5+| - `tcp`
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.
Expand Down
5 changes: 4 additions & 1 deletion plc4j/drivers/all/src/site/generated/canopen.adoc
Expand Up @@ -40,5 +40,8 @@
|`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`
5+|
+++
<h4>socketcan</h4>
+++
|===
5 changes: 4 additions & 1 deletion plc4j/drivers/all/src/site/generated/eip.adoc
Expand Up @@ -40,7 +40,10 @@
|`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`
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.
Expand Down
5 changes: 4 additions & 1 deletion plc4j/drivers/all/src/site/generated/firmata.adoc
Expand Up @@ -37,7 +37,10 @@
- `serial`
5+|Config options:
5+|Transport config options:
5+| - `serial`
5+|
+++
<h4>serial</h4>
+++
|`serial.baud-rate` |INT |57600| |Baud-rate the serial port is set to.
Typical values are:
- 9600
Expand Down
5 changes: 4 additions & 1 deletion plc4j/drivers/all/src/site/generated/genericcan.adoc
Expand Up @@ -39,5 +39,8 @@
|`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`
5+|
+++
<h4>socketcan</h4>
+++
|===
5 changes: 4 additions & 1 deletion plc4j/drivers/all/src/site/generated/iec-60870-5-104.adoc
Expand Up @@ -38,7 +38,10 @@
5+|Config options:
|`request-timeout` |INT |4000| |Default timeout for all types of requests.
5+|Transport config options:
5+| - `tcp`
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.
Expand Down
15 changes: 12 additions & 3 deletions plc4j/drivers/all/src/site/generated/knxnet-ip.adoc
Expand Up @@ -53,10 +53,16 @@ The default is 3 levels. If the `knxproj-file-path` this information is provided
- '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+| - `udp`
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.
5+| - `pcap`
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
Expand All @@ -68,7 +74,10 @@ Use this configuration option in order to define the port number of the local po
|`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`
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.
Expand Down
5 changes: 4 additions & 1 deletion plc4j/drivers/all/src/site/generated/logix.adoc
Expand Up @@ -43,7 +43,10 @@ or if using Ethernet an ip address. e.g. [1,4,2,192.168.0.1,1,1] - Routes to the
|`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`
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.
Expand Down
10 changes: 8 additions & 2 deletions plc4j/drivers/all/src/site/generated/modbus-ascii.adoc
Expand Up @@ -40,11 +40,17 @@
|`request-timeout` |INT |5000| |Default timeout for all types of requests.
|`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`
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.
5+| - `serial`
5+|
+++
<h4>serial</h4>
+++
|`serial.baud-rate` |INT |57600| |Baud-rate the serial port is set to.
Typical values are:
- 9600
Expand Down
10 changes: 8 additions & 2 deletions plc4j/drivers/all/src/site/generated/modbus-rtu.adoc
Expand Up @@ -40,11 +40,17 @@
|`request-timeout` |INT |5000| |Default timeout for all types of requests.
|`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`
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.
5+| - `serial`
5+|
+++
<h4>serial</h4>
+++
|`serial.baud-rate` |INT |57600| |Baud-rate the serial port is set to.
Typical values are:
- 9600
Expand Down
5 changes: 4 additions & 1 deletion plc4j/drivers/all/src/site/generated/modbus-tcp.adoc
Expand Up @@ -39,7 +39,10 @@
|`request-timeout` |INT |5000| |Default timeout for all types of requests.
|`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`
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.
Expand Down
5 changes: 4 additions & 1 deletion plc4j/drivers/all/src/site/generated/opcua.adoc
Expand Up @@ -70,7 +70,10 @@ Possible values are between others `jks`, `pkcs11`, `dks`, `jceks`.
|`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+| - `tcp`
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.
Expand Down
5 changes: 4 additions & 1 deletion plc4j/drivers/all/src/site/generated/open-protocol.adoc
Expand Up @@ -37,7 +37,10 @@
- `tcp`
5+|Config options:
5+|Transport config options:
5+| - `tcp`
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.
Expand Down
5 changes: 4 additions & 1 deletion plc4j/drivers/all/src/site/generated/plc4x.adoc
Expand Up @@ -39,7 +39,10 @@
|`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+| - `tcp`
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.
Expand Down
5 changes: 4 additions & 1 deletion plc4j/drivers/all/src/site/generated/profinet.adoc
Expand Up @@ -40,7 +40,10 @@
|`dap-id` |STRING | | |
|`ip-address` |STRING | | |
5+|Transport config options:
5+| - `raw`
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.
Expand Down
5 changes: 4 additions & 1 deletion plc4j/drivers/all/src/site/generated/s7.adoc
Expand Up @@ -57,7 +57,10 @@
|`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+| - `tcp`
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.
Expand Down
Expand Up @@ -117,7 +117,9 @@ for (final def protocolCode in plcDriverManager.listProtocolCodes()) {
if(!driver.metadata.supportedTransportCodes.empty) {
printStream.println "5+|Transport config options:"
for (final def transportCode in driver.metadata.supportedTransportCodes) {
printStream.println "5+| - `" + transportCode + "`"
printStream.println "5+|\n+++\n" +
"<h4>$transportCode</h4>\n" +
"+++"
driver.metadata.getTransportConfigurationOptionMetadata(transportCode).map {
outputOptions(it.options, transportCode, printStream)
}
Expand Down

0 comments on commit b5912bd

Please sign in to comment.