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/02/13 17:43:18 UTC
(plc4x) branch develop updated (267f597ce0 -> 70bf2a5caa)
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 267f597ce0 build(deps): bump golang.org/x/tools from 0.17.0 to 0.18.0 in /plc4go (#1402)
add 70bf2a5caa Auto-Generated Driver Documentation
No new revisions were added by this update.
Summary of changes:
Jenkinsfile | 4 +-
RELEASE_NOTES | 2 +
.../testing/protocols/ads/DriverTestsuite.xml | 8 +-
.../apache/plc4x/java/DefaultPlcDriverManager.java | 2 +-
.../java/org/apache/plc4x/java/api/PlcDriver.java | 25 +-
.../apache/plc4x/java/api/PlcDriverManager.java | 2 +-
...ionConfiguration.java => PlcConfiguration.java} | 4 +-
.../configuration/PlcConnectionConfiguration.java | 4 +-
.../configuration/PlcTransportConfiguration.java} | 7 +-
.../org/apache/plc4x/java/abeth/AbEthDriver.java | 23 +-
.../abeth/configuration/AbEthConfiguration.java | 6 +-
.../org/apache/plc4x/java/ads/AdsPlcDriver.java | 23 +-
.../java/ads/configuration/AdsConfiguration.java | 30 +--
plc4j/drivers/all/pom.xml | 39 +++
.../drivers/all/src/site/generated/ab-eth.adoc | 91 ++-----
plc4j/drivers/all/src/site/generated/ads.adoc | 49 ++++
.../drivers/all/src/site/generated/bacnet-ip.adoc | 60 +++++
.../drivers/all/src/site/generated/c-bus.adoc | 91 ++-----
.../drivers/all/src/site/generated/canopen.adoc | 30 ++-
plc4j/drivers/all/src/site/generated/eip.adoc | 46 ++++
.../drivers/all/src/site/generated/firmata.adoc | 27 +-
.../drivers/all/src/site/generated/genericcan.adoc | 29 ++-
.../all/src/site/generated/iec-60870-5-104.adoc | 91 ++-----
.../drivers/all/src/site/generated/knxnet-ip.adoc | 74 ++++++
plc4j/drivers/all/src/site/generated/logix.adoc | 49 ++++
.../all/src/site/generated/modbus-ascii.adoc | 94 ++-----
.../drivers/all/src/site/generated/modbus-rtu.adoc | 94 ++-----
.../drivers/all/src/site/generated/modbus-tcp.adoc | 92 ++-----
plc4j/drivers/all/src/site/generated/opcua.adoc | 70 +++++
.../all/src/site/generated/open-protocol.adoc | 90 ++-----
.../drivers/all/src/site/generated/plc4x.adoc | 92 ++-----
.../drivers/all/src/site/generated/profinet.adoc | 93 ++-----
plc4j/drivers/all/src/site/generated/s7.adoc | 63 +++++
.../drivers/all/src/site/generated/simulated.adoc | 26 +-
.../groovy/generate-config-documentation.groovy | 210 +++++++++++++++
.../apache/plc4x/java/bacnetip/BacNetIpDriver.java | 28 +-
.../configuration/BacNetIpConfiguration.java | 7 +-
.../BacNetPcapReplayTransportConfiguration.java | 2 +
.../BacNetRawSocketTransportConfiguration.java | 2 +
.../org/apache/plc4x/java/cbus/CBusDriver.java | 23 +-
.../java/cbus/configuration/CBusConfiguration.java | 6 +-
.../conversation/ConversationContextWrapper.java | 4 +-
.../plc4x/java/can/generic/GenericCANDriver.java | 6 +-
.../configuration/GenericCANConfiguration.java | 9 +-
.../plc4x/java/canopen/CANOpenPlcDriver.java | 6 +-
.../configuration/CANOpenConfiguration.java | 10 +-
.../plc4x/java/ctrlx/readwrite/CtrlXDriver.java | 24 +-
.../configuration/CtrlXConfiguration.java | 6 +-
.../readwrite/connection/CtrlXConnection.java | 2 +-
.../plc4x/java/ctrlx/readwrite/tag/CtrlXQuery.java | 2 +-
.../plc4x/java/ctrlx/readwrite/tag/CtrlXTag.java | 2 +-
.../java/ctrlx/readwrite/tag/CtrlXTagHandler.java | 2 +-
.../ctrlx/readwrite/utils/ApiClientFactory.java | 2 +-
.../java/ctrlx/readwrite/utils/OauthHelper.java | 2 +-
.../plc4x/java/ctrlx/readwrite/BrowseTest.java | 2 +-
.../java/ctrlx/readwrite/ManualDriverTest.java | 2 +-
.../org/apache/plc4x/java/eip/base/EIPDriver.java | 29 ++-
.../eip/base/configuration/EIPConfiguration.java | 12 +-
.../apache/plc4x/java/eip/logix/LogixDriver.java | 26 +-
.../logix/configuration/LogixConfiguration.java | 6 +-
.../LogixTcpTransportConfiguration.java} | 13 +-
.../java/firmata/readwrite/FirmataDriver.java | 5 +-
.../configuration/FirmataConfiguration.java | 4 +-
.../java/firmata/readwrite/FirmataManualTest.java | 2 +-
.../readwrite/Iec60870514PlcDriver.java | 23 +-
.../configuration/Iec608705014Configuration.java | 18 +-
.../readwrite/protocol/Iec608705104Protocol.java | 4 +-
.../apache/plc4x/java/knxnetip/KnxNetIpDriver.java | 27 +-
.../configuration/KnxNetIpConfiguration.java | 19 +-
.../plc4x/java/modbus/ascii/ModbusAsciiDriver.java | 23 +-
.../ascii/config/ModbusAsciiConfiguration.java | 7 +-
.../plc4x/java/modbus/rtu/ModbusRtuDriver.java | 23 +-
.../modbus/rtu/config/ModbusRtuConfiguration.java | 7 +-
.../plc4x/java/modbus/tcp/ModbusTcpDriver.java | 23 +-
.../modbus/tcp/config/ModbusTcpConfiguration.java | 7 +-
...rTest.java => ManualModbusASCIIDriverTest.java} | 11 +-
.../java/modbus/ManualModbusRTUDriverTest.java | 5 +-
.../apache/plc4x/java/opcua/OpcuaPlcDriver.java | 5 +-
.../org/apache/plc4x/java/opcua/config/Limits.java | 35 ++-
.../java/opcua/config/OpcuaConfiguration.java | 106 +++++---
.../java/opcua/protocol/OpcuaProtocolLogic.java | 2 +-
.../plc4x/java/opcua/OpcuaPlcDriverTest.java | 8 +-
.../protocol/OpcuaSubscriptionHandleTest.java | 1 -
.../java/openprotocol/OpenProtocolDriver.java | 23 +-
.../config/OpenProtocolConfiguration.java | 4 +-
.../org/apache/plc4x/java/plc4x/Plc4xDriver.java | 23 +-
.../java/plc4x/config/Plc4xConfiguration.java | 7 +-
.../apache/plc4x/java/profinet/ProfinetDriver.java | 36 +--
.../profinet/config/ProfinetConfiguration.java | 4 +-
.../profinet/ManualProfinetIoTestZylkSimocode.java | 2 +-
.../apache/plc4x/java/profinet/ProfinetDriver.java | 23 +-
.../profinet/config/ProfinetConfiguration.java | 25 +-
.../java/profinet/ManualProfinetPcapTest.java | 2 +-
.../apache/plc4x/java/s7/readwrite/S7Driver.java | 6 +-
.../readwrite/configuration/S7Configuration.java | 22 +-
.../readwrite/protocol/S7HGeneratedDriverBase.java | 50 ++--
.../s7/readwrite/protocol/S7HPlcConnection.java | 3 +-
.../readwrite/tag/S7StringFixedLengthTagTest.java | 2 +-
.../configuration/SimulatedConfiguration.java | 6 +-
.../examples/hellodiscovery/HelloDiscovery.java | 3 +-
.../HelloPlc4xDiscoverAndBrowse.java | 2 +-
.../apache/plc4x/java/spi/ConversationContext.java | 4 +-
.../apache/plc4x/java/spi/Plc4xNettyWrapper.java | 4 +-
.../java/spi/configuration/Configuration.java | 25 --
.../spi/configuration/ConfigurationFactory.java | 31 ++-
.../java/spi/configuration/HasConfiguration.java | 4 +-
.../annotations/Description.java} | 12 +-
.../spi/connection/DefaultNettyPlcConnection.java | 5 +-
.../java/spi/connection/GeneratedDriverBase.java | 34 +--
.../plc4x/java/spi/events/DiscoveredEvent.java | 9 +-
.../spi/internal/DefaultConversationContext.java | 4 +-
.../apache/plc4x/java/spi/transport/Transport.java | 3 +-
.../config/TestConfigurationComplex.java | 4 +-
.../config/TestConfigurationDefaults.java | 4 +-
.../TestConfigurationParameterConverter.java | 4 +-
.../config/TestConfigurationRequired.java | 4 +-
.../config/TestConfigurationSimple.java | 4 +-
.../connection/DefaultNettyPlcConnectionTest.java | 2 +-
.../plc4x/java/spi/connection/GateKeeper.java | 2 +-
.../java/spi/connection/PlcConnectionFactory.java | 2 +-
.../SingleProtocolStackConfigurerTest.java | 2 +-
.../java/spi/connection/TestChannelFactory.java | 2 +-
.../plc4x/java/spi/connection/TestMessage.java | 2 +-
.../plc4x/java/spi/connection/TestProtocol.java | 2 +-
.../java/spi/parser/ConnectionParserTest.java | 4 +-
.../java/tools/ui/Plc4xUiBackendApplication.java | 2 +-
.../tools/ui/Plc4xUiBackendApplicationTests.java | 2 +-
.../tools/ui/configuration/Plc4xConfiguration.java | 2 +-
.../tools/ui/configuration/WebSocketConfig.java | 2 +-
.../java/tools/ui/controller/DeviceController.java | 2 +-
.../java/tools/ui/controller/DriverController.java | 2 +-
.../plc4x/java/tools/ui/event/DeviceEvent.java | 2 +-
.../plc4x/java/tools/ui/event/EventType.java | 2 +-
.../java/tools/ui/event/UiApplicationEvent.java | 2 +-
.../java/tools/ui/handler/WebSocketHandler.java | 2 +-
.../java/tools/ui/model/ConfigurationOption.java | 2 +-
.../apache/plc4x/java/tools/ui/model/Device.java | 2 +-
.../apache/plc4x/java/tools/ui/model/Driver.java | 2 +-
.../plc4x/java/tools/ui/model/Transport.java | 2 +-
.../java/tools/ui/repository/DeviceRepository.java | 2 +-
.../plc4x/java/tools/ui/service/DeviceService.java | 2 +-
.../plc4x/java/tools/ui/service/DriverService.java | 6 +-
plc4j/tools/ui/frontend/project/.eslintrc.cjs | 2 +-
plc4j/tools/ui/frontend/project/src/App.css | 2 +-
plc4j/tools/ui/frontend/project/src/App.tsx | 2 +-
.../project/src/components/DeviceDialog.tsx | 2 +-
.../project/src/components/NavigationTree.tsx | 2 +-
.../project/src/components/PlcConnection.tsx | 2 +-
plc4j/tools/ui/frontend/project/src/index.css | 2 +-
.../ui/frontend/project/src/layouts/MainLayout.tsx | 2 +-
plc4j/tools/ui/frontend/project/src/main.tsx | 2 +-
.../ui/frontend/project/src/model/TreeItemData.ts | 2 +-
.../tools/ui/frontend/project/src/pages/About.tsx | 2 +-
.../ui/frontend/project/src/pages/Inspect.tsx | 2 +-
plc4j/tools/ui/frontend/project/src/pages/Mqtt.tsx | 2 +-
.../tools/ui/frontend/project/src/pages/OpcUa.tsx | 2 +-
.../ui/frontend/project/src/pages/Settings.tsx | 2 +-
plc4j/tools/ui/frontend/project/src/store/index.ts | 2 +-
.../tools/ui/frontend/project/src/utils/Counter.ts | 2 +-
plc4j/tools/ui/frontend/project/src/vite-env.d.ts | 2 +-
plc4j/tools/ui/frontend/project/vite.config.ts | 2 +-
.../transport/can/CANTransportConfiguration.java | 4 +-
.../DefaultPcapReplayTransportConfiguration.java | 10 +
.../transport/pcapreplay/PcapReplayTransport.java | 4 +-
plc4j/transports/pcap-shared/pom.xml | 5 +
.../pcap/DefaultPcapTransportConfiguration.java | 3 +
.../transport/pcap/PcapTransportConfiguration.java | 4 +-
.../DefaultRawSocketTransportConfiguration.java | 2 +
.../transport/rawsocket/RawSocketTransport.java | 4 +-
.../DefaultSerialTransportConfiguration.java | 32 +++
.../serial/SerialChannelOptionsParity.java | 2 +-
.../java/transport/serial/SerialTransport.java | 4 +-
.../serial/SerialTransportConfiguration.java | 4 +-
.../tcp/DefaultTcpTransportConfiguration.java | 4 +
.../plc4x/java/transport/tcp/TcpTransport.java | 4 +-
.../transport/tcp/TcpTransportConfiguration.java | 4 +-
.../plc4x/java/transport/test/TestTransport.java | 6 +
.../transport/test/TestTransportConfiguration.java | 4 +-
.../udp/DefaultUdpTransportConfiguration.java | 4 +
.../plc4x/java/transport/udp/UdpTransport.java | 4 +-
.../transport/udp/UdpTransportConfiguration.java | 4 +-
.../resources/protocols/ads/DriverTestsuite.xml | 8 +-
.../org/apache/plc4x/java/df1/DF1PlcDriver.java | 6 +-
.../java/df1/configuration/Df1Configuration.java | 4 +-
src/site/asciidoc/images/users/protocols/.png | Bin 2331 -> 0 bytes
src/site/asciidoc/index.adoc | 13 -
.../users/getting-started/general-concepts.adoc | 45 ++--
.../index.adoc} | 0
.../ab-eth.adoc => getting-started/plc4c.adoc} | 4 +-
.../ab-eth.adoc => getting-started/plc4cs.adoc} | 4 +-
.../asciidoc/users/getting-started/plc4go.adoc | 2 +-
src/site/asciidoc/users/getting-started/plc4j.adoc | 2 +-
.../ab-eth.adoc => getting-started/plc4py.adoc} | 4 +-
src/site/asciidoc/users/index.adoc | 121 +++++++--
src/site/asciidoc/users/protocols/ab-eth.adoc | 4 +
src/site/asciidoc/users/protocols/ads.adoc | 48 +---
.../users/protocols/{bacnetip.adoc => bacnet.adoc} | 75 +-----
.../users/protocols/{ab-eth.adoc => c-bus.adoc} | 6 +-
src/site/asciidoc/users/protocols/can.adoc | 1 +
src/site/asciidoc/users/protocols/canopen.adoc | 41 +--
.../users/protocols/{ab-eth.adoc => ctrlx.adoc} | 6 +-
.../users/protocols/{ethernet-ip.adoc => eip.adoc} | 44 +---
src/site/asciidoc/users/protocols/firmata.adoc | 29 +--
src/site/asciidoc/users/protocols/genericcan.adoc | 31 +--
.../protocols/{ab-eth.adoc => iec-60870.adoc} | 6 +-
src/site/asciidoc/users/protocols/index.adoc | 286 +++++++++++++++++++--
src/site/asciidoc/users/protocols/knxnetip.adoc | 78 +-----
src/site/asciidoc/users/protocols/logix.adoc | 53 +---
src/site/asciidoc/users/protocols/modbus.adoc | 45 +---
.../users/protocols/{opc-ua.adoc => opcua.adoc} | 72 +-----
.../protocols/{ab-eth.adoc => open-protocol.adoc} | 6 +-
src/site/asciidoc/users/protocols/plc4x.adoc | 32 +--
src/site/asciidoc/users/protocols/profinet.adoc | 53 +---
src/site/asciidoc/users/protocols/s7.adoc | 127 +--------
src/site/asciidoc/users/protocols/simulated.adoc | 24 +-
.../images/integrations/apache_edgent_logo.png | Bin 19377 -> 0 bytes
.../images/integrations/apache_hop_logo.png | Bin 4774 -> 75995 bytes
.../images/integrations/apache_iotdb_logo.png | Bin 22055 -> 54876 bytes
src/site/resources/images/languages/c_logo.png | Bin 0 -> 23215 bytes
src/site/resources/images/languages/cs_logo.png | Bin 0 -> 98426 bytes
src/site/resources/images/languages/go_logo.png | Bin 0 -> 30834 bytes
src/site/resources/images/languages/java_logo.png | Bin 0 -> 88149 bytes
.../resources/images/languages/python_logo.png | Bin 0 -> 98345 bytes
src/site/site.xml | 18 +-
224 files changed, 2230 insertions(+), 2012 deletions(-)
copy plc4j/api/src/main/java/org/apache/plc4x/java/api/configuration/{PlcConnectionConfiguration.java => PlcConfiguration.java} (89%)
rename plc4j/{spi/src/main/java/org/apache/plc4x/java/spi/transport/TransportConfiguration.java => api/src/main/java/org/apache/plc4x/java/api/configuration/PlcTransportConfiguration.java} (82%)
copy src/site/asciidoc/users/protocols/bacnetip.adoc => plc4j/drivers/all/src/site/generated/ab-eth.adoc (51%)
create mode 100644 plc4j/drivers/all/src/site/generated/ads.adoc
create mode 100644 plc4j/drivers/all/src/site/generated/bacnet-ip.adoc
copy src/site/asciidoc/users/protocols/bacnetip.adoc => plc4j/drivers/all/src/site/generated/c-bus.adoc (51%)
copy src/site/asciidoc/users/gettingstarted.adoc => plc4j/drivers/all/src/site/generated/canopen.adoc (51%)
create mode 100644 plc4j/drivers/all/src/site/generated/eip.adoc
copy src/site/asciidoc/users/gettingstarted.adoc => plc4j/drivers/all/src/site/generated/firmata.adoc (64%)
copy src/site/asciidoc/users/gettingstarted.adoc => plc4j/drivers/all/src/site/generated/genericcan.adoc (58%)
copy src/site/asciidoc/users/protocols/bacnetip.adoc => plc4j/drivers/all/src/site/generated/iec-60870-5-104.adoc (51%)
create mode 100644 plc4j/drivers/all/src/site/generated/knxnet-ip.adoc
create mode 100644 plc4j/drivers/all/src/site/generated/logix.adoc
copy src/site/asciidoc/users/protocols/bacnetip.adoc => plc4j/drivers/all/src/site/generated/modbus-ascii.adoc (51%)
copy src/site/asciidoc/users/protocols/bacnetip.adoc => plc4j/drivers/all/src/site/generated/modbus-rtu.adoc (51%)
copy src/site/asciidoc/users/protocols/bacnetip.adoc => plc4j/drivers/all/src/site/generated/modbus-tcp.adoc (51%)
create mode 100644 plc4j/drivers/all/src/site/generated/opcua.adoc
copy src/site/asciidoc/users/protocols/bacnetip.adoc => plc4j/drivers/all/src/site/generated/open-protocol.adoc (51%)
copy src/site/asciidoc/users/protocols/bacnetip.adoc => plc4j/drivers/all/src/site/generated/plc4x.adoc (51%)
copy src/site/asciidoc/users/protocols/bacnetip.adoc => plc4j/drivers/all/src/site/generated/profinet.adoc (51%)
create mode 100644 plc4j/drivers/all/src/site/generated/s7.adoc
copy src/site/asciidoc/users/gettingstarted.adoc => plc4j/drivers/all/src/site/generated/simulated.adoc (65%)
create mode 100644 plc4j/drivers/all/src/site/groovy/generate-config-documentation.groovy
copy plc4j/drivers/{open-protocol/src/main/java/org/apache/plc4x/java/openprotocol/config/OpenProtocolConfiguration.java => eip/src/main/java/org/apache/plc4x/java/eip/logix/configuration/LogixTcpTransportConfiguration.java} (71%)
copy plc4j/drivers/modbus/src/test/java/org/apache/plc4x/java/modbus/{ManualModbusRTUDriverTest.java => ManualModbusASCIIDriverTest.java} (88%)
delete mode 100644 plc4j/spi/src/main/java/org/apache/plc4x/java/spi/configuration/Configuration.java
rename plc4j/spi/src/main/java/org/apache/plc4x/java/spi/{transport/TransportConfigurationTypeProvider.java => configuration/annotations/Description.java} (70%)
delete mode 100644 src/site/asciidoc/images/users/protocols/.png
rename src/site/asciidoc/users/{gettingstarted.adoc => getting-started/index.adoc} (100%)
copy src/site/asciidoc/users/{protocols/ab-eth.adoc => getting-started/plc4c.adoc} (92%)
copy src/site/asciidoc/users/{protocols/ab-eth.adoc => getting-started/plc4cs.adoc} (92%)
copy src/site/asciidoc/users/{protocols/ab-eth.adoc => getting-started/plc4py.adoc} (92%)
rename src/site/asciidoc/users/protocols/{bacnetip.adoc => bacnet.adoc} (61%)
copy src/site/asciidoc/users/protocols/{ab-eth.adoc => c-bus.adoc} (88%)
copy src/site/asciidoc/users/protocols/{ab-eth.adoc => ctrlx.adoc} (88%)
rename src/site/asciidoc/users/protocols/{ethernet-ip.adoc => eip.adoc} (76%)
copy src/site/asciidoc/users/protocols/{ab-eth.adoc => iec-60870.adoc} (87%)
rename src/site/asciidoc/users/protocols/{opc-ua.adoc => opcua.adoc} (67%)
copy src/site/asciidoc/users/protocols/{ab-eth.adoc => open-protocol.adoc} (86%)
delete mode 100644 src/site/resources/images/integrations/apache_edgent_logo.png
create mode 100644 src/site/resources/images/languages/c_logo.png
create mode 100644 src/site/resources/images/languages/cs_logo.png
create mode 100644 src/site/resources/images/languages/go_logo.png
create mode 100644 src/site/resources/images/languages/java_logo.png
create mode 100644 src/site/resources/images/languages/python_logo.png