Skip to content

Commit

Permalink
feat(plc4j/driver/open-protocol): Implemented a rough skeleton for an…
Browse files Browse the repository at this point in the history 
… open-protocol driver (Not functional yet ... It just compiles the mspec generated types)
  • Loading branch information
@chrisdutz
chrisdutz committed Jan 23, 2023
1 parent d8300da commit e3cbcdf
Show file tree
Hide file tree
Showing 38 changed files with 5,659 additions and 245 deletions.
175 changes: 175 additions & 0 deletions plc4j/drivers/open-protocol/pom.xml
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,175 @@
<?xml version="1.0" encoding="UTF-8"?>
<!--
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.
-->
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>

<parent>
<groupId>org.apache.plc4x</groupId>
<artifactId>plc4j-drivers</artifactId>
<version>0.11.0-SNAPSHOT</version>
</parent>

<artifactId>plc4j-driver-open-protocol</artifactId>
<name>PLC4J: Driver: Open-Protocol</name>
<description>Implementation of a PLC4X driver for the Open-Protocol protocol.</description>

<build>
<plugins>
<plugin>
<groupId>org.apache.plc4x.plugins</groupId>
<artifactId>plc4x-maven-plugin</artifactId>
<executions>
<execution>
<id>generate-driver</id>
<phase>generate-sources</phase>
<goals>
<goal>generate-driver</goal>
</goals>
<configuration>
<protocolName>open-protocol</protocolName>
<languageName>java</languageName>
<outputFlavor>read-write</outputFlavor>
<outputDir>src/main/generated</outputDir>
</configuration>
</execution>
</executions>
</plugin>
<plugin>
<groupId>org.apache.karaf.tooling</groupId>
<artifactId>karaf-maven-plugin</artifactId>
<executions>
<execution>
<id>generate-feature-xml</id>
<phase>compile</phase>
<goals>
<!-- Generate the feature.xml -->
<goal>features-generate-descriptor</goal>
<!-- Check the feature.xml -->
<goal>verify</goal>
</goals>
<configuration>
<enableGeneration>true</enableGeneration>
<aggregateFeatures>true</aggregateFeatures>
</configuration>
</execution>
<execution>
<id>build-kar</id>
<phase>package</phase>
<goals>
<!--
Build a kar archive (Jar containing the feature.xml
as well as the module content and it's dependencies.
-->
<goal>kar</goal>
</goals>
</execution>
</executions>
</plugin>
<plugin>
<groupId>org.apache.felix</groupId>
<artifactId>maven-bundle-plugin</artifactId>
<extensions>true</extensions>
<configuration>
<instructions>
<Bundle-SymbolicName>${project.groupId}.${project.artifactId}</Bundle-SymbolicName>
<Bundle-Activator>org.apache.plc4x.java.osgi.DriverActivator</Bundle-Activator>
<Export-Service>org.apache.plc4x.java.api.PlcDriver,org.apache.plc4x.java.modbus.tcp.ModbusTcpDriver</Export-Service>
<Import-Package>
com.fasterxml.jackson.annotation;resolution:=optional,
*
</Import-Package>
</instructions>
</configuration>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-dependency-plugin</artifactId>
<configuration>
<usedDependencies combine.children="append">
<usedDependency>org.apache.plc4x:plc4j-transport-serial</usedDependency>
<usedDependency>org.apache.plc4x:plc4x-code-generation-language-java</usedDependency>
<usedDependency>org.apache.plc4x:plc4x-protocols-open-protocol</usedDependency>
</usedDependencies>
</configuration>
</plugin>
</plugins>
</build>

<dependencies>
<dependency>
<groupId>org.apache.plc4x</groupId>
<artifactId>plc4j-api</artifactId>
<version>0.11.0-SNAPSHOT</version>
</dependency>
<dependency>
<groupId>org.apache.plc4x</groupId>
<artifactId>plc4j-spi</artifactId>
<version>0.11.0-SNAPSHOT</version>
</dependency>

<dependency>
<groupId>org.apache.plc4x</groupId>
<artifactId>plc4j-transport-tcp</artifactId>
<version>0.11.0-SNAPSHOT</version>
</dependency>
<dependency>
<groupId>org.apache.plc4x</groupId>
<artifactId>plc4j-transport-serial</artifactId>
<version>0.11.0-SNAPSHOT</version>
</dependency>

<dependency>
<groupId>io.netty</groupId>
<artifactId>netty-buffer</artifactId>
</dependency>

<dependency>
<groupId>org.apache.plc4x</groupId>
<artifactId>plc4j-utils-test-utils</artifactId>
<version>0.11.0-SNAPSHOT</version>
<scope>test</scope>
</dependency>

<dependency>
<groupId>org.apache.plc4x</groupId>
<artifactId>plc4x-code-generation-language-java</artifactId>
<version>0.11.0-SNAPSHOT</version>
<!-- Scope is 'provided' as this way it's not shipped with the driver -->
<scope>provided</scope>
</dependency>

<dependency>
<groupId>org.apache.plc4x</groupId>
<artifactId>plc4x-protocols-open-protocol</artifactId>
<version>0.11.0-SNAPSHOT</version>
<!-- Scope is 'provided' as this way it's not shipped with the driver -->
<scope>provided</scope>
</dependency>
<dependency>
<groupId>org.apache.plc4x</groupId>
<artifactId>plc4x-protocols-open-protocol</artifactId>
<version>0.11.0-SNAPSHOT</version>
<classifier>tests</classifier>
<type>test-jar</type>
<scope>test</scope>
</dependency>
</dependencies>

</project>
203 changes: 203 additions & 0 deletions ...ache/plc4x/java/openprotocol/readwrite/ApplicationCommunicationStartAcknowledgeBlock.java
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,203 @@
/*
* 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 org.apache.plc4x.java.openprotocol.readwrite;

import static org.apache.plc4x.java.spi.codegen.fields.FieldReaderFactory.*;
import static org.apache.plc4x.java.spi.codegen.fields.FieldWriterFactory.*;
import static org.apache.plc4x.java.spi.codegen.io.DataReaderFactory.*;
import static org.apache.plc4x.java.spi.codegen.io.DataWriterFactory.*;
import static org.apache.plc4x.java.spi.generation.StaticHelper.*;

import java.time.*;
import java.util.*;
import org.apache.plc4x.java.api.exceptions.*;
import org.apache.plc4x.java.api.value.*;
import org.apache.plc4x.java.spi.codegen.*;
import org.apache.plc4x.java.spi.codegen.fields.*;
import org.apache.plc4x.java.spi.codegen.io.*;
import org.apache.plc4x.java.spi.generation.*;

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

public abstract class ApplicationCommunicationStartAcknowledgeBlock implements Message {

// Abstract accessors for discriminator values.
public abstract Integer getBlockType();

public ApplicationCommunicationStartAcknowledgeBlock() {
super();
}

protected abstract void serializeApplicationCommunicationStartAcknowledgeBlockChild(
WriteBuffer writeBuffer) throws SerializationException;

public void serialize(WriteBuffer writeBuffer) throws SerializationException {
PositionAware positionAware = writeBuffer;
int startPos = positionAware.getPos();
writeBuffer.pushContext("ApplicationCommunicationStartAcknowledgeBlock");

// Discriminator Field (blockType) (Used as input to a switch field)
writeDiscriminatorField("blockType", getBlockType(), writeUnsignedInt(writeBuffer, 16));

// Switch field (Serialize the sub-type)
serializeApplicationCommunicationStartAcknowledgeBlockChild(writeBuffer);

writeBuffer.popContext("ApplicationCommunicationStartAcknowledgeBlock");
}

@Override
public int getLengthInBytes() {
return (int) Math.ceil((float) getLengthInBits() / 8.0);
}

@Override
public int getLengthInBits() {
int lengthInBits = 0;
ApplicationCommunicationStartAcknowledgeBlock _value = this;

// Discriminator Field (blockType)
lengthInBits += 16;

// Length of sub-type elements will be added by sub-type...

return lengthInBits;
}

public static ApplicationCommunicationStartAcknowledgeBlock staticParse(
ReadBuffer readBuffer, Object... args) throws ParseException {
PositionAware positionAware = readBuffer;
return staticParse(readBuffer);
}

public static ApplicationCommunicationStartAcknowledgeBlock staticParse(ReadBuffer readBuffer)
throws ParseException {
readBuffer.pullContext("ApplicationCommunicationStartAcknowledgeBlock");
PositionAware positionAware = readBuffer;
int startPos = positionAware.getPos();
int curPos;

int blockType =
readDiscriminatorField(
"blockType", readUnsignedInt(readBuffer, 16), WithOption.WithEncoding("AsciiUint"));

// Switch Field (Depending on the discriminator values, passes the instantiation to a sub-type)
ApplicationCommunicationStartAcknowledgeBlockBuilder builder = null;
if (EvaluationHelper.equals(blockType, (int) 1)) {
builder = ApplicationCommunicationStartAcknowledgeBlockCellId.staticParseBuilder(readBuffer);
} else if (EvaluationHelper.equals(blockType, (int) 2)) {
builder =
ApplicationCommunicationStartAcknowledgeBlockChannelId.staticParseBuilder(readBuffer);
} else if (EvaluationHelper.equals(blockType, (int) 3)) {
builder =
ApplicationCommunicationStartAcknowledgeBlockControllerName.staticParseBuilder(
readBuffer);
} else if (EvaluationHelper.equals(blockType, (int) 4)) {
builder =
ApplicationCommunicationStartAcknowledgeBlockSupplierCode.staticParseBuilder(readBuffer);
} else if (EvaluationHelper.equals(blockType, (int) 5)) {
builder =
ApplicationCommunicationStartAcknowledgeBlockOpenProtocolVersion.staticParseBuilder(
readBuffer);
} else if (EvaluationHelper.equals(blockType, (int) 6)) {
builder =
ApplicationCommunicationStartAcknowledgeBlockControllerSoftwareVersion.staticParseBuilder(
readBuffer);
} else if (EvaluationHelper.equals(blockType, (int) 7)) {
builder =
ApplicationCommunicationStartAcknowledgeBlockToolSoftwareVersion.staticParseBuilder(
readBuffer);
} else if (EvaluationHelper.equals(blockType, (int) 8)) {
builder = ApplicationCommunicationStartAcknowledgeBlockRbuType.staticParseBuilder(readBuffer);
} else if (EvaluationHelper.equals(blockType, (int) 9)) {
builder =
ApplicationCommunicationStartAcknowledgeBlockControllerSerialNumber.staticParseBuilder(
readBuffer);
} else if (EvaluationHelper.equals(blockType, (int) 10)) {
builder =
ApplicationCommunicationStartAcknowledgeBlockSystemType.staticParseBuilder(readBuffer);
} else if (EvaluationHelper.equals(blockType, (int) 11)) {
builder =
ApplicationCommunicationStartAcknowledgeBlockSystemSubtype.staticParseBuilder(readBuffer);
} else if (EvaluationHelper.equals(blockType, (int) 12)) {
builder =
ApplicationCommunicationStartAcknowledgeBlockSequenceNumberSupport.staticParseBuilder(
readBuffer);
} else if (EvaluationHelper.equals(blockType, (int) 13)) {
builder =
ApplicationCommunicationStartAcknowledgeBlockLinkingHandlingSupport.staticParseBuilder(
readBuffer);
} else if (EvaluationHelper.equals(blockType, (int) 14)) {
builder =
ApplicationCommunicationStartAcknowledgeBlockStationId.staticParseBuilder(readBuffer);
} else if (EvaluationHelper.equals(blockType, (int) 15)) {
builder =
ApplicationCommunicationStartAcknowledgeBlockStationName.staticParseBuilder(readBuffer);
} else if (EvaluationHelper.equals(blockType, (int) 16)) {
builder =
ApplicationCommunicationStartAcknowledgeBlockClientId.staticParseBuilder(readBuffer);
}
if (builder == null) {
throw new ParseException(
"Unsupported case for discriminated type"
+ " parameters ["
+ "blockType="
+ blockType
+ "]");
}

readBuffer.closeContext("ApplicationCommunicationStartAcknowledgeBlock");
// Create the instance
ApplicationCommunicationStartAcknowledgeBlock _applicationCommunicationStartAcknowledgeBlock =
builder.build();
return _applicationCommunicationStartAcknowledgeBlock;
}

public static interface ApplicationCommunicationStartAcknowledgeBlockBuilder {
ApplicationCommunicationStartAcknowledgeBlock build();
}

@Override
public boolean equals(Object o) {
if (this == o) {
return true;
}
if (!(o instanceof ApplicationCommunicationStartAcknowledgeBlock)) {
return false;
}
ApplicationCommunicationStartAcknowledgeBlock that =
(ApplicationCommunicationStartAcknowledgeBlock) o;
return true;
}

@Override
public int hashCode() {
return Objects.hash();
}

@Override
public String toString() {
WriteBufferBoxBased writeBufferBoxBased = new WriteBufferBoxBased(true, true);
try {
writeBufferBoxBased.writeSerializable(this);
} catch (SerializationException e) {
throw new RuntimeException(e);
}
return "\n" + writeBufferBoxBased.getBox().toString() + "\n";
}
}

0 comments on commit e3cbcdf

Please sign in to comment.