Skip to content

Commit 8cbce93

Browse files
committed
feat (node-fmu): Add yaml files for node fmu for documentation
Signed-off-by: Ritesh.K <riteshkarki6@gmail.com>
1 parent fce69e5 commit 8cbce93

File tree

3 files changed

+79
-0
lines changed

3 files changed

+79
-0
lines changed

doc/openapi/components/schemas/config/node_obj.yaml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,7 @@ discriminator:
2727
example: nodes/_example.yaml
2828
exec: nodes/_exec.yaml
2929
file: nodes/_file.yaml
30+
fmu: nodes/_fmu.yaml
3031
fpga: nodes/_fpga.yaml
3132
iec60870-5-104: nodes/_iec60870-5-104.yaml
3233
iec61850-8-1: nodes/_iec61850-8-1.yaml
Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# yaml-language-server: $schema=http://json-schema.org/draft-07/schema
2+
# SPDX-FileCopyrightText: 2014-2023 Institute for Automation of Complex Power Systems, RWTH Aachen University
3+
# SPDX-License-Identifier: Apache-2.0
4+
---
5+
allOf:
6+
- $ref: ../node_obj.yaml
7+
- $ref: file.yaml
Lines changed: 71 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,71 @@
1+
# yaml-language-server: $schema=http://json-schema.org/draft-07/schema
2+
# SPDX-FileCopyrightText: 2014-2026 Institute for Automation of Complex Power Systems, RWTH Aachen University
3+
# SPDX-License-Identifier: Apache-2.0
4+
---
5+
allOf:
6+
- type: object
7+
properties:
8+
fmu_path:
9+
format: uri
10+
description: |
11+
Specifies the URI to a FMU model
12+
13+
fmu_unpack_path:
14+
format: uri
15+
description: |
16+
Specifies the URI to a directory which has the unpacked files of the FMU model (mainly the shared library and the modelDescription.xml for the model)
17+
18+
fmuWritefirst:
19+
type: boolean
20+
description: |
21+
Specifies whether the model has to be writtem with input values before running. `true` denotes that the model should use the input values. `false` would make the model use default values instead.
22+
23+
startTime:
24+
type: number
25+
description: |
26+
Specifies the start time for the simulation. Value has to be at least one `stepSize` lesser than `stopTime`.
27+
28+
stopTime:
29+
type: number
30+
description: |
31+
Specifies the stop time for the simulation. The number of steps is calculated then by the difference between `startTime` and `stopTime` divided by the `stepSize`.
32+
33+
stepSize:
34+
type: number
35+
description: |
36+
Specifies the stepSize for the simulation. Special care has to be taken to ensure that the value is equal to the value mantioned in modelDescription.xml.
37+
38+
in:
39+
type: object
40+
properties:
41+
signals:
42+
type: array
43+
description: |
44+
The input signals for the model have to be mentioned here as elements of an array while specifying the name (should be the same as that found in the modelDescription file) and the datatype.
45+
46+
**Example**:
47+
48+
```
49+
signals = (
50+
{name = "In1", type = "float"},
51+
{name = "In2", type = "int"}
52+
)
53+
```
54+
out:
55+
type: object
56+
properties:
57+
signals:
58+
type: array
59+
description: |
60+
The output signals for the model have to be mentioned here as elements of an array while specifying the name (should be the same as that found in the modelDescription file) and the datatype.
61+
62+
**Example**:
63+
64+
```
65+
signals = (
66+
{name = "Out1", type = "float"}
67+
)
68+
```
69+
70+
- $ref: ../node_signals.yaml
71+
- $ref: ../node.yaml

0 commit comments

Comments
 (0)