### Example connection string

Source: https://plc4x.apache.org/plc4x/latest/users/protocols/simulated.html

An example connection string using the device name 'foobar'.

```text
simulated:foobar
```

--------------------------------

### Install dotnet SDK via Homebrew

Source: https://plc4x.apache.org/plc4x/latest/developers/preparing/macos.html

Installs the .NET SDK for macOS using Homebrew. Alternatively, Microsoft provides an installer from their website.

```bash
brew install --cask dotnet-sdk8
```

--------------------------------

### Start Zookeeper

Source: https://plc4x.apache.org/plc4x/latest/users/integrations/apache-kafka.html

Command to start Zookeeper, a prerequisite for Kafka. Run from the Kafka installation directory.

```bash
bin/zookeeper-server-start.sh config/zookeeper.properties
```

--------------------------------

### Install Git via Homebrew

Source: https://plc4x.apache.org/plc4x/latest/developers/preparing/macos.html

Installs Git using Homebrew. Use this if the 'git --version' check indicates Git is not installed.

```bash
brew install git
```

--------------------------------

### Install Git on apt-based systems

Source: https://plc4x.apache.org/plc4x/latest/developers/preparing/linux.html

Use this command to install Git on Debian/Ubuntu-based systems.

```bash
sudo apt install git
```

--------------------------------

### Install .NET SDK on Ubuntu

Source: https://plc4x.apache.org/plc4x/latest/developers/preparing/linux.html

These commands set up the Microsoft package repository and install the .NET SDK 8.0 on Ubuntu.

```bash
sudo mkdir -p /etc/apt/keyrings
wget https://packages.microsoft.com/keys/microsoft.asc -O /etc/apt/keyrings/microsoft.asc
echo "deb [arch=amd64 signed-by=/etc/apt/keyrings/microsoft.asc] https://packages.microsoft.com/ubuntu/24.04/prod noble main" | sudo tee /etc/apt/sources.list.d/microsoft-dotnet.list
sudo apt update
sudo apt install dotnet-sdk-8.0
```

--------------------------------

### Install Java on apt-based systems

Source: https://plc4x.apache.org/plc4x/latest/developers/preparing/linux.html

Use this command to install OpenJDK 21 on Debian/Ubuntu-based systems.

```bash
sudo apt install openjdk-21-jdk
```

--------------------------------

### Java example using PlcConnectionCache for polling

Source: https://plc4x.apache.org/plc4x/latest/users/tools/connection-cache.html

Shows a main method that creates a PlcConnectionCache via its builder, then loops 10000 times to get a connection lease, read a boolean tag, and handle exceptions. The connection is returned to the cache when close() is called. Includes a 100ms sleep between iterations.

```java
    public static void main(String[] args) throws Exception {
        PlcConnectionCache connectionCache = PlcConnectionCache.getBuilder()
            .withConnectionFactory(PlcDriverManager.getDefault().getConnectionFactory())
            .build();
        for (int i = 0; i < 10000; i++) {
            try(PlcConnection connection = connectionCache.getConnection("s7://192.168.1.192")) {
                if (connection.isConnected()){
                    PlcReadRequest.Builder builder = connection.readRequestBuilder();
                    builder.addTagAddress("PollingValue", "%DB1:4.0:BOOL");
                    PlcReadRequest readRequest = builder.build();
                    PlcReadResponse syncResponse = readRequest.execute().get(2000, TimeUnit.MILLISECONDS);
                    printResponse(syncResponse);
                } else {
                    logger.info("PLC is not connected, let's try again to connect");
                    connection.connect();
                }
            } catch (PlcConnectionException e){
                logger.error("Connection exception in trying to connect", e);
            } catch (CancellationException e){
                logger.error("Polling Thread canceled", e);
            } catch (IllegalStateException e){
                logger.error("Connection was in an unexpected state", e);
            } catch (ExecutionException e){
                logger.error("Interrupted Exception fired", e);
            } catch (TimeoutException e) {
                logger.error("Timeout exception fired", e);
            }
            TimeUnit.MILLISECONDS.sleep(100);
        }
        System.exit(0);
    }
```

--------------------------------

### Install gcc on apt-based systems

Source: https://plc4x.apache.org/plc4x/latest/developers/preparing/linux.html

Use this command to install gcc on Debian/Ubuntu-based systems.

```bash
sudo apt install gcc
```

--------------------------------

### Grant Java raw network capabilities (example path)

Source: https://plc4x.apache.org/plc4x/latest/developers/preparing/linux.html

Example of the setcap command with a real Java path on Ubuntu 22.04.

```bash
sudo setcap cap_net_raw,cap_net_admin=eip /usr/lib/jvm/java-21-openjdk-arm64/bin/java
```

--------------------------------

### AB-ETH Connection String Example

Source: https://plc4x.apache.org/plc4x/latest/users/protocols/ab-eth.html

Example connection string using the default tcp transport and port.

```text
ab-eth://192.168.24.40
```

--------------------------------

### Install OpenJDK via Homebrew

Source: https://plc4x.apache.org/plc4x/latest/developers/preparing/macos.html

Installs OpenJDK using Homebrew. This is the recommended way to install Java on macOS.

```bash
brew install openjdk
```

--------------------------------

### Example go.mod file after initialization

Source: https://plc4x.apache.org/plc4x/latest/users/getting-started/plc4go.html

Shows the expected content of the go.mod file created by the previous command.

```go
module main

go 1.16

```

--------------------------------

### Run the PLC4X-IoTDB Java example with command-line arguments

Source: https://plc4x.apache.org/plc4x/latest/users/integrations/apache-iotdb.html

Command to run the example JAR, specifying the connection string, field address, polling interval, IoTDB connection details, storage group, device, data type, and JDBC usage flag. The example collects random integer data from a simulated PLC every second and writes it to IoTDB at 127.0.0.1:6667.

```bash
java -jar …​.. --connection-string simulated://127.0.0.1 --field-address RANDOM/foo:Integer --polling-interval 1000 --iotdb-address 127.0.0.1:6667 --iotdb-user-name root --iotdb-user-password root --iotdb-sg mi --iotdb-device d1 --iotdb-datatype INT32 --use-jdbc false
```

--------------------------------

### Install required packages for site generation

Source: https://plc4x.apache.org/plc4x/latest/developers/infrastructure/vm.html

Install python-seqdiag and python-nwdiag to build charts and graphics as part of the site generation.

```bash
sudo apt-get install python-seqdiag
sudo apt-get install python-nwdiag
```

--------------------------------

### Install Homebrew

Source: https://plc4x.apache.org/plc4x/latest/developers/preparing/macos.html

Installs Homebrew, the package manager used to install most libraries on macOS. Run this command in the terminal.

```bash
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
```

--------------------------------

### Start PLC4X server with explicit credentials and custom TLS keystore

Source: https://plc4x.apache.org/plc4x/latest/users/tools/plc4x-server.html

Use this command to start the PLC4X server with a specific port, username, password, and a custom TLS keystore. The keystore must be a PKCS12 (or JKS) file containing the server's private key and certificate.

```bash
java \
  -Dplc4x.server.port=59837 \
  -Dplc4x.server.username=operator \
  -Dplc4x.server.password='s3cr3t!' \
  -Dplc4x.server.keystore=/etc/plc4x/server.p12 \
  -Dplc4x.server.keystore-password='keystorepass' \
  -jar target/plc4j-plc4x-server-<version>.jar
```

--------------------------------

### Install Git on yum-based systems

Source: https://plc4x.apache.org/plc4x/latest/developers/preparing/linux.html

Use this command to install Git on Red Hat/CentOS-based systems.

```bash
sudo yum install git
```

--------------------------------

### Start Kafka Broker

Source: https://plc4x.apache.org/plc4x/latest/users/integrations/apache-kafka.html

Command to start the Kafka broker server. Run after Zookeeper is running.

```bash
bin/kafka-server-start.sh config/server.properties
```

--------------------------------

### Install PLC4Py from GitHub with pip install

Source: https://plc4x.apache.org/plc4x/latest/users/getting-started/plc4py.html

Run this command from the plc4py directory to install PLC4Py into your global Python repository. This is required because PLC4Py is not yet published to PyPI.

```bash
   pip install .
```

--------------------------------

### EtherNet/IP connection string example

Source: https://plc4x.apache.org/plc4x/latest/users/protocols/eip.html

Example connection string using the default port 44818, which is omitted.

```text
eip://192.168.24.32
```

--------------------------------

### Example OPC UA server configuration file (config.yml)

Source: https://plc4x.apache.org/plc4x/latest/users/tools/opcua-server.html

Example configuration file showing root settings, device definitions, and tag mappings. The version must match the expected version, and the dir points to the security directory. The disableInsecureEndpoint setting disables the insecure endpoint.

```yaml
---
version: "0.8"
dir: {path-to-security-dir}
name: "Plc4xOPCUAServer"
disableInsecureEndpoint: true
devices:
    - name: "ModbusDevice"
      connectionString: "modbus-tcp://127.0.0.1:502"
      tags:
        - alias: "TemporaryBOOLARRAY"
          address: "000001:BOOL[10]"
        - alias: "TemporaryWORD2"
          address: "400002:WORD"
        - alias: "TemporaryUINT3"
          address: "400003:UINT"
        - alias: "TemporaryINT4"
          address: "400004:INT"
        - alias: "TemporaryDINT5"
          address: "400005:DINT[4]"
        - alias: "TemporaryREAL6"
          address: "400006:REAL"
        - alias: "TemporaryREAL7"
          address: "400007:REAL"
        - alias: "TemporaryREAL8"
          address: "400008:REAL"
- name: "SimulationDevice"
    connectionString: "simulated://127.0.0.1"
    tags:
        - alias: "Temporary"
          address: "RANDOM/Temporary:Integer"
tcpPort: 12687
httpPort: 8445
```

--------------------------------

### OPC UA Connection String Example

Source: https://plc4x.apache.org/plc4x/latest/users/protocols/opcua.html

An example connection string using TCP transport, discovery enabled, and username/password authentication.

```text
opcua:tcp://127.0.0.1:12686?discovery=true&username=admin&password=password
```

--------------------------------

### Run PLC4X Browser in demo mode

Source: https://plc4x.apache.org/plc4x/latest/users/tools/plc4x-browser.html

Starts the browser against simulated devices so it can be tried without hardware. Run from the plc4go directory.

```bash
cd plc4go
go run ./tools/plc4xbrowser --demo
```

--------------------------------

### Example Logix Connection String

Source: https://plc4x.apache.org/plc4x/latest/users/protocols/logix.html

An example connection string using the Logix driver with a specific IP, port, and communication path option.

```text
logix:tcp://127.0.0.1:44818?communication-path=[1,1]
```

--------------------------------

### Start Kafka Console Consumer

Source: https://plc4x.apache.org/plc4x/latest/users/integrations/apache-kafka.html

Starts a console consumer that reads messages from the 'test' topic from the beginning.

```bash
bin/kafka-console-consumer.sh --bootstrap-server localhost:9092 --topic test --from-beginning
```

--------------------------------

### Example TLS Connection String

Source: https://plc4x.apache.org/plc4x/latest/users/protocols/plc4x.html

Example connection string using TLS (default) with the remote-connection-string set to 's7' and tls.verify=false.

```text
plc4x:tls://host:59837?remote-connection-string=s7&username=op&password=hunter2&tls.verify=false
```

--------------------------------

### Check dotnet version

Source: https://plc4x.apache.org/plc4x/latest/developers/preparing/windows.html

Run this command to check if dotnet is installed. Usually already installed on Windows.

```bash
dotnet --version
```

--------------------------------

### Initialize Go module with go mod init main

Source: https://plc4x.apache.org/plc4x/latest/users/getting-started/plc4go.html

Creates a go.mod file, similar to Maven's pom.xml. Run in a new directory after installing Go.

```bash
go mod init main

```

--------------------------------

### Install pyenv via Homebrew

Source: https://plc4x.apache.org/plc4x/latest/developers/preparing/macos.html

Installs pyenv, a Python version manager, using Homebrew. This is the first step to install Python for PLC4Py.

```bash
brew install pyenv
```

--------------------------------

### Example UMAS connection string

Source: https://plc4x.apache.org/plc4x/latest/users/protocols/umas.html

An example connection string using TCP transport to 127.0.0.1 on port 502.

```text
umas:tcp://127.0.0.1:502
```

--------------------------------

### Install python3 on apt-based systems

Source: https://plc4x.apache.org/plc4x/latest/developers/preparing/linux.html

Use this command to install Python 3 on Debian/Ubuntu-based systems.

```bash
sudo apt install python3
```

--------------------------------

### Install libpcap on apt-based systems

Source: https://plc4x.apache.org/plc4x/latest/developers/preparing/linux.html

Use this command to install libpcap development files on Debian/Ubuntu-based systems.

```bash
sudo apt install libpcap-dev
```

--------------------------------

### Run PCAP Analyzer UI with demo capture

Source: https://plc4x.apache.org/plc4x/latest/users/tools/pcap-analyzer.html

Starts the interactive terminal interface with a demo capture. Requires cgo and libpcap; building with CGO_ENABLED=0 fails.

```bash
cd plc4go
go run ./tools/plc4xpcapanalyzer ui --demo
```

--------------------------------

### Example connection strings for Generic CAN

Source: https://plc4x.apache.org/plc4x/latest/users/protocols/genericcan.html

Concrete examples of connection strings for the socketcan and virtualcan transports, using 'can0' and 'test' as the interface and bus name respectively.

```none
genericcan:can-socketcan://can0
genericcan:can-virtualcan://test
```

--------------------------------

### Install Git via Chocolatey

Source: https://plc4x.apache.org/plc4x/latest/developers/preparing/windows.html

Use this command to install Git if the version check fails.

```bash
choco install git
```

--------------------------------

### Check Git version

Source: https://plc4x.apache.org/plc4x/latest/developers/preparing/windows.html

Run this command to check if Git is installed. If it returns a successful output, Git is installed; otherwise, install it via Chocolatey.

```bash
git --version
```

--------------------------------

### COTP connection examples

Source: https://plc4x.apache.org/plc4x/latest/users/transports/cotp.html

Example connection strings for S7 and COTP with TPDU size configuration. The first uses the default port, the second specifies port 102 and a TPDU size of 1024.

```none
s7://10.0.0.1
s7:cotp://10.0.0.1:102?cotp.tpdu-size=1024
```

--------------------------------

### Run the PLC4X server

Source: https://plc4x.apache.org/plc4x/latest/users/tools/plc4x-server.html

Starts the server. The listen port may be given as the first argument, or via the plc4x.server.port system property / PLC4X_SERVER_PORT environment variable. If omitted it defaults to 59837.

```bash
java -jar target/plc4j-plc4x-server-<version>.jar [port]
```

--------------------------------

### Example Plaintext TCP Connection String

Source: https://plc4x.apache.org/plc4x/latest/users/protocols/plc4x.html

Example connection string using plaintext TCP (no transport specified, defaults to tls? Actually the example uses plc4x:// which defaults to tls, but the text says plaintext TCP. The example shows a URL-encoded remote-connection-string.

```text
plc4x://host?remote-connection-string=s7%3A%2F%2Foperator%3Ahunter2%40plc%3A102
```

--------------------------------

### Start Kafka Connect Source Worker (Standalone)

Source: https://plc4x.apache.org/plc4x/latest/users/integrations/apache-kafka.html

Starts a standalone Kafka Connect worker with the PLC4X source connector configuration. Ideal for testing. The command uses the provided properties files.

```bash
bin/connect-standalone.sh config/connect-standalone.properties config/plc4x-source.properties
```

--------------------------------

### PCAP Replay connection string example

Source: https://plc4x.apache.org/plc4x/latest/users/transports/pcap-replay.html

Example connection string for the PCAP Replay transport. The address segment is not interpreted; the capture is named by the `pcap-replay.pcap-file` parameter. The example sets the file path and speed factor.

```none
profinet:pcap-replay://?pcap-replay.pcap-file=/tmp/line-3.pcapng&pcap-replay.speed-factor=1.0
```

--------------------------------

### Run the OPC UA server with interactive mode

Source: https://plc4x.apache.org/plc4x/latest/users/tools/opcua-server.html

Starts the server with the -i switch, prompting for usernames and passwords. For normal operation, omit -i.

```bash
java -jar plc4x-opcua-server-1.0.0-uber-jar.jar -c {path-to-config-file} -i
```

--------------------------------

### Install gcc on yum-based systems

Source: https://plc4x.apache.org/plc4x/latest/developers/preparing/linux.html

Use this command to install gcc on Red Hat/CentOS-based systems.

```bash
sudo yum install gcc
```

--------------------------------

### SocketCAN connection string examples

Source: https://plc4x.apache.org/plc4x/latest/users/transports/socketcan.html

Example connection strings for SocketCAN, using the interface name in the address segment and an optional read-timeout parameter.

```none
canopen:can-socketcan://can0
canopen:can-socketcan://vcan0?can-socketcan.read-timeout-ms=500
```

--------------------------------

### Raw Socket connection string example

Source: https://plc4x.apache.org/plc4x/latest/users/transports/raw-socket.html

Example connection string for the raw-socket transport. The address segment is not interpreted; all configuration is passed via query parameters. Requires raw-socket.remote-address and raw-socket.protocol-id.

```none
profinet://?raw-socket.interface-name=en0&raw-socket.remote-address=00:0e:cf:12:34:56&raw-socket.protocol-id=34962
```

--------------------------------

### C-Bus connection string example

Source: https://plc4x.apache.org/plc4x/latest/users/protocols/c-bus.html

Example connection string connecting to a PCI at IP 192.168.42.11 on the default port 10001.

```text
c-bus:tcp://192.168.42.11
```

--------------------------------

### Install MinGW via Chocolatey

Source: https://plc4x.apache.org/plc4x/latest/developers/preparing/windows.html

Use this command from an Administrative console to install MinGW if gcc is not found.

```bash
choco install mingw
```

--------------------------------

### Install python3-venv on apt-based systems

Source: https://plc4x.apache.org/plc4x/latest/developers/preparing/linux.html

Use this command to install the Python venv package on Debian/Ubuntu-based systems.

```bash
sudo apt install python3-venv
```

--------------------------------

### BACnet/IP connection string example

Source: https://plc4x.apache.org/plc4x/latest/users/protocols/bacnet.html

Example connection string using the udp transport with a specific IP address and port.

```text
bacnet-ip:udp://192.168.178.101:47808
```

--------------------------------

### Start PLC4X server in plaintext mode (trusted network / local testing only)

Source: https://plc4x.apache.org/plc4x/latest/users/tools/plc4x-server.html

Use this command to start the PLC4X server with plaintext mode enabled, which disables TLS. This is intended for trusted networks or local testing only.

```bash
java -Dplc4x.server.plaintext=true \
     -Dplc4x.server.username=operator \
     -Dplc4x.server.password='s3cr3t!' \
     -jar target/plc4j-plc4x-server-<version>.jar
```

--------------------------------

### SLMP Example Connection String

Source: https://plc4x.apache.org/plc4x/latest/users/protocols/slmp.html

An example connection string using TCP transport to connect to a PLC at IP 192.168.0.10 on port 5007.

```text
slmp:tcp://192.168.0.10:5007
```

--------------------------------

### Example connection strings for Virtual CAN

Source: https://plc4x.apache.org/plc4x/latest/users/transports/can-virtualcan.html

Example connection strings using the Virtual CAN transport. Both ends must use the same bus name to communicate.

```none
canopen:can-virtualcan://test-bus
genericcan:can-virtualcan://test-bus
```

--------------------------------

### Install libpcap on yum-based systems

Source: https://plc4x.apache.org/plc4x/latest/developers/preparing/linux.html

Use this command to install libpcap development files on Red Hat/CentOS-based systems.

```bash
sudo yum install libpcap-devel
```

--------------------------------

### Add PLC4Go dependency with go get

Source: https://plc4x.apache.org/plc4x/latest/users/getting-started/plc4go.html

Downloads the latest PLC4Go module. All supported drivers are included in this bundle.

```bash
go get github.com/apache/plc4x/plc4go

```

--------------------------------

### GUID address examples

Source: https://plc4x.apache.org/plc4x/latest/users/protocols/opcua.html

Examples of OPC UA addresses using GUID identifiers. The first address omits the optional data type and attribute ID, the second adds a data type, and the third adds both an explicit attribute ID and data type.

```text
ns=2;g=09087e75-8e5e-499b-954f-f2a8624db28a
ns=2;g=09087e75-8e5e-499b-954f-f2a8624db28a;REAL
ns=2;g=09087e75-8e5e-499b-954f-f2a8624db28a;a=Value;REAL
```

--------------------------------

### Start Kafka Connect Source Worker (Distributed Mode)

Source: https://plc4x.apache.org/plc4x/latest/users/integrations/apache-kafka.html

Starts a distributed Kafka Connect worker using the provided configuration file. This is ideal for production.

```bash
bin /connect-distributed.sh config/connect-distributed.properties
```

--------------------------------

### Build the PLC4X website with Maven

Source: https://plc4x.apache.org/plc4x/latest/developers/building.html

Run this command in the PLC4X repository root to generate the website. This is a quick-start version; see the full website documentation for details.

```bash
mvn site
```

--------------------------------

### Get default PlcDriverManager

Source: https://plc4x.apache.org/plc4x/latest/users/driver-metadata.html

Obtains the default PlcDriverManager instance using the static getDefault() method. This is the starting point for discovering drivers and their configuration metadata.

```java
import org.apache.plc4x.java.api.PlcDriverManager;

PlcDriverManager driverManager = PlcDriverManager.getDefault();
```

--------------------------------

### Serial connection string examples

Source: https://plc4x.apache.org/plc4x/latest/users/tools/plc4x-browser.html

Shows connection strings for serial protocols where the port is named in the path instead of a host.

```text
modbus-rtu:///dev/ttyUSB0
firmata:///dev/ttyACM0
```

--------------------------------

### Force update of all tags with updateAllTheTags()

Source: https://plc4x.apache.org/plc4x/latest/users/tools/opm.html

Define a method that does not start with 'get' or 'is' to force the OPM system to update all properties in the current entity when called. Respects the cache time, so only outdated values are refreshed.

```java
public void updateAllTheTags() {
// Dummy ...
}
```

--------------------------------

### Start Kafka Connect Sink Worker (Standalone)

Source: https://plc4x.apache.org/plc4x/latest/users/integrations/apache-kafka.html

Command to start a standalone Kafka Connect worker with the sink connector properties. Ideal for testing.

```bash
bin/connect-standalone.sh config/connect-standalone.properties config/plc4x-sink.properties
```

--------------------------------

### Minimal PLC4Py asynchronous read example

Source: https://plc4x.apache.org/plc4x/latest/users/getting-started/plc4py.html

Connects to a Modbus PLC using a connection string, builds a read request for a tag named 'Random Tag' with address '4x00001[10]', executes it asynchronously, and prints the response code. Requires the plc4py package installed and an accessible PLC at the given address.

```python
import asyncio
from plc4py.PlcDriverManager import PlcDriverManager

connection_string = "modbus://127.0.0.1:5020"
driver_manager = PlcDriverManager()

async def communicate_with_plc():
    """
    Asynchronously communicates with a PLC using a PlcDriverManager.

    This function establishes a connection to the PLC defined by the connection_string.
    It builds a read request for a specific item ("Random Tag" in this case) using the connection's read request builder.
    The request is then executed asynchronously, and the response code is printed.
    """
    print(f"Connecting to plc: {connection_string}")
    async with driver_manager.connection(connection_string) as connection:
        print(f"Connected to {connection_string}")
        with connection.read_request_builder() as builder:
            print(f"Building read request")
            builder.add_item("Random Tag", "4x00001[10]")
            request = builder.build()
            print(f"Request built")
        print(f"Executing request")
        response = await connection.execute(request)
        print(f"Request executed")
        print(f"Response code: {response.response_code}")

asyncio.run(communicate_with_plc())
```

--------------------------------

### Build the server with Maven

Source: https://plc4x.apache.org/plc4x/latest/users/tools/plc4x-server.html

Run from the module directory to produce a runnable fat-jar at target/plc4j-plc4x-server-<version>.jar.

```bash
mvn package
```

--------------------------------

### Check python3 version

Source: https://plc4x.apache.org/plc4x/latest/developers/preparing/linux.html

Run this command to verify Python 3 is installed. A version of 3.7 or higher is sufficient.

```bash
python3 --version
```

--------------------------------

### Event subscription address example

Source: https://plc4x.apache.org/plc4x/latest/users/protocols/opcua.html

Example of an OPC UA address for event subscription. The attribute ID is required for event subscriptions, and tag config is appended after a pipe as a comma-separated key=value list naming the event fields to request. The values are placeholders and are ignored, but they must be non-empty and alphanumeric, and a ;{Data Type} segment must precede the pipe, otherwise the config is silently dropped.

```text
ns=0;i=2253;a=EventNotifier;BOOL|EventId=x,EventType=x,Severity=x,Time=x,Message=x
```

--------------------------------

### S7 Connection String Example

Source: https://plc4x.apache.org/plc4x/latest/users/protocols/s7.html

Example connection string for a Siemens S7-400 PLC at IP 10.10.1.33 with rack 0, slot 3, and controller type S7_400.

```text
s7://10.10.1.33?cotp.remote-rack=0&cotp.remote-slot=3&controller-type=S7_400
```

--------------------------------

### TLS-PSK connection URL example

Source: https://plc4x.apache.org/plc4x/latest/users/transports/tls-psk.html

Example connection URL for a Modbus TCP device using TLS-PSK with identity 'line-3' and a hex-encoded key.

```none
modbus-tcp:tls-psk://192.168.1.100:802?tls-psk.psk-identity=line-3&tls-psk.psk-key=00112233445566778899aabbccddeeff
```

--------------------------------

### Build and start an Event-Pump TagBatch in Java

Source: https://plc4x.apache.org/plc4x/latest/users/tools/event-pump.html

Creates a TagBatch with a connection factory, OPC UA connection string, two tag addresses, a TimerTrigger firing every 5 seconds, and a listener that prints values. The batch is added to an EventPump and started. EventPump implements AutoCloseable, so closing it stops all batches.

```java
PlcConnectionFactory connectionFactory = PlcDriverManager.getDefault().getConnectionFactory();

TagBatch batch = TagBatch.builder()
    .withBatchId("boiler")
    .withConnectionFactory(connectionFactory)
    .withConnectionString("opcua:tcp://192.168.1.1:4840?request-timeout-ms=10000")
    .addTagAddress("temperature", "ns=2;i=1001")
    .addTagAddress("pressure", "ns=2;i=1002")
    .withTrigger(new TimerTrigger(5, TimeUnit.SECONDS))
    .withListener((b, response) -> {
        System.out.println("Temperature: " + response.getInt("temperature"));
        System.out.println("Pressure: " + response.getInt("pressure"));
    })
    .build();

EventPump pump = new EventPump();
pump.addBatch(batch);
pump.startAll();

// ... later
pump.close();
```

--------------------------------

### Connection String

Source: https://plc4x.apache.org/plc4x/latest/users/protocols/ads.html

The ADS connection string format and an example with required options.

```APIDOC
## Connection String

### Format
`ads:tcp://{ip-address}[:{port}]?{options}`

### Description
The ADS connection string uses the `tcp` transport. The port defaults to the ADS TCP port and normally does not need to be given. Required options are `target-ams-net-id`, `target-ams-port`, `source-ams-net-id`, and `source-ams-port`.

### Example
`ads:tcp://192.168.23.20:48898?target-ams-port=851&source-ams-port=65534&source-ams-net-id=192.168.23.220.1.1&target-ams-net-id=192.168.23.20.1.1`

### Parameters
#### Query Parameters
- **target-ams-net-id** (string) - Required - The AMS Net ID of the target device.
- **target-ams-port** (integer) - Required - The AMS port of the target device.
- **source-ams-net-id** (string) - Required - The AMS Net ID of the source device.
- **source-ams-port** (integer) - Required - The AMS port of the source device.

```

--------------------------------

### List options and required options from OptionMetadata

Source: https://plc4x.apache.org/plc4x/latest/users/driver-metadata.html

Shows how to get the list of all options and the convenience filter for required options from an OptionMetadata instance.

```java
import org.apache.plc4x.java.api.metadata.Option;

List<Option> all = protocolOptions.get().getOptions();
List<Option> mandatory = protocolOptions.get().getRequiredOptions();   // convenience filter
```

--------------------------------

### Sample output of IoTDB query for root.mi.d1

Source: https://plc4x.apache.org/plc4x/latest/users/integrations/apache-iotdb.html

Example result of the query 'select * from root.mi.d1;' showing five rows of timestamp and float values for the measurement 'root.mi.d1.RANDOM_foo_Integer'.

```text
+-----------------------------+-----------------------------+
|                         Time|root.mi.d1.RANDOM_foo_Integer|
+-----------------------------+-----------------------------+
|2020-07-16T20:01:39.216+08:00|                -1.34242598E9|
|2020-07-16T20:01:40.150+08:00|                 -9.4141104E7|
|2020-07-16T20:01:41.154+08:00|                 1.40969664E9|
|2020-07-16T20:01:42.155+08:00|                  9.5824531E8|
|2020-07-16T20:01:43.157+08:00|                  -4.207406E7|
+-----------------------------+-----------------------------+
```

--------------------------------

### Plugin prompt for working copy version

Source: https://plc4x.apache.org/plc4x/latest/developers/release/build-tools.html

Example of the maven-release-plugin prompt asking for the new working copy version. The suggested default is the bugfix version, but it should be overridden to the next development version.

```text
   What is the new working copy version for "PLC4X Build Tools: Code Generation"? (org.apache.plc4x.plugins:plc4x-code-generation) {code-generation-bugfix-version}-SNAPSHOT: : {code-generation-development-version}-SNAPSHOT
```

--------------------------------

### Create app.go main program

Source: https://plc4x.apache.org/plc4x/latest/users/getting-started/plc4go.html

Creates the main program file with an empty main function.

```go
package main

func main() {

}

```

--------------------------------

### Run the release preparation script

Source: https://plc4x.apache.org/plc4x/latest/developers/release/release.html

Run this script in regular intervals during development and definitely before starting a release. It deletes the out directory, regenerates all generated code, updates the NOTICE file, regenerates driver documentation, and commits the changes.

```bash
./tools/release-0-update-generated-code.sh
```

--------------------------------

### Install Python 3.9.13 with pyenv

Source: https://plc4x.apache.org/plc4x/latest/developers/preparing/macos.html

Uses pyenv to install Python version 3.9.13.

```bash
pyenv install 3.9.13
```

--------------------------------

### Check Java version

Source: https://plc4x.apache.org/plc4x/latest/developers/preparing/windows.html

Run this command to check if Java is installed. The version should be at least Java 11.

```bash
java --version
```

--------------------------------

### AB-ETH Tag Address Examples

Source: https://plc4x.apache.org/plc4x/latest/users/protocols/ab-eth.html

Examples of valid AB-ETH tag addresses with their meanings.

```text
N7:0:WORD
```

```text
N7:5:DWORD
```

```text
N7:3:INTEGER[8]
```

```text
N7:0/3:WORD
```

--------------------------------

### Generated default credentials output

Source: https://plc4x.apache.org/plc4x/latest/users/tools/plc4x-server.html

Printed once to the console when the server starts without configured credentials. Shows the generated username and password, and reminds that plc4x.server.username/password can be set.

```text
============================================================
 No PLC4X server credentials configured - generated defaults:
   username: toddy
   password: 3Qm0v2yq... (randomly generated)
 Provide plc4x.server.username/password to set your own.
============================================================
```

--------------------------------

### info/ (browse query)

Source: https://plc4x.apache.org/plc4x/latest/users/protocols/c-bus.html

Browse query to list installed units, optionally filtered to one unit and/or one identify attribute. Used only with the browse operation.

```APIDOC
## info/ (browse query)

### Description
Browse query to list installed units, optionally filtered to one unit and/or one identify attribute. Used only with the `browse` operation.

### Address Format
`info/<unit>|**/<identifyAttribute>|**`

### Parameters
#### Path Parameters
- **unit** (string) - Required - Unit address or `*` for any.
- **identifyAttribute** (string) - Required - Identify attribute name or `*` for any.

### Examples
- `info/0x13/DSIStatus` - browse query for unit `0x13`'s `DSIStatus` attribute
- `info/**/**` - browse query for every installed unit and every attribute

### Notes
- This is not a tag address; it is parsed separately by `ParseQuery` rather than `ParseTag`.
```

--------------------------------

### Load YAML configuration with EventPumpFactory

Source: https://plc4x.apache.org/plc4x/latest/users/tools/event-pump.html

Loads a YAML event pump file using EventPumpFactory.fromYaml and starts all batches. The listener becomes the default for all batches in the file.

```java
EventPump pump = EventPumpFactory.fromYaml(
    new File("event-pump.yml"), connectionManager, listener);
pump.startAll();
```

--------------------------------

### Build and deploy with mvn clean deploy -P apache-release

Source: https://plc4x.apache.org/plc4x/latest/developers/release/build-tools.html

This command is automatically executed by the `perform` goal. It builds and tests the project, creates JavaDocs and source packages, and signs them with your PGP key. It deploys artifacts to a staging repository.

```bash
mvn clean deploy -P apache-release
```

--------------------------------

### PlcCertificateAuthentication with named key store entry

Source: https://plc4x.apache.org/plc4x/latest/users/protocols/opcua.html

Java example showing how to specify which key store entry to use when the store holds more than one identity. The alias is passed as the third argument.

```java
new PlcCertificateAuthentication(keyStore, "changeit".toCharArray(), "operator");
```

--------------------------------

### Install python3 on yum-based systems

Source: https://plc4x.apache.org/plc4x/latest/developers/preparing/linux.html

Use this command to install Python 3 on Red Hat/CentOS-based systems.

```bash
yum intall python3
```

--------------------------------

### Prepare the release with Maven

Source: https://plc4x.apache.org/plc4x/latest/developers/release/extras.html

Prepares the release using Maven's release:prepare goal. Must be run on the release branch after updating RELEASE_NOTES.

```bash
   ./mvnw -P with-c,with-go,with-java release:prepare
```

--------------------------------

### Example connection string with transport option namespacing

Source: https://plc4x.apache.org/plc4x/latest/users/driver-metadata.html

Shows a connection string for the S7 driver where transport options are prefixed with 'cotp.' and protocol options are not. The annotations indicate which parts are transport options and which is a protocol option.

```none
s7://10.0.0.1?pdu-size=2048&cotp.local-rack=1&cotp.remote-slot=2
     ^                      ^                 ^
     |                      |                 └── transport option, prefixed with "cotp."
     |                      └── transport option
     └── protocol option, no prefix
```

--------------------------------

### Get single value from response

Source: https://plc4x.apache.org/plc4x/latest/users/getting-started/plc4j.html

Convenience method to get the first element of a tag's value.

```java
response.getObject(fieldName)
```

--------------------------------

### Create Kafka Topic 'test'

Source: https://plc4x.apache.org/plc4x/latest/users/integrations/apache-kafka.html

Creates a Kafka topic named 'test' with one partition and replication factor of 1.

```bash
bin/kafka-topics.sh --create --bootstrap-server localhost:9092 --replication-factor 1 --partitions 1 --topic test
```

--------------------------------

### Check gcc version

Source: https://plc4x.apache.org/plc4x/latest/developers/preparing/windows.html

Run this command to check if gcc is installed. If it fails, install MinGW via Chocolatey.

```bash
gcc --version
```

--------------------------------

### TCP Transport URI Examples

Source: https://plc4x.apache.org/plc4x/latest/users/transports/tcp.html

Example URIs for the TCP transport, showing both a default port and an explicit port.

```none
modbus-tcp://192.168.1.100
modbus-tcp:tcp://plc-hall-2.example.com:502
```

--------------------------------

### Create subscription request (up to 0.10.0)

Source: https://plc4x.apache.org/plc4x/latest/users/getting-started/plc4go.html

Builds a subscription request using AddChangeOfStateItem and AddCyclicItem for KNX addresses. Requires a duration parameter for cyclic items. Uses AddItemHandler to set the event handler.

```go
// Prepare a subscription-request
subscriptionRequest, err := connection.SubscriptionRequestBuilder().
    AddChangeOfStateItem("heating-actual-temperature", "*/*/10:DPT_Value_Temp").
    AddChangeOfStateItem("heating-target-temperature", "*/*/11:DPT_Value_Temp").
    AddCyclicItem("heating-valve-open", "*/*/12:DPT_OpenClose", 500 * time.Millisecond).
    AddItemHandler(knxEventHandler).
    Build()
if err != nil {
    fmt.Printf("Error preparing subscription-request: %s", connectionResult.Err.Error())
    return
}
```

--------------------------------

### Create subscription request (SNAPSHOT version)

Source: https://plc4x.apache.org/plc4x/latest/users/getting-started/plc4go.html

Builds a subscription request using AddChangeOfStateTagAddress and AddCyclicTagAddress for KNX addresses. Requires a duration parameter for cyclic items. Uses AddItemHandler to set the event handler.

```go
// Prepare a subscription-request
subscriptionRequest, err := connection.SubscriptionRequestBuilder().
    AddChangeOfStateTagAddress("heating-actual-temperature", "*/*/10:DPT_Value_Temp").
    AddChangeOfStateTagAddress("heating-target-temperature", "*/*/11:DPT_Value_Temp").
    AddCyclicTagAddress("heating-valve-open", "*/*/12:DPT_OpenClose", 500 * time.Millisecond).
    AddItemHandler(knxEventHandler).
    Build()
if err != nil {
    fmt.Printf("Error preparing subscription-request: %s", connectionResult.Err.Error())
    return
}
```

--------------------------------

### 1.0.0: Connecting with context-based API

Source: https://plc4x.apache.org/plc4x/latest/users/migrations/0.13.1-to-1.0.0/plc4go.html

New way to connect using GetConnection with a context and error return. Close() is now idiomatic and understood by go vet.

```go
// 1.0.0
driverManager := plc4go.NewPlcDriverManager()
drivers.RegisterModbusTcpDriver(driverManager)

ctx, cancel := context.WithTimeout(context.Background(), 10*time.Second)
defer cancel()

connection, err := driverManager.GetConnection(ctx, "modbus-tcp://192.168.23.30")
if err != nil {
    fmt.Printf("error connecting: %s", err.Error())
    return
}
defer connection.Close()
```

--------------------------------

### Build all language modules with Maven

Source: https://plc4x.apache.org/plc4x/latest/developers/building.html

Builds all language-related modules (C, .NET, Go, Java, Python) and runs all unit and integration tests.

```bash
mvn -P with-c,with-dotnet,with-go,with-java,with-python install
```

--------------------------------

### Run Go program with go run app.go

Source: https://plc4x.apache.org/plc4x/latest/users/getting-started/plc4go.html

Executes the main program. The output is minimal for an empty main function.

```bash
go run app.go

```

--------------------------------

### UDP Transport Example URIs

Source: https://plc4x.apache.org/plc4x/latest/users/transports/udp.html

Example URIs for UDP-based protocols: knxnet-ip without a port (using default) and modbus-tcp with explicit port 502.

```none
knxnet-ip://192.168.1.10
modbus-tcp:udp://192.168.1.100:502
```

--------------------------------

### Java output template example

Source: https://plc4x.apache.org/plc4x/latest/developers/code-gen/language/freemarker.html

This Freemarker template generates a Java file path and class definition. The first line constructs the output file path using the helper's packageName method, replacing dots with slashes. The template includes the Apache license header, package declaration, imports placeholder, and a class definition that may be abstract if the type is a discriminated parent type, and may extend a parent type. It implements the Message interface.

```freemarker
${helper.packageName(protocolName, languageName, outputFlavor)?replace(".", "/")}/${type.name}.java
/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   https://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */
package ${helper.packageName(protocolName, languageName, outputFlavor)};

... imports ...

// Code generated by code-generation. DO NOT EDIT.

public<#if type.isDiscriminatedParentTypeDefinition()> abstract</#if> class ${type.name}<#if type.parentType??> extends ${type.parentType.name}</#if> implements Message {

    ... SNIP ...

}
```

--------------------------------

### IEC 60870-5-104 connection string example

Source: https://plc4x.apache.org/plc4x/latest/users/protocols/iec-60870.html

Example connection string using the default port 2404. The transport is tcp and the IP address is 192.168.178.101.

```text
iec-60870-5-104:tcp://192.168.178.101:2404
```

--------------------------------

### Simple MockDevice implementation

Source: https://plc4x.apache.org/plc4x/latest/users/tools/testing.html

A basic implementation of MockDevice that logs read and write requests to the console and returns a fixed string value 'hello' for every read request.

```java
MockDevice mockDevice = new MockDevice() {

    Pair<PlcResponseCode, PlcValue> read(String fieldQuery) {
        System.out.println("I got a read to " + fieldQuery);
        return Pair.of(PlcResponseCode.OK, new PlcString("hello"));
    }

    PlcResponseCode write(String fieldQuery, Object value) {
        System.out.println("I got a write to " + fieldQuery + " with the value " + value);
        return PlcResponseCode.OK;
    }

    // ...

}
```

--------------------------------

### Execute request with context (0.13.1 vs 1.0.0)

Source: https://plc4x.apache.org/plc4x/latest/users/migrations/0.13.1-to-1.0.0/plc4go.html

Shows the change from Execute() to Execute(ctx) for read requests. The 0.13.1 version uses Execute() without context, while 1.0.0 requires a context. Use context.Background() if no meaningful context exists, but a deadline is recommended.

```go
// 0.13.1
readResult := <-readRequest.Execute()
```

```go
// 1.0.0
readResult := <-readRequest.Execute(ctx)
```

--------------------------------

### OPIE challenge example

Source: https://plc4x.apache.org/plc4x/latest/developers/infrastructure/vm.html

Example challenge to input into an OPIE client's challenge field. The password field should contain your Apache LDAP password.

```text
otp-md5 496 pl8230
```

--------------------------------

### Build standalone PLC4X Browser binary

Source: https://plc4x.apache.org/plc4x/latest/users/tools/plc4x-browser.html

Builds a standalone binary named plc4xbrowser. The browser does not require cgo.

```bash
go build -o plc4xbrowser ./tools/plc4xbrowser
```

--------------------------------

### MSpec constants definition example

Source: https://plc4x.apache.org/plc4x/latest/developers/code-gen/protocol/mspec.html

Shows how to define protocol constants using the 'constants' block. The example defines a constant for the ADS discovery UDP default port.

```mspec
[constants
    [const          uint 16     adsDiscoveryUdpDefaultPort 48899]
]
```

--------------------------------

### TLS connection example for Modbus TCP

Source: https://plc4x.apache.org/plc4x/latest/users/transports/tls.html

Example connection string for the TLS transport using the Modbus TCP driver. It specifies a trust store and password via query parameters.

```none
modbus-tcp:tls://192.168.1.100:802?tls.trust-store=/etc/plc4x/truststore.p12&tls.trust-store-password=secret
```

--------------------------------

### Run Capture Replay tool with java -jar

Source: https://plc4x.apache.org/plc4x/latest/users/tools/capture-replay.html

Command to replay a pcapng capture file through a network device. The --input-file and --output-device options are mandatory; --replay-speed and --loop are optional. replay-speed 1 is real time, 0 or less is as fast as possible, 0.5 is 50% slower, 2 is twice as fast. loop true restarts the capture automatically when the end is reached.

```bash
   java -jar target/plc4j-capture-replay-1.0.0-uber-jar.jar --input-file {path to capture} --output-device {name of the network device} --replay-speed 1 --loop true
```

--------------------------------

### Maven Release Prepare Command

Source: https://plc4x.apache.org/plc4x/latest/developers/release/build-tools.html

Command to run all preparation steps for a release. It will prompt for release version, tag name, and next development version.

```bash
mvn release:prepare
```

--------------------------------

### Example ADS Connection String

Source: https://plc4x.apache.org/plc4x/latest/users/protocols/ads.html

A concrete example of an ADS connection string with all required options specified. The port is explicitly set to 48898, and the AMS net IDs and ports are provided.

```text
ads:tcp://192.168.23.20:48898?target-ams-port=851&source-ams-port=65534&source-ams-net-id=192.168.23.220.1.1&target-ams-net-id=192.168.23.20.1.1
```

--------------------------------

### MSpec type definition example: TPKTPacket

Source: https://plc4x.apache.org/plc4x/latest/developers/code-gen/protocol/mspec.html

Shows the structure of a 'type' element, which is independent of input. The example defines the TPKTPacket type with fields like const, reserved, implicit, and simple.

```mspec
[type TPKTPacket
    [const    uint 8                 protocolId 0x03]
    [reserved uint 8                 '0x00']
    [implicit uint 16                len       'payload.lengthInBytes + 4']
    [simple   COTPPacket('len - 4') payload]
]
```

--------------------------------

### Firmata address examples

Source: https://plc4x.apache.org/plc4x/latest/users/protocols/firmata.html

A list of example Firmata addresses covering digital and analog forms, including a digital address with a selection range and PULLUP configuration, and an analog address with a selection range.

```text
digital:2
digital:5
digital:8[0..3]:PULLUP
digital:0[0..255]
analog:0
analog:3
analog:0[0..2]
```

--------------------------------

### SLMP Tag Address Examples

Source: https://plc4x.apache.org/plc4x/latest/users/protocols/slmp.html

Examples of SLMP tag addresses for various devices and data types, including word devices D, R, and W with optional array selection and data type specification.

```text
D350
```

```text
D350:DINT
```

```text
R200[0..3]:REAL
```

```text
W1A[0..9]:WORD
```

```text
W0x1A
```

--------------------------------

### Clone your forked PLC4X repository

Source: https://plc4x.apache.org/plc4x/latest/developers/contributing.html

Use this command to clone your forked PLC4X repository to your local machine. Replace {your-user-id} with your GitHub username. This is the first step in the pull-request workflow.

```bash
git clone https://github.com/{your-user-id}/plc4x.git
```