From 616c6da969b30181efdb7c846af85ba92b0b02ed Mon Sep 17 00:00:00 2001 From: "Guenther Michael (INST/BSV2-TD)" Date: Fri, 12 Aug 2016 11:24:29 +0200 Subject: [PATCH] @aedelmann - Vorto mappings docs - review ok. Fixes #317 Signed-off-by: Guenther Michael (INST/BSV2-TD) --- website/documentation/editors/mapping-model.md | 12 +++++------- 1 file changed, 5 insertions(+), 7 deletions(-) diff --git a/website/documentation/editors/mapping-model.md b/website/documentation/editors/mapping-model.md index 15fa3aaca6..cab9f22eb4 100644 --- a/website/documentation/editors/mapping-model.md +++ b/website/documentation/editors/mapping-model.md @@ -11,7 +11,7 @@ This section details the following topics: [Overview](#overview) -[Usecases](#usecases) +[Use Cases](#use-cases) [Defining Mapping Models](#defining-mapping-models) @@ -26,7 +26,8 @@ Vorto allows the user to define mapping rules to map Vorto models to other targe The primary purpose of defining model mappings in Vorto is to directly translate or map datatype/functionblock/information model descriptions from Vorto to any other IoT platforms (for example, Kura, Eclipse Smarthome). Vorto model mapping acts as a bridge between Vorto definitions and target platforms/technologies. -## Usecases + +## Use Cases The model mapping provides an option to enhance the Vorto models with additional metadata descriptions targeted for a specific platform. Thereby the code generators can leverage the expanded metadata descriptions customized for their platforms. Vorto helps to integrate with other IoT platforms through the model mapping in flexible manner. Here are few possible scenarios where model mapping can be used: @@ -34,6 +35,7 @@ The model mapping provides an option to enhance the Vorto models with additional - Provide additional metadata in case the Vorto model is not able to describe a specific IoT solution. - Provide different model mappings for multiple versions of target platforms (For example, iOS 7/8). + ## Defining Mapping Models Model mapping can be defined for the following: @@ -42,6 +44,7 @@ Model mapping can be defined for the following: - [Function Blocks](./function-block-mapping.html) - [Information Models](./information-model-mapping.html) + ## Features The model mapping contains a direct mapping of Vorto grammar descriptions to custom defined `Stereotypes` and `Attributes` specific for the target platform. @@ -98,7 +101,6 @@ The following two examples definitions are given: } } - ![Colorlight Without Mapping]({{base}}/img/documentation/vorto_aws_without_mapping.png) By invoking the *AWS Generator* without any model mapping from Vorto Repository, it generates the following *Alexa* voice command vocabulary in the `colorlightsystemUtterances.txt` file. @@ -124,10 +126,8 @@ Now we define a model mapping `ColorLightMapping` to enhance the *Alexa* voice c ![Colorlight With Mapping]({{base}}/img/documentation/vorto_aws_with_mapping.png) - In the above mapping, the *Alexa* voice command is enhanced by additional commands with `increase` and `decrease` to control the `ColorLight`. Here, `alexa` is a custom defined `Stereotypes` keyword which the *AWS Generator* interprets and makes use of the additional values defined in the model mapping. Again, `command` is a custom defined `Attribute` keyword which the *AWS generator* can understand. - Once this model mapping `ColorLightMapping` is defined, it can be shared using the Vorto Repository Web interface page: ![Share Model Mapping]({{base}}/img/documentation/vorto_share_mapping_model.png) @@ -140,7 +140,6 @@ Once this model mapping `ColorLightMapping` is defined, it can be shared using t - With this model mapping the *AWS Generator* generates the file `colorlightsystemUtterances.txt` with the following content: setBrightness set brightness to {level} @@ -157,4 +156,3 @@ As you can see, the Vorto model mapping definition greatly enhances the capabili -