Merge branch 'main' into v1.0.x

AUTHORS.md

@@ -10,5 +10,6 @@ The following people have contributed to this repository:
 * Andreas Schilling, andreas.schilling3@de.bosch.com
 * Georg Schmidt-Dumont, Robert Bosch GmbH, georg.schmidt-dumont@de.bosch.com 
 * Andreas Textor, Andreas.Textor@de.bosch.com
+* Dominic Schabel
 
 Please add yourself to this list, if you contribute to the content.

CONTRIBUTING.md

@@ -33,8 +33,9 @@ name of branch | description
 ----| ----
 `main` | Contains the latest state of the repository
 `v{version_number}-RC` | A state on which the working group agreed on as a release candidate but which is missing the approval by the OMP. 
-{version_number} | A release of the respective version which is approved by the working group and the OMP. 
+`v{version_number}` | A release of the respective version which is approved by the working group and the OMP. 
 `feature/{feature-name}` | Contains the development on a specific feature and is intended to be merged back into the `main` branch as soon as possible. Note, that it is recommended for contributors to create and develop feature branches in a personal fork and not the upstream repository.
+`bug/{bug-name}` | Contains the development of (usually smaller) changes in files of the repository that do not introduce new functionality but fix mistakes, errors or inconsistencies. These branches should be merged back into the `main`branch as soon as possible.
 
 ## Issues
 We use the `Issues` feature of GitHub for tracking all types of work in the repository.

LICENSE.txt

@@ -226,13 +226,10 @@ distributed with this file, You can obtain one at https://mozilla.org/MPL/2.0/.
 If it is not possible or desirable to put the notice in a particular file, then You may include the notice in a location 
 (such as a LICENSE file in a relevant directory) where a recipient would be likely to look for such a notice.
 
-Copyright (c) 2020 Robert Bosch GmbH
+You may add additional accurate notices of copyright ownership.
 
 Exhibit B - “Incompatible With Secondary Licenses” Notice
 This Source Code Form is “Incompatible With Secondary Licenses”, as defined by the Mozilla Public License, v. 2.0.
 
----- Additional notices on copyright according to Exhibit A ----
-
-Copyright (c) 2020 Robert Bosch Manufacturing Solutions GmbH, all rights reserved
 
 

README.md

@@ -1,11 +1,12 @@
-# BAMM Aspect Meta Model
+# BAMM Aspect Meta Model ![build](https://github.com/OpenManufacturingPlatform/sds-bamm-aspect-meta-model/actions/workflows/antora-build.yml/badge.svg)
 
 - [Introduction](#introduction)
 - [Example Usage](#example-usage)
+- [Getting help](#getting-help)
 - [Build and contribute](#build-and-contribute)
 
 ## Introduction
-The BAMM Aspect Meta Model (BAMM) allows the creation of models to describe the semantics of digital twins by defining their domain specific aspects.
+The [BAMM Aspect Meta Model](https://openmanufacturingplatform.github.io/sds-bamm-aspect-meta-model/bamm-specification/snapshot/index.html) (BAMM) allows the creation of models to describe the semantics of digital twins by defining their domain specific aspects.
 In this context, digital twins are the digital representation of a physical or virtual object that bundles and combines several aspects.
 The BAMM Aspect *Meta* Model (BAMM) provides a set of predefined objects (as depicted below) that allow a domain expert to define aspect models and complement a digital twin with a semantic foundation.
 
@@ -23,7 +24,15 @@ The AGV digital twin could encompass aspects, such as its movement position or b
 However, both aspects could also be part of other digital twins.
 This modularization and reusabaility simplifies the creation of highly complex use cases.
 
+## Getting help
+Are you having trouble with BAMM Aspect Meta Model? We want to help!
+
+* Check the reference [documentation](https://openmanufacturingplatform.github.io/sds-bamm-aspect-meta-model/bamm-specification/snapshot/index.html)
+* Having issues with BAMM? Open a [GitHub issue]( https://github.com/OpenManufacturingPlatform/sds-bamm-aspect-meta-model/issues).
+
 ## Build and contribute
+
+### Build the documentation
 To build the Antora documentation locally, clone the repository and run
 
 ```./gradlew antora```
@@ -33,5 +42,13 @@ inside the repository folder.
 Navigate to *build* > *site* and open the `index.html` page in your web browser to see the result.
 Repeat the steps everytime you make any changes in the documentation and want to inspect the final outcome.
 
+### Build the BAMM artifact
+To build the BAMM Aspect Meta Model, run
+
+```./gradlew build```.
+
+This will compile the code and run all tests. The resulting JAR file can be found under build > libs.
+Please be aware, that you need JDK 11 to run build and tests.
+
 Before making a contribution, please take a look at the [contribution guidelines](CONTRIBUTING.md).
 Please keep in mind to create an issue first before opening a pull request.

build.gradle.kts

@@ -4,6 +4,62 @@ import com.moowork.gradle.node.task.NodeTask
 
 plugins {
     id("com.github.node-gradle.node") version "2.2.4"
+    id ("java-library")
+    id ("maven-publish")
+    id ("signing")
+}
+
+group = "io.openmanufacturing"
+version = "1.0.0"
+
+tasks.withType<JavaCompile> {
+    sourceCompatibility = "11"
+    targetCompatibility = "11"
+}
+
+repositories {
+    mavenCentral()
+}
+
+tasks.test {
+    useJUnitPlatform()
+}
+
+dependencies {
+    testImplementation ("org.junit.jupiter:junit-jupiter:5.6.3")
+    testImplementation ("org.assertj:assertj-core:3.18.1")
+    testImplementation ("org.topbraid:shacl:1.3.1")
+    testImplementation ("io.vavr:vavr:0.10.3")
+}
+
+publishing {
+    publications {
+        create<MavenPublication>("mavenRelease") {
+            groupId = "io.openmanufacturing"
+            artifactId = "sds-aspect-meta-model"
+            version = "1.0.0"
+
+            from(components["java"])
+
+            pom {
+                name.set("BAMM Aspect Meta Model")
+                licenses {
+                    license {
+                        name.set("Mozilla Public License, Version 2.0")
+                        url.set("https://www.mozilla.org/en-US/MPL/2.0/")
+                    }
+                }
+            }
+        }
+    }
+}
+
+signing {
+    var signingKey : String? = System.getenv("PGP_KEY")
+    var signingPassword : String? = System.getenv("PGP_KEY_PASSWORD")
+    useInMemoryPgpKeys(signingKey, signingPassword)
+
+    sign(publishing.publications["mavenRelease"])
 }
 
 configure<NodeExtension> {
@@ -43,7 +99,3 @@ tasks.register<NodeTask>("antoraLocal") {
     setArgs(listOf("--generator", "antora-site-generator-lunr", "site-local.yml", "--stacktrace"))
     setWorkingDir(project.projectDir)
 }
-
-tasks.register<Delete>("clean") {
-    delete(project.buildDir)
-}

legal/LICENSE-OFL-1.1.txt

@@ -0,0 +1,86 @@
+-----------------------------------------------------------
+SIL OPEN FONT LICENSE Version 1.1 - 26 February 2007
+-----------------------------------------------------------
+
+PREAMBLE
+The goals of the Open Font License (OFL) are to stimulate worldwide
+development of collaborative font projects, to support the font creation
+efforts of academic and linguistic communities, and to provide a free and
+open framework in which fonts may be shared and improved in partnership
+with others.
+
+The OFL allows the licensed fonts to be used, studied, modified and
+redistributed freely as long as they are not sold by themselves. The
+fonts, including any derivative works, can be bundled, embedded,
+redistributed and/or sold with any software provided that any reserved
+names are not used by derivative works. The fonts and derivatives,
+however, cannot be released under any other type of license. The
+requirement for fonts to remain under this license does not apply
+to any document created using the fonts or their derivatives.
+
+DEFINITIONS
+"Font Software" refers to the set of files released by the Copyright
+Holder(s) under this license and clearly marked as such. This may
+include source files, build scripts and documentation.
+
+"Reserved Font Name" refers to any names specified as such after the
+copyright statement(s).
+
+"Original Version" refers to the collection of Font Software components as
+distributed by the Copyright Holder(s).
+
+"Modified Version" refers to any derivative made by adding to, deleting,
+or substituting -- in part or in whole -- any of the components of the
+Original Version, by changing formats or by porting the Font Software to a
+new environment.
+
+"Author" refers to any designer, engineer, programmer, technical
+writer or other person who contributed to the Font Software.
+
+PERMISSION AND CONDITIONS
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of the Font Software, to use, study, copy, merge, embed, modify,
+redistribute, and sell modified and unmodified copies of the Font
+Software, subject to the following conditions:
+
+1) Neither the Font Software nor any of its individual components,
+in Original or Modified Versions, may be sold by itself.
+
+2) Original or Modified Versions of the Font Software may be bundled,
+redistributed and/or sold with any software, provided that each copy
+contains the above copyright notice and this license. These can be
+included either as stand-alone text files, human-readable headers or
+in the appropriate machine-readable metadata fields within text or
+binary files as long as those fields can be easily viewed by the user.
+
+3) No Modified Version of the Font Software may use the Reserved Font
+Name(s) unless explicit written permission is granted by the corresponding
+Copyright Holder. This restriction only applies to the primary font name as
+presented to the users.
+
+4) The name(s) of the Copyright Holder(s) or the Author(s) of the Font
+Software shall not be used to promote, endorse or advertise any
+Modified Version, except to acknowledge the contribution(s) of the
+Copyright Holder(s) and the Author(s) or with their explicit written
+permission.
+
+5) The Font Software, modified or unmodified, in part or in whole,
+must be distributed entirely under this license, and must not be
+distributed under any other license. The requirement for fonts to
+remain under this license does not apply to any document created
+using the Font Software.
+
+TERMINATION
+This license becomes null and void if any of the above conditions are
+not met.
+
+DISCLAIMER
+THE FONT SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT
+OF COPYRIGHT, PATENT, TRADEMARK, OR OTHER RIGHT. IN NO EVENT SHALL THE
+COPYRIGHT HOLDER BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+INCLUDING ANY GENERAL, SPECIAL, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL
+DAMAGES, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF THE USE OR INABILITY TO USE THE FONT SOFTWARE OR FROM
+OTHER DEALINGS IN THE FONT SOFTWARE.

legal/NOTICE.md

@@ -12,4 +12,11 @@ This repository contains software developed by the [Antora Project](https://anto
 
 Your use of Antora is subject to the terms and conditions of the Mozilla Public License 2.0. A copy of the license is contained in the file [LICENSE.txt](/LICENSE.txt) and is also available at https://mozilla.org/MPL/2.0/.
 
-The source code is available from [GitLab](https://gitlab.com/antora).
+The source code is available from [GitLab](https://gitlab.com/antora).
+
+## Cairo Font
+This repository contains software developed by the [Cairo Project](https://github.com/Gue3bara/Cairo).
+
+Your use of Cairo is subject to the terms and conditions of the SIL Open Font License 1.1. A copy of the license is contained in the file [/legal/LICENSE-OFL-1.1.txt](/legal/LICENSE-OFL-1.1.txt) and is also available at https://scripts.sil.org/cms/scripts/page.php?item_id=OFL_web.
+
+The source code is available from [GitHub](https://github.com/Gue3bara/Cairo).

settings.gradle

@@ -0,0 +1 @@
+rootProject.name = 'sds-aspect-meta-model'

site.yml

@@ -33,9 +33,9 @@ asciidoc:
     meta-model-abbr: BAMM
     omp: Open Manufacturing Platform
     omp-abbr: OMP
-    bamm: urn:bamm:org.open-manufacturing.digitaltwin:meta-model:1.0.0#@
-    bamm-c: urn:bamm:org.open-manufacturing.digitaltwin:characteristic:1.0.0#@
-    bamm-e: urn:bamm:org.open-manufacturing.digitaltwin:entity:1.0.0#@
-    unit:  urn:bamm:org.open-manufacturing.digitaltwin:unit:1.0.0#@
+    bamm: urn:bamm:io.openmanufacturing:meta-model:1.0.0#@
+    bamm-c: urn:bamm:io.openmanufacturing:characteristic:1.0.0#@
+    bamm-e: urn:bamm:io.openmanufacturing:entity:1.0.0#@
+    unit:  urn:bamm:io.openmanufacturing:unit:1.0.0#@
     example-ns: com.mycompany@
 

src/docs/modules/ROOT/nav.adoc

@@ -17,3 +17,4 @@ SPDX-License-Identifier: MPL-2.0
 * xref:entities.adoc[Entities]
 * xref:units.adoc[Units]
 * xref:modeling-guidelines.adoc[Aspects]
+* xref:payloads.adoc[Payloads]