Skip to content

Commit 10545b6

Browse files
committed
FMI simulations moved. Manual installation in process: composition explained.
1 parent c8e5d44 commit 10545b6

26 files changed

+513
-231
lines changed
Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
{
2+
"label": "DT definition",
3+
"position": 1,
4+
"link": {
5+
"type": "generated-index"
6+
}
7+
}
8+
Lines changed: 98 additions & 98 deletions
Original file line numberDiff line numberDiff line change
@@ -1,99 +1,99 @@
1-
---
2-
sidebar_position: 1
3-
---
4-
5-
# Create a type
6-
7-
The way to interact with [Eclipse Ditto](https://eclipse.dev/ditto/index.html) and therefore create not only digital twins, but connections, etc. is through http requests and methods.
8-
Although the graphical interface of OpenTwins makes it unnecessary to go so low level, the option to communicate directly with Eclipse Ditto is still available.
9-
10-
11-
import Tabs from '@theme/Tabs';
12-
import TabItem from '@theme/TabItem';
13-
14-
```mdx-code-block
15-
<Tabs className="unique-tabs"
16-
defaultValue="ui"
17-
values={[
18-
{label: 'Using Grafana interface', value: 'ui'},
19-
{label: 'Using http methods', value: 'http'},
20-
]}>
21-
<TabItem value="ui">
22-
```
23-
As explained in TWINS WIP, OpenTwins has two types of DT schemas. One for creating a single DT and other for creating a type to create multiple instances of a DT.
24-
25-
26-
To create a new DT type using OpenTwins plugin in Grafana, just select "Create new type in" button in "Types" tab.
27-
![CreateType](./img/createTypeButton.png)
28-
29-
A new window with a form that will define the DT and a viewer of the produced JSON schema will have appeared.
30-
31-
The first required information is the identification of the twin. There are two required field.
32-
- Namespace: Is the name of the context to which the type belongs.
33-
- ID: This must be unique within the scope of the type. The name of the type will precede it automatically.
34-
35-
![Identification](./img/typeidentification.png)
36-
37-
Next is type information. This basic static information about the type for description. There are several fields, but just one is required:
38-
- Policy* : We must select a policy.
39-
- Name.
40-
- Description.
41-
- Image: You can paste a image url to show in the type information.
42-
43-
![Information](./img/typeinformation.png)
44-
45-
In addition to the above information, new custom attributes can be defined, normally used as static information. By simply filling in the attribute name and its value, click on the "add" button to add a new attribute.
46-
47-
![Attributes](./img/attributes.png)
48-
49-
Finally, the features section is used to create the variables to be collected by the DT. Simply type the name and click on the "add" button. This will add a new variable to the twin schema.
50-
51-
![Features](./img/typefeatures.png)
52-
53-
An example of a schema of a DT of an abstract vehicle can be seen in the following JSON:
54-
55-
```JSON
56-
{
57-
"thingId": "benchmark:vehicle",
58-
"policyId": "default:basic_policy",
59-
"attributes": {
60-
"name": "Vehicle",
61-
"description": "Vehicle type for generating new vehicles.",
62-
"image": "ImageLink",
63-
"Brand": "EMPTY",
64-
"Subtype": "EMPTY"
65-
},
66-
"features": {
67-
"wheels": {
68-
"properties": {
69-
"value": null
70-
}
71-
},
72-
"power": {
73-
"properties": {
74-
"value": null
75-
}
76-
},
77-
"capacity": {
78-
"properties": {
79-
"value": null
80-
}
81-
}
82-
}
83-
}
84-
85-
```
86-
87-
88-
```mdx-code-block
89-
</TabItem>
90-
91-
<TabItem value="http">
92-
```
93-
# Creation using HTTP requests
94-
95-
```mdx-code-block
96-
</TabItem>
97-
</Tabs>
98-
1+
---
2+
sidebar_position: 1
3+
---
4+
5+
# Create a type
6+
7+
The way to interact with [Eclipse Ditto](https://eclipse.dev/ditto/index.html) and therefore create not only digital twins, but connections, etc. is through http requests and methods.
8+
Although the graphical interface of OpenTwins makes it unnecessary to go so low level, the option to communicate directly with Eclipse Ditto is still available.
9+
10+
11+
import Tabs from '@theme/Tabs';
12+
import TabItem from '@theme/TabItem';
13+
14+
```mdx-code-block
15+
<Tabs className="unique-tabs"
16+
defaultValue="ui"
17+
values={[
18+
{label: 'Using Grafana interface', value: 'ui'},
19+
{label: 'Using http methods', value: 'http'},
20+
]}>
21+
<TabItem value="ui">
22+
```
23+
As explained in TWINS WIP, OpenTwins has two types of DT schemas. One for creating a single DT and other for creating a type to create multiple instances of a DT.
24+
25+
26+
To create a new DT type using OpenTwins plugin in Grafana, just select "Create new type in" button in "Types" tab.
27+
![CreateType](./img/createTypeButton.png)
28+
29+
A new window with a form that will define the DT and a viewer of the produced JSON schema will have appeared.
30+
31+
The first required information is the identification of the twin. There are two required field.
32+
- Namespace: Is the name of the context to which the type belongs.
33+
- ID: This must be unique within the scope of the type. The name of the type will precede it automatically.
34+
35+
![Identification](./img/typeidentification.png)
36+
37+
Next is type information. This basic static information about the type for description. There are several fields, but just one is required:
38+
- Policy* : We must select a policy.
39+
- Name.
40+
- Description.
41+
- Image: You can paste a image url to show in the type information.
42+
43+
![Information](./img/typeinformation.png)
44+
45+
In addition to the above information, new custom attributes can be defined, normally used as static information. By simply filling in the attribute name and its value, click on the "add" button to add a new attribute.
46+
47+
![Attributes](./img/attributes.png)
48+
49+
Finally, the features section is used to create the variables to be collected by the DT. Simply type the name and click on the "add" button. This will add a new variable to the twin schema.
50+
51+
![Features](./img/typefeatures.png)
52+
53+
An example of a schema of a DT of an abstract vehicle can be seen in the following JSON:
54+
55+
```JSON
56+
{
57+
"thingId": "benchmark:vehicle",
58+
"policyId": "default:basic_policy",
59+
"attributes": {
60+
"name": "Vehicle",
61+
"description": "Vehicle type for generating new vehicles.",
62+
"image": "ImageLink",
63+
"Brand": "EMPTY",
64+
"Subtype": "EMPTY"
65+
},
66+
"features": {
67+
"wheels": {
68+
"properties": {
69+
"value": null
70+
}
71+
},
72+
"power": {
73+
"properties": {
74+
"value": null
75+
}
76+
},
77+
"capacity": {
78+
"properties": {
79+
"value": null
80+
}
81+
}
82+
}
83+
}
84+
85+
```
86+
87+
88+
```mdx-code-block
89+
</TabItem>
90+
91+
<TabItem value="http">
92+
```
93+
# Creation using HTTP requests
94+
95+
```mdx-code-block
96+
</TabItem>
97+
</Tabs>
98+
9999
```

docs/docs/fmi/API.md renamed to docs/docs/guides/fmi/API.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
sidebar_position: 3
2+
sidebar_position: 2
33
---
44

55
# API Documentation

docs/docs/fmi/_category_.json renamed to docs/docs/guides/fmi/_category_.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"label": "FMI Simulation",
3-
"position": 5,
3+
"position": 4,
44
"link": {
55
"type": "generated-index",
66
"description": "OpenTwins supports the Functional Mock-up Interface (FMI) standard for simulation."

docs/docs/fmi/concepts.mdx renamed to docs/docs/guides/fmi/concepts.mdx

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
2-
sidebar_position: 2
2+
sidebar_position: 1
3+
sidebar_label: Concepts
34
---
45

56
import useBaseUrl from '@docusaurus/useBaseUrl';

docs/docs/guides/index.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
---
2+
sidebar_position: 4
3+
---
4+
5+
import DocCardList from '@theme/DocCardList';
6+
7+
# Guides
8+
9+
:::warning
10+
11+
The guides is being written right now. Sorry for the inconvenience.
12+
13+
:::
14+
15+
<DocCardList className="DocCardList--no-description"/>
Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
{
2+
"label": "Machine Learning",
3+
"position": 3,
4+
"link": {
5+
"type": "generated-index"
6+
}
7+
}
8+

docs/docs/guides/_category_.json renamed to docs/docs/guides/monitoring/_category_.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
2-
"label": "Guides",
3-
"position": 4,
2+
"label": "Monitoring",
3+
"position": 2,
44
"link": {
55
"type": "generated-index"
66
}

0 commit comments

Comments
 (0)