Merge pull request #28 from aljoshakoecher/develop

CaSkade-Automation · Apr 14, 2023 · 2486bf0 · 2486bf0
2 parents a71d501 + 76fd454
commit 2486bf0
Show file tree

Hide file tree

Showing 42 changed files with 381 additions and 278 deletions.
diff --git a/.gitignore b/.gitignore
@@ -96,4 +96,5 @@ pom.xml.tag
 pom.xml.releaseBackup
 pom.xml.versionsBackup
 pom.xml.next
-release.properties
+release.properties
+.flattened-pom.xml
diff --git a/action-generator/pom.xml b/action-generator/pom.xml
@@ -5,11 +5,13 @@
 	<parent>
 		<groupId>io.github.aljoshakoecher.skillup</groupId>
 		<artifactId>skillup.parent</artifactId>
-		<version>1.0.0</version>
+		<version>${revision}</version>
 	</parent>
+
 	<artifactId>skillup.action-generator</artifactId>
 	<packaging>bundle</packaging>
 	<name>Action Generator</name>
+
 	<dependencies>
 		<dependency>
 			<groupId>org.osgi</groupId>
@@ -19,7 +21,7 @@
 		<dependency>
 			<groupId>io.github.aljoshakoecher.skillup</groupId>
 			<artifactId>skillup.annotations</artifactId>
-			<version>${project.version}</version>
+			<version>${revision}</version>
 		</dependency>
 		<dependency>
 			<groupId>com.github.aljoshakoecher</groupId>

diff --git a/annotations/pom.xml b/annotations/pom.xml
@@ -5,11 +5,11 @@
 	<parent>
 		<groupId>io.github.aljoshakoecher.skillup</groupId>
 		<artifactId>skillup.parent</artifactId>
-		<version>1.0.0</version>
+		<version>${revision}</version>
 	</parent>
 
 	<artifactId>skillup.annotations</artifactId>
-
+	
 	<packaging>bundle</packaging>
 	<name>SkillUp Annotations</name>
 	<description>Contains annotations that are needed to develop modules and skills using SkillUp</description>

diff --git a/description-generator/pom.xml b/description-generator/pom.xml
@@ -5,18 +5,21 @@
 	<parent>
 		<groupId>io.github.aljoshakoecher.skillup</groupId>
 		<artifactId>skillup.parent</artifactId>
-		<version>1.0.0</version>
+		<version>${revision}</version>
 	</parent>
+
 	<artifactId>skillup.description-generator</artifactId>
 	<packaging>bundle</packaging>
 	<name>Description Generator</name>
+
 	<dependencies>
 		<dependency>
 			<groupId>org.slf4j</groupId>
 			<artifactId>slf4j-api</artifactId>
 			<version>1.7.26</version>
 		</dependency>
 	</dependencies>
+
 	<build>
 		<plugins>
 			<plugin>
@@ -30,6 +33,7 @@
 			<plugin>
 				<groupId>org.apache.felix</groupId>
 				<artifactId>maven-bundle-plugin</artifactId>
+				<version>5.1.8</version>
 				<extensions>true</extensions>
 				<configuration>
 					<instructions>

diff --git a/description-generator/src/main/java/descriptionGenerator/SkillDescriptionGenerator.java b/description-generator/src/main/java/descriptionGenerator/SkillDescriptionGenerator.java
@@ -1,7 +1,5 @@
 package descriptionGenerator;
 
-import descriptionGenerator.DescriptionGenerator;
-
 /**
  * Class extends from {@link DescriptionGenerator} and has method that is equal
  * for every skill independent of its type (e.g. REST)

diff --git a/description-generator/src/main/resources/prefix.ttl b/description-generator/src/main/resources/prefix.ttl
@@ -1,4 +1,6 @@
-@prefix Cap: <http://www.hsu-ifa.de/ontologies/capability-model#> .
+@prefix CSS: <http://www.w3id.org/hsu-aut/css#> .
+@prefix CaSk: <http://www.w3id.org/hsu-aut/cask#> .
+@prefix CaSkMan: <http://www.w3id.org/hsu-aut/caskman#> .
 @prefix DIN8580: <http://www.hsu-ifa.de/ontologies/DIN8580#> .
 @prefix VDI3682: <http://www.hsu-ifa.de/ontologies/VDI3682#> .
 @prefix rdf: <http://www.w3.org/1999/02/22-rdf-syntax-ns#> .

diff --git a/description-generator/src/main/resources/stateMachine.ttl b/description-generator/src/main/resources/stateMachine.ttl
diff --git a/examples/module/pom.xml b/examples/module/pom.xml
@@ -5,16 +5,18 @@
 	<parent>
 		<groupId>io.github.aljoshakoecher.skillup</groupId>
 		<artifactId>examples</artifactId>
-		<version>1.0.0</version>
+		<version>${revision}</version>
 	</parent>
+
 	<artifactId>skillup.examples.module</artifactId>
 	<packaging>bundle</packaging>
 	<name>Example Module</name>
+
 	<dependencies>
 		<dependency>
 			<groupId>io.github.aljoshakoecher.skillup</groupId>
 			<artifactId>skillup.annotations</artifactId>
-			<version>${project.version}</version>
+			<version>${revision}</version>
 		</dependency>
 	</dependencies>
 	<build>

diff --git a/examples/module/src/main/java/module/ExampleModule.java b/examples/module/src/main/java/module/ExampleModule.java
@@ -0,0 +1,11 @@
+package module;
+
+import skillup.annotations.Module;
+
+/**
+ * An module example which has to be provided with annotation @Module
+ */
+@Module(description = "A simple example module that acts as a container but does not provide any more information", moduleIri = "https://hsu-hh.de/modules#ExampleModule")
+public class ExampleModule {
+
+}
diff --git a/examples/module/src/main/java/moduleA/ModuleA.java b/examples/module/src/main/java/moduleA/ModuleA.java
diff --git a/examples/opc-ua-skill/.gitignore → examples/opcua-add-skill/.gitignore b/examples/opc-ua-skill/.gitignore → examples/opcua-add-skill/.gitignore
diff --git a/examples/opc-ua-skill/pom.xml → examples/opcua-add-skill/pom.xml b/examples/opc-ua-skill/pom.xml → examples/opcua-add-skill/pom.xml
@@ -5,11 +5,13 @@
 	<parent>
 		<groupId>io.github.aljoshakoecher.skillup</groupId>
 		<artifactId>examples</artifactId>
-		<version>1.0.0</version>
+		<version>${revision}</version>
 	</parent>
-	<artifactId>skillup.examples.opc-ua-skill</artifactId>
+
+	<artifactId>skillup.examples.opc-ua-add-skill</artifactId>
 	<packaging>bundle</packaging>
 	<name>OPC-UA-Skill</name>
+
 	<dependencies>
 		<dependency>
 			<groupId>org.slf4j</groupId>
@@ -19,7 +21,7 @@
 		<dependency>
 			<groupId>io.github.aljoshakoecher.skillup</groupId>
 			<artifactId>skillup.annotations</artifactId>
-			<version>${project.version}</version>
+			<version>${revision}</version>
 		</dependency>
 	</dependencies>
 	<build>

diff --git a/...kill/src/main/java/skill/SimpleSkill.java → ...c/main/java/skill/OpcUaAdditionSkill.java b/...kill/src/main/java/skill/SimpleSkill.java → ...c/main/java/skill/OpcUaAdditionSkill.java
@@ -12,13 +12,12 @@
 import skillup.annotations.Starting;
 
 /**
- * Skill to add two values (every Skill has to be provided with
- * annotation @Skill)
+ * Skill to add two values with an OPC UA skill interface
  */
-@Skill(skillIri = "https://hsu-hh.de/skills#OpcUaSkill", capabilityIri = "https://hsu-hh.de/capabilites#bestCapability", moduleIri = "https://hsu-hh.de/modules#ModuleA", type = OpcUaSkillType.class)
-public class SimpleSkill {
+@Skill(skillIri = "https://hsu-hh.de/skills/examples#OpcUaAdditionSkill", capabilityIri = "https://hsu-hh.de/capabilities/examples#AdditionCapability", moduleIri = "https://hsu-hh.de/modules#ExampleModule", type = OpcUaSkillType.class)
+public class OpcUaAdditionSkill {
 
-	private final Logger logger = LoggerFactory.getLogger(SimpleSkill.class);
+	private final Logger logger = LoggerFactory.getLogger(OpcUaAdditionSkill.class);
 
 	/**
 	 * first value, which has optional values

diff --git a/examples/led-skill/pom.xml → examples/opcua-led-skill/pom.xml b/examples/led-skill/pom.xml → examples/opcua-led-skill/pom.xml
@@ -5,11 +5,13 @@
 	<parent>
 		<groupId>io.github.aljoshakoecher.skillup</groupId>
 		<artifactId>examples</artifactId>
-		<version>1.0.0</version>
+		<version>${revision}</version>
 	</parent>
+
 	<artifactId>skillup.examples.led-skill</artifactId>
 	<packaging>bundle</packaging>
 	<name>LED Skill</name>
+
 	<dependencies>
 		<dependency>
 			<groupId>org.slf4j</groupId>
@@ -19,7 +21,7 @@
 		<dependency>
 			<groupId>io.github.aljoshakoecher.skillup</groupId>
 			<artifactId>skillup.annotations</artifactId>
-			<version>${project.version}</version>
+			<version>${revision}</version>
 		</dependency>
 		<dependency>
 			<groupId>com.pi4j</groupId>

diff --git a/...d-skill/src/main/java/skill/LEDSkill.java → ...ll/src/main/java/skill/OpcUaLEDSkill.java b/...d-skill/src/main/java/skill/LEDSkill.java → ...ll/src/main/java/skill/OpcUaLEDSkill.java
@@ -15,12 +15,12 @@
 import skillup.annotations.SkillParameter;
 
 /**
- * LED Skill (every Skill has to be provided with annotation @Skill)
+ * Simple LED Skill with an OPC UA skill interface. Switches on LED on execute and switches it off on abort
  */
-@Skill(skillIri = "https://hsu-hh.de/skills#SwitchOnLED", capabilityIri = "https://hsu-hh.de/capabilites#LEDCapability", moduleIri = "https://hsu-hh.de/modules#ModuleA", type = OpcUaSkillType.class)
-public class LEDSkill {
+@Skill(skillIri = "https://hsu-hh.de/skill/exampless#LedSkill", capabilityIri = "https://hsu-hh.de/capabilities/examples#LedCapability", moduleIri = "https://hsu-hh.de/modules#ExampleModule", type = OpcUaSkillType.class)
+public class OpcUaLEDSkill {
 
-	private final Logger logger = LoggerFactory.getLogger(LEDSkill.class);
+	private final Logger logger = LoggerFactory.getLogger(OpcUaLEDSkill.class);
 
 	// controller to have access to pins of raspberry pi
 	private final GpioController gpio = GpioFactory.getInstance();

diff --git a/examples/opc-ua-skill2/.gitignore → examples/opcua-random-generator/.gitignore b/examples/opc-ua-skill2/.gitignore → examples/opcua-random-generator/.gitignore
diff --git a/examples/random-generator/pom.xml → examples/opcua-random-generator/pom.xml b/examples/random-generator/pom.xml → examples/opcua-random-generator/pom.xml
@@ -5,11 +5,13 @@
 	<parent>
 		<groupId>io.github.aljoshakoecher.skillup</groupId>
 		<artifactId>examples</artifactId>
-		<version>1.0.0</version>
+		<version>${revision}</version>
 	</parent>
+
 	<artifactId>skillup.examples.random-generator</artifactId>
 	<packaging>bundle</packaging>
 	<name>Random-Generator</name>
+
 	<dependencies>
 		<dependency>
 			<groupId>org.slf4j</groupId>
@@ -19,7 +21,7 @@
 		<dependency>
 			<groupId>io.github.aljoshakoecher.skillup</groupId>
 			<artifactId>skillup.annotations</artifactId>
-			<version>${project.version}</version>
+			<version>${revision}</version>
 		</dependency>
 		<dependency>
 			<groupId>com.github.aljoshakoecher</groupId>

diff --git a/...ator/src/main/java/skill/SimpleSkill.java → ...c/main/java/skill/OpcUaRandomAborter.java b/...ator/src/main/java/skill/SimpleSkill.java → ...c/main/java/skill/OpcUaRandomAborter.java
@@ -8,11 +8,11 @@
 import statemachine.Isa88StateMachine;
 
 /**
- * Skill to generate a random value (every Skill has to be provided with
- * annotation @Skill)
+ * A Skill with an OPC UA skill interface that generates a random value. If this value is less than .25, the skill stops itself. If the random value
+ * is between .25 and .5, it aborts. Otherwise, it just completes normally
  */
-@Skill(skillIri = "https://www.hsu-hh.de/aut/skills#RandomGenerator", capabilityIri = "https://www.hsu-hh.de/aut/skills#RandomGeneration", moduleIri = "https://hsu-hh.de/modules#ModuleA", type = OpcUaSkillType.class)
-public class SimpleSkill {
+@Skill(skillIri = "https://www.hsu-hh.de/aut/skills/examples#RandomAborter", capabilityIri = "https://www.hsu-hh.de/aut/capabilities/examples#RandomAborter", moduleIri = "https://hsu-hh.de/modules#ExampleModule", type = OpcUaSkillType.class)
+public class OpcUaRandomAborter {
 
 	/**
 	 * stateMachine to prevent forbidden situations
@@ -27,8 +27,7 @@ public class SimpleSkill {
 	private double random;
 
 	/**
-	 * When transition start is executed and skill got in state execute a random
-	 * value is generated
+	 * When transition start is executed and skill got in state execute a random value is generated
 	 */
 	@Execute
 	public void execute() {

diff --git a/examples/random-generator/.gitignore → examples/opcua-subtract-skill/.gitignore b/examples/random-generator/.gitignore → examples/opcua-subtract-skill/.gitignore
diff --git a/examples/opc-ua-skill2/pom.xml → examples/opcua-subtract-skill/pom.xml b/examples/opc-ua-skill2/pom.xml → examples/opcua-subtract-skill/pom.xml
@@ -5,11 +5,13 @@
 	<parent>
 		<groupId>io.github.aljoshakoecher.skillup</groupId>
 		<artifactId>examples</artifactId>
-		<version>1.0.0</version>
+		<version>${revision}</version>
 	</parent>
+
 	<artifactId>skillup.examples.opc-ua-skill2</artifactId>
 	<packaging>bundle</packaging>
 	<name>OPC-UA-Skill2</name>
+
 	<dependencies>
 		<dependency>
 			<groupId>org.slf4j</groupId>
@@ -19,7 +21,7 @@
 		<dependency>
 			<groupId>io.github.aljoshakoecher.skillup</groupId>
 			<artifactId>skillup.annotations</artifactId>
-			<version>${project.version}</version>
+			<version>${revision}</version>
 		</dependency>
 	</dependencies>
 	<build>

diff --git a/...l2/src/main/java/skill2/SimpleSkill2.java → ...c/main/java/skill/OpcUaSubtractSkill.java b/...l2/src/main/java/skill2/SimpleSkill2.java → ...c/main/java/skill/OpcUaSubtractSkill.java
@@ -1,4 +1,4 @@
-package skill2;
+package skill;
 
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
@@ -12,13 +12,12 @@
 import skillup.annotations.Starting;
 
 /**
- * Skill to subtract two values (every Skill has to be provided with
- * annotation @Skill)
+ * Simple skill to subtract two values with an OPC UA skill interface
  */
-@Skill(skillIri = "https://hsu-hh.de/skills#OpcUaSkill2", capabilityIri = "https://hsu-hh.de/capabilites#CrazyCapability", moduleIri = "https://hsu-hh.de/modules#ModuleA", type = OpcUaSkillType.class)
-public class SimpleSkill2 {
+@Skill(skillIri = "https://hsu-hh.de/skills/examples#SubtractSkill", capabilityIri = "https://hsu-hh.de/capabilities/examples#SubtractCapability", moduleIri = "https://hsu-hh.de/modules#ExampleModule", type = OpcUaSkillType.class)
+public class OpcUaSubtractSkill {
 
-	private final Logger logger = LoggerFactory.getLogger(SimpleSkill2.class);
+	private final Logger logger = LoggerFactory.getLogger(OpcUaSubtractSkill.class);
 
 	/**
 	 * first value

diff --git a/examples/pom.xml b/examples/pom.xml
@@ -5,18 +5,20 @@
 	<parent>
 		<groupId>io.github.aljoshakoecher.skillup</groupId>
 		<artifactId>skillup.parent</artifactId>
-		<version>1.0.0</version>
+		<version>${revision}</version>
 	</parent>
+
 	<artifactId>examples</artifactId>
 	<packaging>pom</packaging>
+
 	<modules>
 		<module>module</module>
-		<module>opc-ua-skill</module>
-		<module>opc-ua-skill2</module>
-		<module>rest-simple-skill</module>
-		<module>rest-simple-concat</module>
-		<module>rest-simple-multiplier</module>
-		<module>led-skill</module>
-		<module>random-generator</module>
+		<module>opcua-add-skill</module>
+		<module>opcua-led-skill</module>
+		<module>opcua-random-generator</module>
+		<module>opcua-subtract-skill</module>
+		<module>rest-concat</module>
+		<module>rest-doubler</module>
+		<module>rest-multiplier</module>
 	</modules>
 </project>
diff --git a/examples/rest-simple-concat/pom.xml → examples/rest-concat/pom.xml b/examples/rest-simple-concat/pom.xml → examples/rest-concat/pom.xml
@@ -5,11 +5,13 @@
 	<parent>
 		<groupId>io.github.aljoshakoecher.skillup</groupId>
 		<artifactId>examples</artifactId>
-		<version>1.0.0</version>
+		<version>${revision}</version>
 	</parent>
+
 	<artifactId>skillup.examples.rest-simple-concat</artifactId>
 	<packaging>bundle</packaging>
 	<name>REST-Simple-Concat</name>
+
 	<dependencies>
 		<dependency>
 			<groupId>org.slf4j</groupId>
@@ -19,7 +21,7 @@
 		<dependency>
 			<groupId>io.github.aljoshakoecher.skillup</groupId>
 			<artifactId>skillup.annotations</artifactId>
-			<version>${project.version}</version>
+			<version>${revision}</version>
 		</dependency>
 	</dependencies>
 	<build>

diff --git a/...le-concat/src/main/java/skill/Concat.java → ...st-concat/src/main/java/skill/Concat.java b/...le-concat/src/main/java/skill/Concat.java → ...st-concat/src/main/java/skill/Concat.java
@@ -11,7 +11,10 @@
 import skillup.annotations.SkillParameter;
 import skillup.annotations.Starting;
 
-@Skill(skillIri = "https://www.hsu-hh.de/aut/skills#RestConcat", capabilityIri = "https://www.hsu-hh.de/aut/skills#RandomGeneration", moduleIri = "https://hsu-hh.de/modules#ModuleA", type = RestSkillType.class)
+/**
+ * A skill that concatenates two strings into one. Accessible through a RESTful skill interface
+ */
+@Skill(skillIri = "https://www.hsu-hh.de/aut/skills/examples#RestConcat", capabilityIri = "https://www.hsu-hh.de/aut/capabilities/examples#StringConcatination", moduleIri = "https://hsu-hh.de/modules#ExampleModule", type = RestSkillType.class)
 public class Concat {
 
 	private final Logger logger = LoggerFactory.getLogger(Concat.class);

diff --git a/examples/rest-simple-skill/.gitignore → examples/rest-doubler/.gitignore b/examples/rest-simple-skill/.gitignore → examples/rest-doubler/.gitignore