Strategy for creating a new Driver

Create a new protocol module for your protocol.

Create the pom.xml file for the new module.

Create a new mspec file in src/main/release/ with just one or two dummy types.

Create a new Protocol class in src/main/java which implements org.apache.plc4x.plugins.codegenerator.protocol.Protocol.

Create a new file called src/main/resources/META-INF/services/org.apache.plc4x.plugins.codegenerator.protocol.Protocol and list the new protocol class.

Test you can build the new protocol module.

Create a new driver module under plc4j/drivers

Create the pom.xml file for the new module.

Create the Driver class in src/main/java which implements org.apache.plc4x.java.api.PlcDriver.

Create a file called src/main/resources/META-INF/services/org.apache.plc4x.java.api.PlcDriver and list the new driver class.

Test you can build the new driver module and the code generation works.

Create a capture of the communication you want to create a driver for.

Open the capture in WireShark

Start defining the types you see in your mspec file

Create a file ParserSerializerTestsuite.xml in the protocol modules src/test/resources directory.

Start adding empty test-cases for every packet in your recording, by copying the TCP/UDP/Whatever payload in Wireshark as hex-stream and pasting that in the raw element of a test-case.

In the driver module, create a ParserSerializer test that extends org.apache.plc4x.test.parserserializer.ParserSerializerTestsuiteRunner in src/test/java which references the ParserSerializerTestsuite.xml file of your protocol module.

Iteratively implement all the mspec types needed to process your captures: