1
0
Fork 0
mirror of https://git.rwth-aachen.de/acs/public/villas/node/ synced 2025-03-09 00:00:00 +01:00

openapi: harmonize structure across hooks, formats and node-types

This commit is contained in:
Steffen Vogel 2022-04-07 08:52:19 +02:00
parent 5feb82e7a3
commit 1dd1fefd73
110 changed files with 509 additions and 478 deletions

View file

@ -5,9 +5,11 @@ type: object
title: Format Object
required:
- type
properties:
type:
type: string
discriminator:
propertyName: type
mapping:

View file

@ -4,6 +4,7 @@
description: |
The payload format which is used to encode and decode exchanged messages.
example: villas.human
oneOf:
- $ref: format_obj.yaml
- title: Format Name

View file

@ -1,33 +1,17 @@
# yaml-language-server: $schema=http://json-schema.org/draft-07/schema
---
type: object
title: Hook
properties:
enabled:
type: boolean
default: true
description: An optional field which can be used to disable a hook.
priority:
type: integer
default: 99
description: |
The priority of this hook which determines the order in which hooks are executed.
Hooks with a lwoer priority are executed before ones with a higher priority.
discriminator:
propertyName: type
mapping:
average: hooks/average.yaml
cast: hooks/cast.yaml
decimate: hooks/decimate.yaml
dp: hooks/dp.yaml
dump: hooks/dump.yaml
ebm: hooks/ebm.yaml
fix: hooks/fix.yaml
gate: hooks/gate.yaml
jitter_calc: hooks/jitter_calc.yaml
limit_rate: hooks/limit_rate.yaml
limit_value: hooks/limit_value.yaml
lua: hooks/lua.yaml
ma: hooks/ma.yaml
pmu_dft: hooks/pmu_dft.yaml
pps_ts: hooks/pps_ts.yaml
print: hooks/print.yaml
restart: hooks/restart.yaml
rms: hooks/rms.yaml
scale: hooks/scale.yaml
shift_seq: hooks/shift_seq.yaml
shift_ts: hooks/shift_ts.yaml
skip_first: hooks/skip_first.yaml
stats: hooks/stats.yaml
ts: hooks/ts.yaml
If no priority is configured, hooks are executed in the order they are configured in the configuration file.

View file

@ -0,0 +1,18 @@
# yaml-language-server: $schema=http://json-schema.org/draft-07/schema
---
allOf:
- type: object
properties:
signals:
type: array
description: A list of signal names to which this hook should be applied
example:
- busA.V
- busB.V
- busC.V
items:
type: string
description: The name of a signal to which this hook should be applied
- $ref: ./hook.yaml

View file

@ -2,12 +2,14 @@
---
type: object
title: Format Object
title: Hook Object
required:
- type
properties:
type:
type: string
discriminator:
propertyName: type
mapping:

View file

@ -0,0 +1,12 @@
# yaml-language-server: $schema=http://json-schema.org/draft-07/schema
---
allOf:
- type: object
properties:
signal:
type: string
description: The name of a signal to which this hook should be applied
example: busA.V
- $ref: ./hook.yaml

View file

@ -1,6 +1,10 @@
# yaml-language-server: $schema=http://json-schema.org/draft-07/schema
---
description: |
Hooks form a pipeline of steps which process, filter or alter sample data.
example: print
oneOf:
- $ref: hook_obj.yaml
- title: Hook Name

View file

@ -1,3 +1,3 @@
allOf:
- $ref: common.yaml
- $ref: ../hook_obj.yaml
- $ref: average.yaml

View file

@ -1,3 +1,3 @@
allOf:
- $ref: common.yaml
- $ref: ../hook_obj.yaml
- $ref: cast.yaml

View file

@ -1,3 +1,3 @@
allOf:
- $ref: common.yaml
- $ref: ../hook_obj.yaml
- $ref: decimate.yaml

View file

@ -1,3 +1,3 @@
allOf:
- $ref: common.yaml
- $ref: ../hook_obj.yaml
- $ref: dp.yaml

View file

@ -1,3 +1,3 @@
allOf:
- $ref: common.yaml
- $ref: ../hook_obj.yaml
- $ref: drop.yaml

View file

@ -1,3 +1,3 @@
allOf:
- $ref: common.yaml
- $ref: ../hook_obj.yaml
- $ref: dump.yaml

View file

@ -1,3 +1,3 @@
allOf:
- $ref: common.yaml
- $ref: ../hook_obj.yaml
- $ref: ebm.yaml

View file

@ -1,3 +1,3 @@
allOf:
- $ref: common.yaml
- $ref: ../hook_obj.yaml
- $ref: fix.yaml

View file

@ -1,3 +1,3 @@
allOf:
- $ref: common.yaml
- $ref: ../hook_obj.yaml
- $ref: gate.yaml

View file

@ -1,3 +1,3 @@
allOf:
- $ref: common.yaml
- $ref: ../hook_obj.yaml
- $ref: jitter_calc.yaml

View file

@ -1,3 +1,3 @@
allOf:
- $ref: common.yaml
- $ref: ../hook_obj.yaml
- $ref: limit_rate.yaml

View file

@ -1,3 +1,3 @@
allOf:
- $ref: common.yaml
- $ref: ../hook_obj.yaml
- $ref: limit_value.yaml

View file

@ -1,3 +1,3 @@
allOf:
- $ref: common.yaml
- $ref: ../hook_obj.yaml
- $ref: lua.yaml

View file

@ -1,3 +1,3 @@
allOf:
- $ref: common.yaml
- $ref: ../hook_obj.yaml
- $ref: ma.yaml

View file

@ -1,3 +1,3 @@
allOf:
- $ref: common.yaml
- $ref: ../hook_obj.yaml
- $ref: pmu_dft.yaml

View file

@ -1,3 +1,3 @@
allOf:
- $ref: common.yaml
- $ref: ../hook_obj.yaml
- $ref: pps_ts.yaml

View file

@ -1,3 +1,3 @@
allOf:
- $ref: common.yaml
- $ref: ../hook_obj.yaml
- $ref: print.yaml

View file

@ -1,3 +1,3 @@
allOf:
- $ref: common.yaml
- $ref: ../hook_obj.yaml
- $ref: restart.yaml

View file

@ -1,5 +1,5 @@
allOf:
- $ref: common.yaml
- $ref: ../hook_obj.yaml
- $ref: rms.yaml
- type: object
required:

View file

@ -1,3 +1,3 @@
allOf:
- $ref: common.yaml
- $ref: ../hook_obj.yaml
- $ref: round.yaml

View file

@ -1,3 +1,3 @@
allOf:
- $ref: common.yaml
- $ref: ../hook_obj.yaml
- $ref: scale.yaml

View file

@ -1,3 +1,3 @@
allOf:
- $ref: common.yaml
- $ref: ../hook_obj.yaml
- $ref: shift_seq.yaml

View file

@ -1,3 +1,3 @@
allOf:
- $ref: common.yaml
- $ref: ../hook_obj.yaml
- $ref: shift_ts.yaml

View file

@ -1,3 +1,3 @@
allOf:
- $ref: common.yaml
- $ref: ../hook_obj.yaml
- $ref: skip_first.yaml

View file

@ -1,3 +1,3 @@
allOf:
- $ref: common.yaml
- $ref: ../hook_obj.yaml
- $ref: stats.yaml

View file

@ -1,3 +1,3 @@
allOf:
- $ref: common.yaml
- $ref: ../hook_obj.yaml
- $ref: ts.yaml

View file

@ -15,5 +15,4 @@ allOf:
- `0` inserts the averaged signal before all other signals in the sample
- `1` inserts the averaged signal after the first signal.
- $ref: common.yaml
- $ref: multi.yaml
- $ref: ../hook_multi.yaml

View file

@ -22,5 +22,4 @@ allOf:
description: The new unit of the casted signal.
example: V
- $ref: common.yaml
- $ref: multi.yaml
- $ref: ../hook_multi.yaml

View file

@ -1,17 +0,0 @@
---
type: object
properties:
enabled:
type: boolean
default: true
description: An optional field which can be used to disable a hook.
priority:
type: integer
default: 99
description: |
The priority of this hook which determines the order in which hooks are executed.
Hooks with a lwoer priority are executed before ones with a higher priority.
If no priority is configured, hooks are executed in the order they are configured in the configuration file.

View file

@ -11,4 +11,4 @@ allOf:
description: The decimation ratio. A value of 4 will skip every, but the 4th sample in a row.
example: 4
- $ref: common.yaml
- $ref: ../hook.yaml

View file

@ -29,5 +29,4 @@ allOf:
type: boolean
default: false
- $ref: common.yaml
- $ref: single.yaml
- $ref: ../hook_single.yaml

View file

@ -2,4 +2,4 @@
---
allOf:
- $ref: common.yaml
- $ref: ../hook.yaml

View file

@ -2,4 +2,4 @@
---
allOf:
- $ref: common.yaml
- $ref: ../hook.yaml

View file

@ -20,4 +20,4 @@ allOf:
items:
type: integer
- $ref: common.yaml
- $ref: ../hook.yaml

View file

@ -2,4 +2,4 @@
---
allOf:
- $ref: common.yaml
- $ref: ../hook.yaml

View file

@ -24,5 +24,4 @@ allOf:
description: The number if samples for which the gate opens when the triggering condition is met. Exclusive with the `duration` setting.
type: number
- $ref: common.yaml
- $ref: single.yaml
- $ref: ../hook_single.yaml

View file

@ -2,4 +2,4 @@
---
allOf:
- $ref: common.yaml
- $ref: ../hook.yaml

View file

@ -18,4 +18,4 @@ allOf:
- received
- origin
- $ref: common.yaml
- $ref: ../hook.yaml

View file

@ -14,5 +14,4 @@ allOf:
description: The largest value which will pass through the hook before getting clipped.
type: number
- $ref: common.yaml
- $ref: multi.yaml
- $ref: ../hook_multi.yaml

View file

@ -77,6 +77,6 @@ allOf:
description: |
An arbitrary Lua expression which will be evaluated and used for the value of the signal.
Note you can access the current sample using the global Lua variable `smp`.
- $ref: ../signal_spec.yaml
# - $ref: ../signal_spec.yaml
- $ref: common.yaml
- $ref: ../hook.yaml

View file

@ -11,5 +11,4 @@ allOf:
default: 0
minimum: 0
- $ref: common.yaml
- $ref: multi.yaml
- $ref: ../hook_multi.yaml

View file

@ -1,15 +0,0 @@
# yaml-language-server: $schema=http://json-schema.org/draft-07/schema
---
type: object
properties:
signals:
type: array
description: A list of signal names to which this hook should be applied
example:
- busA.V
- busB.V
- busC.V
items:
type: string
description: The name of a signal to which this hook should be applied

View file

@ -105,5 +105,4 @@ allOf:
example: 1.0
description: An offset added to the calculated RoCoF. This setting does not really make sense but is available for completeness reasons"
- $ref: common.yaml
- $ref: multi.yaml
- $ref: ../hook_multi.yaml

View file

@ -27,5 +27,4 @@ allOf:
type: integer
default: 10
- $ref: common.yaml
- $ref: single.yaml
- $ref: ../hook_single.yaml

View file

@ -15,4 +15,4 @@ allOf:
default: ''
description: An optional prefix which will be prepended to each line written by this hook to the output
- $ref: common.yaml
- $ref: ../hook.yaml

View file

@ -2,5 +2,5 @@
---
allOf:
- $ref: common.yaml
- $ref: ../hook.yaml

View file

@ -11,5 +11,4 @@ allOf:
default: 0
minimum: 0
- $ref: common.yaml
- $ref: multi.yaml
- $ref: ../hook_multi.yaml

View file

@ -10,5 +10,4 @@ allOf:
example: 4
description: The number of decimal digits to which the singal is rounded.
- $ref: common.yaml
- $ref: multi.yaml
- $ref: ../hook_multi.yaml

View file

@ -15,5 +15,4 @@ allOf:
example: 1e3
description: The gain which is mulitplied to the signal before the offset is added.
- $ref: common.yaml
- $ref: multi.yaml
- $ref: ../hook_multi.yaml

View file

@ -10,4 +10,4 @@ allOf:
type: integer
description: The offset which is added to the sequence number of each processed sample.
- $ref: common.yaml
- $ref: ../hook.yaml

View file

@ -16,4 +16,4 @@ allOf:
type: number
description: The offset in seconds which is added to the timestamp field of each processed sample.
- $ref: common.yaml
- $ref: ../hook.yaml

View file

@ -1,9 +0,0 @@
# yaml-language-server: $schema=http://json-schema.org/draft-07/schema
---
type: object
properties:
signal:
type: string
description: The name of a signal to which this hook should be applied
example: busA.V

View file

@ -11,4 +11,4 @@ allOf:
type: number
description: The number of seconds for which this hook should initially drop samples after a start or restart of the node/path.
- $ref: common.yaml
- $ref: ../hook.yaml

View file

@ -23,4 +23,4 @@ allOf:
description: The file where you want to write the report to. If omitted, stdout (the terminal) will be used.
default: '/dev/stdout'
- $ref: common.yaml
- $ref: ../hook.yaml

View file

@ -2,4 +2,4 @@
---
allOf:
- $ref: common.yaml
- $ref: ../hook.yaml

View file

@ -31,9 +31,6 @@ properties:
type: integer
minimum: 1
signals:
$ref: signal_list.yaml
hooks:
$ref: hook_list.yaml
@ -45,26 +42,5 @@ properties:
vectorize:
type: integer
signals:
type: array
title: List of signals send out to this node
description: |
The outgoing signal list is determined and runtime an must not be provided by the user configuration.
example:
- name: tap_position
type: integer
init: 0
- name: voltage
type: float
unit: V
init: 230.0
items:
$ref: signal_spec.yaml
hooks:
$ref: hook_list.yaml
netem:
$ref: netem.yaml

View file

@ -14,14 +14,16 @@ properties:
For a complete list of supported node-types run `villas node --help`.
In addition to the node settings described in this section, every node type has its own specific settings
discriminator:
propertyName: type
mapping:
api: nodes/_api.yaml
amqp: nodes/_amqp.yaml
api: nodes/_api.yaml
can: nodes/_can.yaml
comedi: nodes/_comedi.yaml
ethercat: nodes/_ethercat.yaml
example: nodes/_example.yaml
exec: nodes/_exec.yaml
file: nodes/_file.yaml
fpga: nodes/_fpga.yaml
@ -38,8 +40,8 @@ discriminator:
redis: nodes/_redis.yaml
rtp: nodes/_rtp.yaml
shmem: nodes/_shmem.yaml
signal.v2: nodes/_signal_v2.yaml
signal: nodes/_signal.yaml
signal.v2: nodes/_signal_v2_node.yaml
signal: nodes/_signal_node.yaml
socket: nodes/_socket.yaml
stats_node: nodes/_stats_node.yaml
temper: nodes/_temper.yaml

View file

@ -0,0 +1,10 @@
# yaml-language-server: $schema=http://json-schema.org/draft-07/schema
---
type: object
properties:
in:
type: object
properties:
signals:
$ref: ./signal_list.yaml

View file

@ -1,3 +1,3 @@
allOf:
- $ref: ../node_obj.yaml
- $ref: _amqp.yaml
- $ref: can.yaml

View file

@ -1,3 +1,3 @@
allOf:
- $ref: ../node_obj.yaml
- $ref: signal_v2.yaml
- $ref: signal_node.yaml

View file

@ -1,3 +1,3 @@
allOf:
- $ref: ../node_obj.yaml
- $ref: signal.yaml
- $ref: signal_v2_node.yaml

View file

@ -45,4 +45,5 @@ allOf:
client_key:
default: "/path/to/client.key"
- $ref: ../node_signals.yaml
- $ref: ../node.yaml

View file

@ -11,4 +11,5 @@ allOf:
curl http://localhost:80/api/v2/universal/api_node_name/config
```
- $ref: ../node_signals.yaml
- $ref: ../node.yaml

View file

@ -14,7 +14,7 @@ allOf:
signals:
type: array
items:
$ref: ./signals/can.yaml
$ref: ./signals/can_signal.yaml
out:
type: object
@ -22,6 +22,6 @@ allOf:
signals:
type: array
items:
$$ref: ./signals/can.yaml
$$ref: ./signals/can_signal.yaml
- $ref: ../node.yaml

View file

@ -18,22 +18,10 @@ allOf:
signals:
type: array
items:
type: object
required:
- channel
- range
- aref
properties:
channel:
type: integer
range:
type: integer
aref:
type: integer
$ref: ./signals/comedi_signal.yaml
rate:
type: integer
- $ref: ../node_signals.yaml
- $ref: ../node.yaml

View file

@ -37,4 +37,5 @@ allOf:
vendor_id:
type: integer
- $ref: ../node_signals.yaml
- $ref: ../node.yaml

View file

@ -18,4 +18,5 @@ allOf:
default: something
description: Another setting
- $ref: ../node_signals.yaml
- $ref: ../node.yaml

View file

@ -45,4 +45,5 @@ allOf:
description: |
A object of key/value pairs of environment variables which should be passed to the sub-process in addition to the parent environment.
- $ref: ../node_signals.yaml
- $ref: ../node.yaml

View file

@ -116,4 +116,5 @@ allOf:
If `out.buffer_size = 0`, no buffer will be generated.
- $ref: ../node_signals.yaml
- $ref: ../node.yaml

View file

@ -7,4 +7,5 @@ allOf:
format:
$ref: ../format_spec.yaml
- $ref: ../node_signals.yaml
- $ref: ../node.yaml

View file

@ -2,59 +2,5 @@
---
allOf:
- type: object
required:
- interface
properties:
in:
type: object
properties:
signals:
type: array
items:
$ref: ./signals/iec61850.yaml
out:
type: object
properties:
required:
- signals
- svid
signals:
type: array
items:
$ref: ./signals/iec61850.yaml
svid:
type: string
confrev:
type: integer
smpmod:
type: string
enum:
- per_nominal_period
- samples_per_second
- seconds_per_sample
smprate:
type: integer
vlan_id:
type: integer
vlan_priority:
type: integer
interface:
type: string
description: Name of network interface to/from which this node will publish/subscribe for SV frames.
app_id:
type: integer
dst_address:
type: string
- $ref: ../node.yaml

View file

@ -3,8 +3,58 @@
allOf:
- type: object
required:
- interface
properties:
format:
$ref: ../format_spec.yaml
in:
type: object
properties:
signals:
type: array
items:
$ref: ./signals/iec61850_signal.yaml
out:
type: object
required:
- signals
- svid
properties:
signals:
type: array
items:
$ref: ./signals/iec61850_signal.yaml
svid:
type: string
confrev:
type: integer
smpmod:
type: string
enum:
- per_nominal_period
- samples_per_second
- seconds_per_sample
smprate:
type: integer
vlan_id:
type: integer
vlan_priority:
type: integer
interface:
type: string
description: Name of network interface to/from which this node will publish/subscribe for SV frames.
app_id:
type: integer
dst_address:
type: string
- $ref: ../node.yaml

View file

@ -192,4 +192,5 @@ allOf:
It turns out that the ideal value in most cases is `out.max_wrs / 2`.
Hence, usually, it is not necessary to explicitly set this value.
- $ref: ../node_signals.yaml
- $ref: ../node.yaml

View file

@ -15,4 +15,5 @@ allOf:
See also: [InfluxDB documentation](https://docs.influxdata.com/influxdb/v0.9/write_protocols/line/#key).
- $ref: ../node_signals.yaml
- $ref: ../node.yaml

View file

@ -75,4 +75,5 @@ allOf:
description: A timeout in seconds for the broker connection.
default: 1.0
- $ref: ../node_signals.yaml
- $ref: ../node.yaml

View file

@ -26,4 +26,5 @@ allOf:
default: auto
description: Specify the synchronization mode of the internal queue.
- $ref: ../node_signals.yaml
- $ref: ../node.yaml

View file

@ -109,4 +109,5 @@ allOf:
For openssl >= 1.0.1, the available options are tlsv1.2, tlsv1.1 and tlsv1, with tlv1.2 as the default.
For openssl < 1.0.1, only tlsv1 is available.
- $ref: ../node_signals.yaml
- $ref: ../node.yaml

View file

@ -27,4 +27,11 @@ allOf:
type: string
format: uri
out:
type: object
properties:
netem:
$ref: ../netem.yaml
- $ref: ../node_signals.yaml
- $ref: ../node.yaml

View file

@ -23,4 +23,5 @@ allOf:
timeout:
type: number
- $ref: ../node_signals.yaml
- $ref: ../node.yaml

View file

@ -13,4 +13,5 @@ allOf:
reply:
type: boolean
- $ref: ../node_signals.yaml
- $ref: ../node.yaml

View file

@ -125,4 +125,5 @@ allOf:
type: string
description: A path to the private key file.
- $ref: ../node_signals.yaml
- $ref: ../node.yaml

View file

@ -53,4 +53,5 @@ allOf:
netem:
$ref: ../netem.yaml
- $ref: ../node_signals.yaml
- $ref: ../node.yaml

View file

@ -52,4 +52,5 @@ allOf:
Must start with a forward slash (/).
The same name should be passed to the external program somehow in its configuration or command-line arguments.
- $ref: ../node_signals.yaml
- $ref: ../node.yaml

View file

@ -101,4 +101,5 @@ allOf:
Especially at high rates, it can be beneficial for performance to set this flag to `false`.
Warnings would namely cause system calls which will slow the node down even more, and thus cause even more missed steps.
- $ref: ../node_signals.yaml
- $ref: ../node.yaml

View file

@ -31,6 +31,6 @@ allOf:
signals:
type: array
items:
$ref: ./signals/generator.yaml
$ref: ./signals/signal_v2_signal.yaml
- $ref: ../node.yaml

View file

@ -1,16 +0,0 @@
# yaml-language-server: $schema=http://json-schema.org/draft-07/schema
---
type: object
properties:
can_id:
type: integer
default: 0
can_size:
type: integer
default: 8
can_offset:
type: integer
default: 0

View file

@ -0,0 +1,19 @@
# yaml-language-server: $schema=http://json-schema.org/draft-07/schema
---
allOf:
- type: object
properties:
can_id:
type: integer
default: 0
can_size:
type: integer
default: 8
can_offset:
type: integer
default: 0
- $ref: ../../signal.yaml

View file

@ -0,0 +1,21 @@
# yaml-language-server: $schema=http://json-schema.org/draft-07/schema
---
allOf:
- type: object
required:
- channel
- range
- aref
properties:
channel:
type: integer
range:
type: integer
aref:
type: integer
- $ref: ../../signal.yaml

View file

@ -1,72 +0,0 @@
# yaml-language-server: $schema=http://json-schema.org/draft-07/schema
---
type: object
required:
- signal
properties:
signal:
type: string
enum:
- random
- sine
- square
- triangle
- ramp
- counter
- constant
- mixed
- pulse
description: |
The type of signal which should be generated:
- `random`: a random walk with normal distributed step sizes will be generated.
- `sine`: a sine signal will be generated.
- `square`: a square / rectangle wave will be generated.
- `triangle`: a triangle wave will be generated.
- `ramp`: the generator will produce a ramp signal in the interval `[ 0, 1 / f ]`.
- `counter`: increasing integer counter is generated.
- `constant`: a constant value generated.
- `mixed`: the signals of of each sample are generated by cycling over all remaining signal types.
- `pulse`: generates pulses with a set frequency, phase and width
amplitude:
type: number
description: The amplitude of the signal when the `signal` setting is one of `sine`, `square` or `triangle`.
default: 1.0
frequency:
type: number
description: The frequency of the signal when the `signal` setting is one of `sine`, `square`, `triangle`,`pulse` or `ramp`.
default: 1.0
phase:
type: number
default: 0.0
description: Tha pase of the signal when the `signal` setting is one of `sine` or `pulse`.
pulse_width:
type: number
default: 1.0
description: The width of the pulse, with respect to the rate
pulse_low:
type: number
default: 0.0
description: The low value of the pulse signal.
pulse_high:
type: number
default: 1.0
description: The high value of the pulse signal.
stddev:
type: number
default: 0.2
description: The standard deviation of the normal distributed steps if the `signal` setting is set to `random`.
offset:
type: number
default: 0.0
description: Adds a constant offset to each of the generated signals.

View file

@ -1,27 +0,0 @@
---
type: object
properties:
iec_type:
type: string
enum:
- boolean
- int8
- int16
- int32
- int64
- int8u
- int16u
- int32u
- int64u
- float32
- float64
- enumerated
- coded_enum
- octet_string
- visible_string
- objectname
- objectreference
- timestamp
- entrytime
- bitstring

View file

@ -0,0 +1,31 @@
# yaml-language-server: $schema=http://json-schema.org/draft-07/schema
---
allOf:
- type: object
properties:
iec_type:
type: string
enum:
- boolean
- int8
- int16
- int32
- int64
- int8u
- int16u
- int32u
- int64u
- float32
- float64
- enumerated
- coded_enum
- octet_string
- visible_string
- objectname
- objectreference
- timestamp
- entrytime
- bitstring
- $ref: ../../signal.yaml

View file

@ -0,0 +1,74 @@
# yaml-language-server: $schema=http://json-schema.org/draft-07/schema
---
allOf:
- type: object
required:
- signal
properties:
signal:
type: string
enum:
- random
- sine
- square
- triangle
- ramp
- counter
- constant
- mixed
- pulse
description: |
The type of signal which should be generated:
- `random`: a random walk with normal distributed step sizes will be generated.
- `sine`: a sine signal will be generated.
- `square`: a square / rectangle wave will be generated.
- `triangle`: a triangle wave will be generated.
- `ramp`: the generator will produce a ramp signal in the interval `[ 0, 1 / f ]`.
- `counter`: increasing integer counter is generated.
- `constant`: a constant value generated.
- `mixed`: the signals of of each sample are generated by cycling over all remaining signal types.
- `pulse`: generates pulses with a set frequency, phase and width
amplitude:
type: number
description: The amplitude of the signal when the `signal` setting is one of `sine`, `square` or `triangle`.
default: 1.0
frequency:
type: number
description: The frequency of the signal when the `signal` setting is one of `sine`, `square`, `triangle`,`pulse` or `ramp`.
default: 1.0
phase:
type: number
default: 0.0
description: Tha pase of the signal when the `signal` setting is one of `sine` or `pulse`.
pulse_width:
type: number
default: 1.0
description: The width of the pulse, with respect to the rate
pulse_low:
type: number
default: 0.0
description: The low value of the pulse signal.
pulse_high:
type: number
default: 1.0
description: The high value of the pulse signal.
stddev:
type: number
default: 0.2
description: The standard deviation of the normal distributed steps if the `signal` setting is set to `random`.
offset:
type: number
default: 0.0
description: Adds a constant offset to each of the generated signals.
- $ref: ../../signal.yaml

View file

@ -0,0 +1,12 @@
# yaml-language-server: $schema=http://json-schema.org/draft-07/schema
---
allOf:
- type: object
required:
- stats
properties:
stats:
type: string
- $ref: ../../signal.yaml

Some files were not shown because too many files have changed in this diff Show more