mirror of
https://git.rwth-aachen.de/acs/public/villas/node/
synced 2025-03-09 00:00:00 +01:00
converted more config docs to OpenAPI
This commit is contained in:
parent
e0242dc544
commit
80f63f26c7
117 changed files with 544 additions and 193 deletions
|
|
@ -1,5 +1,5 @@
|
|||
---
|
||||
# yaml-language-server: $schema=http://json-schema.org/draft-07/schema
|
||||
---
|
||||
|
||||
title: VILLASnode configuration file
|
||||
description: Schema of the VILLASnode configuration file.
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
---
|
||||
# yaml-language-server: $schema=http://json-schema.org/draft-07/schema
|
||||
---
|
||||
|
||||
type: object
|
||||
properties:
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
---
|
||||
# yaml-language-server: $schema=http://json-schema.org/draft-07/schema
|
||||
---
|
||||
|
||||
type: object
|
||||
title: Format Object
|
||||
|
|
|
|||
|
|
@ -1,8 +1,9 @@
|
|||
---
|
||||
# yaml-language-server: $schema=http://json-schema.org/draft-07/schema
|
||||
---
|
||||
|
||||
description: |
|
||||
The payload format which is used to encode and decode exchanged messages.
|
||||
example: villas.human
|
||||
oneOf:
|
||||
- $ref: format_obj.yaml
|
||||
- title: Format Name
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
---
|
||||
# yaml-language-server: $schema=http://json-schema.org/draft-07/schema
|
||||
---
|
||||
|
||||
allOf:
|
||||
- $ref: line.yaml
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
---
|
||||
# yaml-language-server: $schema=http://json-schema.org/draft-07/schema
|
||||
---
|
||||
|
||||
allOf:
|
||||
- type: object
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
---
|
||||
# yaml-language-server: $schema=http://json-schema.org/draft-07/schema
|
||||
---
|
||||
|
||||
allOf:
|
||||
- $ref: raw.yaml
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
---
|
||||
# yaml-language-server: $schema=http://json-schema.org/draft-07/schema
|
||||
---
|
||||
|
||||
allOf:
|
||||
- type: object
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
---
|
||||
# yaml-language-server: $schema=http://json-schema.org/draft-07/schema
|
||||
---
|
||||
|
||||
allOf:
|
||||
- type: object
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
---
|
||||
# yaml-language-server: $schema=http://json-schema.org/draft-07/schema
|
||||
---
|
||||
|
||||
allOf:
|
||||
- type: object
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
---
|
||||
# yaml-language-server: $schema=http://json-schema.org/draft-07/schema
|
||||
---
|
||||
|
||||
allOf:
|
||||
- type: object
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
---
|
||||
# yaml-language-server: $schema=http://json-schema.org/draft-07/schema
|
||||
---
|
||||
|
||||
allOf:
|
||||
- type: object
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
---
|
||||
# yaml-language-server: $schema=http://json-schema.org/draft-07/schema
|
||||
---
|
||||
|
||||
allOf:
|
||||
- type: object
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
---
|
||||
# yaml-language-server: $schema=http://json-schema.org/draft-07/schema
|
||||
---
|
||||
|
||||
allOf:
|
||||
- type: object
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
---
|
||||
# yaml-language-server: $schema=http://json-schema.org/draft-07/schema
|
||||
---
|
||||
|
||||
allOf:
|
||||
- type: object
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
---
|
||||
# yaml-language-server: $schema=http://json-schema.org/draft-07/schema
|
||||
---
|
||||
|
||||
allOf:
|
||||
- type: object
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
---
|
||||
# yaml-language-server: $schema=http://json-schema.org/draft-07/schema
|
||||
---
|
||||
|
||||
allOf:
|
||||
- type: object
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
---
|
||||
# yaml-language-server: $schema=http://json-schema.org/draft-07/schema
|
||||
---
|
||||
|
||||
allOf:
|
||||
- type: object
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
---
|
||||
# yaml-language-server: $schema=http://json-schema.org/draft-07/schema
|
||||
---
|
||||
|
||||
allOf:
|
||||
- type: object
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
---
|
||||
# yaml-language-server: $schema=http://json-schema.org/draft-07/schema
|
||||
---
|
||||
|
||||
allOf:
|
||||
- type: object
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
---
|
||||
# yaml-language-server: $schema=http://json-schema.org/draft-07/schema
|
||||
---
|
||||
|
||||
type: object
|
||||
|
||||
|
|
|
|||
|
|
@ -1,17 +1,9 @@
|
|||
---
|
||||
# yaml-language-server: $schema=http://json-schema.org/draft-07/schema
|
||||
---
|
||||
|
||||
type: object
|
||||
title: Hook
|
||||
|
||||
properties:
|
||||
enabled:
|
||||
type: boolean
|
||||
default: true
|
||||
|
||||
priority:
|
||||
type: integer
|
||||
|
||||
discriminator:
|
||||
propertyName: type
|
||||
mapping:
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
---
|
||||
# yaml-language-server: $schema=http://json-schema.org/draft-07/schema
|
||||
---
|
||||
|
||||
type: array
|
||||
items:
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
---
|
||||
# yaml-language-server: $schema=http://json-schema.org/draft-07/schema
|
||||
---
|
||||
|
||||
type: object
|
||||
title: Format Object
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
---
|
||||
# yaml-language-server: $schema=http://json-schema.org/draft-07/schema
|
||||
---
|
||||
|
||||
oneOf:
|
||||
- $ref: hook_obj.yaml
|
||||
|
|
|
|||
|
|
@ -1,3 +1,3 @@
|
|||
allOf:
|
||||
- $ref: ../hook.yaml
|
||||
- $ref: common.yaml
|
||||
- $ref: average.yaml
|
||||
|
|
|
|||
|
|
@ -1,3 +1,3 @@
|
|||
allOf:
|
||||
- $ref: ../hook.yaml
|
||||
- $ref: common.yaml
|
||||
- $ref: cast.yaml
|
||||
|
|
|
|||
|
|
@ -1,3 +1,3 @@
|
|||
allOf:
|
||||
- $ref: ../hook.yaml
|
||||
- $ref: common.yaml
|
||||
- $ref: decimate.yaml
|
||||
|
|
|
|||
|
|
@ -1,3 +1,3 @@
|
|||
allOf:
|
||||
- $ref: ../hook.yaml
|
||||
- $ref: common.yaml
|
||||
- $ref: dp.yaml
|
||||
|
|
|
|||
|
|
@ -1,3 +1,3 @@
|
|||
allOf:
|
||||
- $ref: ../hook.yaml
|
||||
- $ref: common.yaml
|
||||
- $ref: drop.yaml
|
||||
|
|
|
|||
|
|
@ -1,3 +1,3 @@
|
|||
allOf:
|
||||
- $ref: ../hook.yaml
|
||||
- $ref: common.yaml
|
||||
- $ref: dump.yaml
|
||||
|
|
|
|||
|
|
@ -1,3 +1,3 @@
|
|||
allOf:
|
||||
- $ref: ../hook.yaml
|
||||
- $ref: common.yaml
|
||||
- $ref: ebm.yaml
|
||||
|
|
|
|||
|
|
@ -1,3 +1,3 @@
|
|||
allOf:
|
||||
- $ref: ../hook.yaml
|
||||
- $ref: common.yaml
|
||||
- $ref: fix.yaml
|
||||
|
|
|
|||
|
|
@ -1,3 +1,3 @@
|
|||
allOf:
|
||||
- $ref: ../hook.yaml
|
||||
- $ref: common.yaml
|
||||
- $ref: gate.yaml
|
||||
|
|
|
|||
|
|
@ -1,3 +1,3 @@
|
|||
allOf:
|
||||
- $ref: ../hook.yaml
|
||||
- $ref: common.yaml
|
||||
- $ref: jitter_calc.yaml
|
||||
|
|
|
|||
|
|
@ -1,3 +1,3 @@
|
|||
allOf:
|
||||
- $ref: ../hook.yaml
|
||||
- $ref: common.yaml
|
||||
- $ref: limit_rate.yaml
|
||||
|
|
|
|||
|
|
@ -1,3 +1,3 @@
|
|||
allOf:
|
||||
- $ref: ../hook.yaml
|
||||
- $ref: common.yaml
|
||||
- $ref: limit_value.yaml
|
||||
|
|
|
|||
|
|
@ -1,3 +1,3 @@
|
|||
allOf:
|
||||
- $ref: ../hook.yaml
|
||||
- $ref: common.yaml
|
||||
- $ref: lua.yaml
|
||||
|
|
|
|||
|
|
@ -1,3 +1,3 @@
|
|||
allOf:
|
||||
- $ref: ../hook.yaml
|
||||
- $ref: common.yaml
|
||||
- $ref: ma.yaml
|
||||
|
|
|
|||
|
|
@ -1,3 +1,3 @@
|
|||
allOf:
|
||||
- $ref: ../hook.yaml
|
||||
- $ref: common.yaml
|
||||
- $ref: pmu_dft.yaml
|
||||
|
|
|
|||
|
|
@ -1,3 +1,3 @@
|
|||
allOf:
|
||||
- $ref: ../hook.yaml
|
||||
- $ref: common.yaml
|
||||
- $ref: pps_ts.yaml
|
||||
|
|
|
|||
|
|
@ -1,3 +1,3 @@
|
|||
allOf:
|
||||
- $ref: ../hook.yaml
|
||||
- $ref: common.yaml
|
||||
- $ref: print.yaml
|
||||
|
|
|
|||
|
|
@ -1,3 +1,3 @@
|
|||
allOf:
|
||||
- $ref: ../hook.yaml
|
||||
- $ref: common.yaml
|
||||
- $ref: restart.yaml
|
||||
|
|
|
|||
|
|
@ -1,3 +1,3 @@
|
|||
allOf:
|
||||
- $ref: ../hook.yaml
|
||||
- $ref: common.yaml
|
||||
- $ref: rms.yaml
|
||||
|
|
|
|||
|
|
@ -1,3 +1,3 @@
|
|||
allOf:
|
||||
- $ref: ../hook.yaml
|
||||
- $ref: common.yaml
|
||||
- $ref: scale.yaml
|
||||
|
|
|
|||
|
|
@ -1,3 +1,3 @@
|
|||
allOf:
|
||||
- $ref: ../hook.yaml
|
||||
- $ref: common.yaml
|
||||
- $ref: shift_seq.yaml
|
||||
|
|
|
|||
|
|
@ -1,3 +1,3 @@
|
|||
allOf:
|
||||
- $ref: ../hook.yaml
|
||||
- $ref: common.yaml
|
||||
- $ref: shift_ts.yaml
|
||||
|
|
|
|||
|
|
@ -1,3 +1,3 @@
|
|||
allOf:
|
||||
- $ref: ../hook.yaml
|
||||
- $ref: common.yaml
|
||||
- $ref: skip_first.yaml
|
||||
|
|
|
|||
|
|
@ -1,3 +1,3 @@
|
|||
allOf:
|
||||
- $ref: ../hook.yaml
|
||||
- $ref: common.yaml
|
||||
- $ref: stats.yaml
|
||||
|
|
|
|||
|
|
@ -1,3 +1,3 @@
|
|||
allOf:
|
||||
- $ref: ../hook.yaml
|
||||
- $ref: common.yaml
|
||||
- $ref: ts.yaml
|
||||
|
|
|
|||
|
|
@ -1,7 +1,19 @@
|
|||
---
|
||||
# yaml-language-server: $schema=http://json-schema.org/draft-07/schema
|
||||
---
|
||||
|
||||
allOf:
|
||||
- $ref: ../hook.yaml
|
||||
- type: object
|
||||
properties: {}
|
||||
- $ref: common.yaml
|
||||
- $ref: multi.yaml
|
||||
- type: object
|
||||
required:
|
||||
- offset
|
||||
properties:
|
||||
offset:
|
||||
type: integer
|
||||
description: |
|
||||
The signal offset at which the average signal should be inserted.
|
||||
|
||||
**Examples:**
|
||||
- `0` inserts the averaged signal before all other signals in the sample
|
||||
- `1` inserts the averaged signal after the first signal.
|
||||
|
||||
|
|
|
|||
|
|
@ -1,7 +1,25 @@
|
|||
---
|
||||
# yaml-language-server: $schema=http://json-schema.org/draft-07/schema
|
||||
---
|
||||
|
||||
allOf:
|
||||
- $ref: ../hook.yaml
|
||||
- type: object
|
||||
properties: {}
|
||||
- $ref: common.yaml
|
||||
- $ref: multi.yaml
|
||||
- type: object
|
||||
properties:
|
||||
new_type:
|
||||
type: string
|
||||
enum:
|
||||
- integer
|
||||
- float
|
||||
- boolean
|
||||
- complex
|
||||
description: The type of the casted signal.
|
||||
example: integer
|
||||
new_name:
|
||||
type: string
|
||||
description: The new name of the casted signal.
|
||||
example: BusA.V
|
||||
new_unit:
|
||||
type: string
|
||||
description: The new unit of the casted signal.
|
||||
example: V
|
||||
|
|
|
|||
17
doc/openapi/components/schemas/config/hooks/common.yaml
Normal file
17
doc/openapi/components/schemas/config/hooks/common.yaml
Normal file
|
|
@ -0,0 +1,17 @@
|
|||
---
|
||||
|
||||
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.
|
||||
|
|
@ -1,10 +1,14 @@
|
|||
---
|
||||
# yaml-language-server: $schema=http://json-schema.org/draft-07/schema
|
||||
---
|
||||
|
||||
allOf:
|
||||
- $ref: ../hook.yaml
|
||||
- $ref: common.yaml
|
||||
- type: object
|
||||
required:
|
||||
- ratio
|
||||
properties:
|
||||
ratio:
|
||||
type: integer
|
||||
description: The decimation ratio. A value of 4 will skip every, but the 4th sample in a row.
|
||||
example: 4
|
||||
|
||||
|
|
@ -1,7 +1,33 @@
|
|||
---
|
||||
# yaml-language-server: $schema=http://json-schema.org/draft-07/schema
|
||||
---
|
||||
|
||||
allOf:
|
||||
- $ref: ../hook.yaml
|
||||
- type: object
|
||||
properties: {}
|
||||
- $ref: common.yaml
|
||||
- $ref: single.yaml
|
||||
- type: object
|
||||
required:
|
||||
- f0
|
||||
- harmonics
|
||||
properties:
|
||||
f0:
|
||||
description: The fundamental frequency.
|
||||
example: 50
|
||||
type: number
|
||||
dt:
|
||||
description: The timestep of the input samples. Exclusive with `rate` setting.
|
||||
default: 50e-6
|
||||
type: number
|
||||
rate:
|
||||
type: number
|
||||
description: The rate of the input samples. Exclusive with `dt` setting.
|
||||
harmonics:
|
||||
type: object
|
||||
description: A list of selected harmonics which should be calculated.
|
||||
example: [0, 1, 3, 5 ]
|
||||
items:
|
||||
type: integer
|
||||
inverse:
|
||||
description: Enable the calucation of the inverse transform.
|
||||
type: boolean
|
||||
default: false
|
||||
|
||||
|
|
|
|||
|
|
@ -1,7 +1,6 @@
|
|||
---
|
||||
# yaml-language-server: $schema=http://json-schema.org/draft-07/schema
|
||||
---
|
||||
|
||||
allOf:
|
||||
- $ref: ../hook.yaml
|
||||
- type: object
|
||||
properties: {}
|
||||
- $ref: common.yaml
|
||||
|
||||
|
|
|
|||
|
|
@ -1,7 +1,6 @@
|
|||
---
|
||||
# yaml-language-server: $schema=http://json-schema.org/draft-07/schema
|
||||
---
|
||||
|
||||
allOf:
|
||||
- $ref: ../hook.yaml
|
||||
- type: object
|
||||
properties: {}
|
||||
- $ref: common.yaml
|
||||
|
||||
|
|
|
|||
|
|
@ -1,7 +1,22 @@
|
|||
---
|
||||
# yaml-language-server: $schema=http://json-schema.org/draft-07/schema
|
||||
---
|
||||
|
||||
allOf:
|
||||
- $ref: ../hook.yaml
|
||||
- type: object
|
||||
properties: {}
|
||||
- $ref: common.yaml
|
||||
- type: object
|
||||
required:
|
||||
- phases
|
||||
properties:
|
||||
phases:
|
||||
description: Signal indeces for voltage & current values for each phase.
|
||||
example:
|
||||
- [0, 1]
|
||||
- [2, 3]
|
||||
- [4, 5]
|
||||
type: array
|
||||
items:
|
||||
type: array
|
||||
minItems: 2
|
||||
maxItems: 2
|
||||
items:
|
||||
type: integer
|
||||
|
|
|
|||
|
|
@ -1,7 +1,5 @@
|
|||
---
|
||||
# yaml-language-server: $schema=http://json-schema.org/draft-07/schema
|
||||
---
|
||||
|
||||
allOf:
|
||||
- $ref: ../hook.yaml
|
||||
- type: object
|
||||
properties: {}
|
||||
- $ref: common.yaml
|
||||
|
|
|
|||
|
|
@ -1,7 +1,27 @@
|
|||
---
|
||||
# yaml-language-server: $schema=http://json-schema.org/draft-07/schema
|
||||
---
|
||||
|
||||
allOf:
|
||||
- $ref: ../hook.yaml
|
||||
- type: object
|
||||
properties: {}
|
||||
- $ref: common.yaml
|
||||
- $ref: single.yaml
|
||||
- type: object
|
||||
properties:
|
||||
mode:
|
||||
description: The triggering condition at which the gate opens.
|
||||
type: string
|
||||
default: rising_edge
|
||||
enum:
|
||||
- above
|
||||
- below
|
||||
- rising_edge
|
||||
- falling_edge
|
||||
threshold:
|
||||
default: 0.5
|
||||
description: The threshold the signal needs to overcome before the gate opens.
|
||||
type: number
|
||||
duration:
|
||||
description: The number of seconds for which the gate opens when the triggering condition is met. Exclusive with the `samples` setting.
|
||||
type: number
|
||||
samples:
|
||||
description: The number if samples for which the gate opens when the triggering condition is met. Exclusive with the `duration` setting.
|
||||
type: number
|
||||
|
|
|
|||
|
|
@ -1,7 +1,6 @@
|
|||
---
|
||||
# yaml-language-server: $schema=http://json-schema.org/draft-07/schema
|
||||
---
|
||||
|
||||
allOf:
|
||||
- $ref: ../hook.yaml
|
||||
- type: object
|
||||
properties: {}
|
||||
- $ref: common.yaml
|
||||
|
||||
|
|
|
|||
|
|
@ -1,7 +1,20 @@
|
|||
---
|
||||
# yaml-language-server: $schema=http://json-schema.org/draft-07/schema
|
||||
---
|
||||
|
||||
allOf:
|
||||
- $ref: ../hook.yaml
|
||||
- type: object
|
||||
properties: {}
|
||||
- $ref: common.yaml
|
||||
- type: object
|
||||
required:
|
||||
- rate
|
||||
properties:
|
||||
rate:
|
||||
type: number
|
||||
description: The maximum sample rate in `1/s` before this hook will drop samples.
|
||||
mode:
|
||||
type: string
|
||||
default: local
|
||||
description: Timestamp which should be used for rate estimation.
|
||||
enum:
|
||||
- local
|
||||
- received
|
||||
- origin
|
||||
|
|
|
|||
|
|
@ -1,7 +1,17 @@
|
|||
---
|
||||
# yaml-language-server: $schema=http://json-schema.org/draft-07/schema
|
||||
---
|
||||
|
||||
allOf:
|
||||
- $ref: ../hook.yaml
|
||||
- type: object
|
||||
properties: {}
|
||||
- $ref: common.yaml
|
||||
- $ref: multi.yaml
|
||||
- type: object
|
||||
required:
|
||||
- min
|
||||
- max
|
||||
properties:
|
||||
min:
|
||||
description: The smallest value which will pass through the hook before getting clipped.
|
||||
type: number
|
||||
max:
|
||||
description: The largest value which will pass through the hook before getting clipped.
|
||||
type: number
|
||||
|
|
|
|||
|
|
@ -1,7 +1,81 @@
|
|||
---
|
||||
# yaml-language-server: $schema=http://json-schema.org/draft-07/schema
|
||||
---
|
||||
|
||||
allOf:
|
||||
- $ref: ../hook.yaml
|
||||
- type: object
|
||||
properties: {}
|
||||
- $ref: common.yaml
|
||||
- type: object
|
||||
additionalProperties:
|
||||
description: |
|
||||
The Lua hook will pass the complete hook configuration to the `prepare()` Lua function.
|
||||
So you can add arbitrary settings here which are then consumed by the Lua script.
|
||||
|
||||
properties:
|
||||
use_names:
|
||||
type: boolean
|
||||
default: true
|
||||
description: Enables or disables the use of signal names in the `process()` Lua function. If disabled, numeric indices will be used.
|
||||
|
||||
script:
|
||||
type: string
|
||||
description: |
|
||||
Provide the path to a Lua script containing functions for the individual hook points.
|
||||
Define some or all of the following functions in your Lua script:
|
||||
|
||||
#### `prepare(cfg)`
|
||||
|
||||
Called during initialization with a Lua table which contains the full hook configuration.
|
||||
|
||||
#### `start()`
|
||||
|
||||
Called when the associated node or path is started
|
||||
|
||||
#### `stop()`
|
||||
|
||||
Called when the associated node or path is stopped
|
||||
|
||||
#### `restart()`
|
||||
|
||||
Called when the associated node or path is restarted.
|
||||
Falls back to `stop()` + `start()` if absent.
|
||||
|
||||
#### `process(smp)`
|
||||
|
||||
Called for each sample which is being processed.
|
||||
The sample is passed as a Lua table with the following fields:
|
||||
|
||||
- `sequence` The sequence number of the sample.
|
||||
- `flags` The flags field of the sample.
|
||||
- `ts_origin` The origin timesamp as a Lua table containing the following keys:
|
||||
| Index | Description |
|
||||
|:-- |:-- |
|
||||
| 0 | seconds |
|
||||
| 1 | nanoseconds |
|
||||
|
||||
- `ts_received` The receive timestamp a Lua table containing the following keys:
|
||||
| Index | Description |
|
||||
|:-- |:-- |
|
||||
| 0 | seconds |
|
||||
| 1 | nanoseconds |
|
||||
|
||||
- `data` The sample data as a Lua table container either numeric indices or the signal names depending on the 'use_names' option of the hook.
|
||||
|
||||
#### `periodic()`
|
||||
|
||||
Called periodicalled with the rate of @ref node-config-stats.
|
||||
|
||||
signals:
|
||||
description: |
|
||||
A definition of signals which this hook will emit.
|
||||
Here a list of signal definitions like @ref node-config-node-signals is excpected.
|
||||
type: array
|
||||
items:
|
||||
allOf:
|
||||
- type: object
|
||||
properties:
|
||||
expression:
|
||||
type: string
|
||||
example: "math.sqrt(smp.data[0] ^ 2 + smp.data[1] ^ 2)"
|
||||
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: ../signaldef.yaml
|
||||
|
|
|
|||
|
|
@ -1,7 +1,14 @@
|
|||
---
|
||||
# yaml-language-server: $schema=http://json-schema.org/draft-07/schema
|
||||
---
|
||||
|
||||
allOf:
|
||||
- $ref: ../hook.yaml
|
||||
- type: object
|
||||
properties: {}
|
||||
- $ref: common.yaml
|
||||
- $ref: multi.yaml
|
||||
- type: object
|
||||
properties:
|
||||
window_size:
|
||||
type: integer
|
||||
description: The size of the window (number of samples) which should be used for the moving average filter.
|
||||
example: 100
|
||||
default: 0
|
||||
minimum: 0
|
||||
|
|
|
|||
15
doc/openapi/components/schemas/config/hooks/multi.yaml
Normal file
15
doc/openapi/components/schemas/config/hooks/multi.yaml
Normal file
|
|
@ -0,0 +1,15 @@
|
|||
# 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
|
||||
|
|
@ -1,7 +1,46 @@
|
|||
---
|
||||
# yaml-language-server: $schema=http://json-schema.org/draft-07/schema
|
||||
---
|
||||
|
||||
allOf:
|
||||
- $ref: ../hook.yaml
|
||||
- type: object
|
||||
properties: {}
|
||||
- $ref: common.yaml
|
||||
- $ref: multi.yaml
|
||||
- type: object
|
||||
properties:
|
||||
sample_rate:
|
||||
type: integer
|
||||
start_freqency:
|
||||
type: number
|
||||
end_freqency:
|
||||
type: number
|
||||
frequency_resolution:
|
||||
type: number
|
||||
dft_rate:
|
||||
type: integer
|
||||
window_size_factor:
|
||||
type: integer
|
||||
window_type:
|
||||
type: string
|
||||
enum:
|
||||
- flattop
|
||||
- hamming
|
||||
- hann
|
||||
padding_type:
|
||||
type: string
|
||||
enum:
|
||||
- zero
|
||||
- signal_repeat
|
||||
frequency_estimate_type:
|
||||
type: string
|
||||
enum:
|
||||
- quadratic
|
||||
sync:
|
||||
type: boolean
|
||||
pps_index:
|
||||
type: integer
|
||||
angle_unit:
|
||||
type: string
|
||||
enum:
|
||||
- rad
|
||||
- degree
|
||||
add_channel_name:
|
||||
type: boolean
|
||||
|
|
|
|||
|
|
@ -1,7 +1,27 @@
|
|||
---
|
||||
# yaml-language-server: $schema=http://json-schema.org/draft-07/schema
|
||||
---
|
||||
|
||||
allOf:
|
||||
- $ref: ../hook.yaml
|
||||
- type: object
|
||||
properties: {}
|
||||
- $ref: common.yaml
|
||||
- $ref: single.yaml
|
||||
- type: object
|
||||
required:
|
||||
- expected_smp_rate
|
||||
properties:
|
||||
mode:
|
||||
type: string
|
||||
enum:
|
||||
- simple
|
||||
- horizon
|
||||
default: simple
|
||||
threshold:
|
||||
type: number
|
||||
default: 1.5
|
||||
expected_smp_rate:
|
||||
type: integer
|
||||
horizon_estimation:
|
||||
type: integer
|
||||
default: 10
|
||||
horizon_compensation:
|
||||
type: integer
|
||||
default: 10
|
||||
|
|
|
|||
|
|
@ -1,11 +1,18 @@
|
|||
---
|
||||
# yaml-language-server: $schema=http://json-schema.org/draft-07/schema
|
||||
---
|
||||
|
||||
allOf:
|
||||
- $ref: ../hook.yaml
|
||||
- $ref: common.yaml
|
||||
- type: object
|
||||
properties:
|
||||
output:
|
||||
type: string
|
||||
default: '/dev/stdout'
|
||||
description: An optional path to a file to which the samples processed by this hook will be written to.
|
||||
format:
|
||||
$ref: ../format_spec.yaml
|
||||
prefix:
|
||||
type: string
|
||||
default: ''
|
||||
description: An optional prefix which will be prepended to each line written by this hook to the output
|
||||
|
||||
|
|
@ -1,7 +1,6 @@
|
|||
---
|
||||
# yaml-language-server: $schema=http://json-schema.org/draft-07/schema
|
||||
---
|
||||
|
||||
allOf:
|
||||
- $ref: ../hook.yaml
|
||||
- type: object
|
||||
properties: {}
|
||||
- $ref: common.yaml
|
||||
|
||||
|
|
|
|||
|
|
@ -1,7 +1,14 @@
|
|||
---
|
||||
# yaml-language-server: $schema=http://json-schema.org/draft-07/schema
|
||||
---
|
||||
|
||||
allOf:
|
||||
- $ref: ../hook.yaml
|
||||
- type: object
|
||||
properties: {}
|
||||
- $ref: common.yaml
|
||||
- $ref: multi.yaml
|
||||
- type: object
|
||||
properties:
|
||||
window_size:
|
||||
type: integer
|
||||
description: The size of the window (number of samples) which should be used for the moving average filter.
|
||||
example: 100
|
||||
default: 0
|
||||
minimum: 0
|
||||
|
|
|
|||
|
|
@ -1,7 +1,20 @@
|
|||
---
|
||||
# yaml-language-server: $schema=http://json-schema.org/draft-07/schema
|
||||
---
|
||||
|
||||
allOf:
|
||||
- $ref: ../hook.yaml
|
||||
- type: object
|
||||
properties: {}
|
||||
- $ref: common.yaml
|
||||
- $ref: multi.yaml
|
||||
- type: object
|
||||
properties:
|
||||
offset:
|
||||
type: number
|
||||
default: 0.0
|
||||
example: 100.5
|
||||
description: The offset which is added to the signal after gain.
|
||||
gain:
|
||||
type: number
|
||||
default: 1.0
|
||||
example: 1e3
|
||||
description: The gain which is mulitplied to the signal before the offset is added.
|
||||
|
||||
|
||||
|
|
@ -1,7 +1,13 @@
|
|||
---
|
||||
# yaml-language-server: $schema=http://json-schema.org/draft-07/schema
|
||||
---
|
||||
|
||||
allOf:
|
||||
- $ref: ../hook.yaml
|
||||
- type: object
|
||||
properties: {}
|
||||
- $ref: common.yaml
|
||||
- type: object
|
||||
required:
|
||||
- offset
|
||||
properties:
|
||||
offset:
|
||||
type: integer
|
||||
description: The offset which is added to the sequence number of each processed sample.
|
||||
|
||||
|
|
|
|||
|
|
@ -1,7 +1,18 @@
|
|||
---
|
||||
# yaml-language-server: $schema=http://json-schema.org/draft-07/schema
|
||||
---
|
||||
|
||||
allOf:
|
||||
- $ref: ../hook.yaml
|
||||
- type: object
|
||||
properties: {}
|
||||
- $ref: common.yaml
|
||||
- type: object
|
||||
required:
|
||||
- offset
|
||||
properties:
|
||||
mode:
|
||||
type: string
|
||||
enum:
|
||||
- origin
|
||||
- ts_received
|
||||
description: The timestamp field which should be adjusted by the `offset` setting.
|
||||
offset:
|
||||
type: number
|
||||
description: The offset in seconds which is added to the timestamp field of each processed sample.
|
||||
|
|
|
|||
9
doc/openapi/components/schemas/config/hooks/single.yaml
Normal file
9
doc/openapi/components/schemas/config/hooks/single.yaml
Normal file
|
|
@ -0,0 +1,9 @@
|
|||
# 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
|
||||
|
|
@ -1,7 +1,13 @@
|
|||
---
|
||||
# yaml-language-server: $schema=http://json-schema.org/draft-07/schema
|
||||
---
|
||||
|
||||
allOf:
|
||||
- $ref: ../hook.yaml
|
||||
- type: object
|
||||
properties: {}
|
||||
- $ref: common.yaml
|
||||
- type: object
|
||||
properties:
|
||||
samples:
|
||||
type: integer
|
||||
description: The number of samples which should be dropped by this hook after a start or restart of the node/path.
|
||||
seconds:
|
||||
type: number
|
||||
description: The number of seconds for which this hook should initially drop samples after a start or restart of the node/path.
|
||||
|
|
|
|||
|
|
@ -1,7 +1,25 @@
|
|||
---
|
||||
# yaml-language-server: $schema=http://json-schema.org/draft-07/schema
|
||||
---
|
||||
|
||||
allOf:
|
||||
- $ref: ../hook.yaml
|
||||
- type: object
|
||||
properties: {}
|
||||
- $ref: common.yaml
|
||||
- type: object
|
||||
properties:
|
||||
format:
|
||||
$ref: ../format_spec.yaml
|
||||
buckets:
|
||||
type: integer
|
||||
default: 20
|
||||
description: The number of buckets which should be used for the underlying histograms.
|
||||
warmup:
|
||||
type: integer
|
||||
default: 500
|
||||
description: Use the first `warmup` samples to estimate the bucket range of the underlying histograms.
|
||||
verbose:
|
||||
type: boolean
|
||||
default: false
|
||||
description: Include full dumps of the histogram buckets into the output.
|
||||
output:
|
||||
type: string
|
||||
description: The file where you want to write the report to. If omitted, stdout (the terminal) will be used.
|
||||
default: '/dev/stdout'
|
||||
|
|
|
|||
|
|
@ -1,7 +1,5 @@
|
|||
---
|
||||
# yaml-language-server: $schema=http://json-schema.org/draft-07/schema
|
||||
---
|
||||
|
||||
allOf:
|
||||
- $ref: ../hook.yaml
|
||||
- type: object
|
||||
properties: {}
|
||||
- $ref: common.yaml
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
---
|
||||
# yaml-language-server: $schema=http://json-schema.org/draft-07/schema
|
||||
---
|
||||
|
||||
type: object
|
||||
properties:
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
---
|
||||
# yaml-language-server: $schema=http://json-schema.org/draft-07/schema
|
||||
---
|
||||
|
||||
type: object
|
||||
title: Logging configuration
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
---
|
||||
# yaml-language-server: $schema=http://json-schema.org/draft-07/schema
|
||||
---
|
||||
|
||||
type: object
|
||||
title: Node
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
---
|
||||
# yaml-language-server: $schema=http://json-schema.org/draft-07/schema
|
||||
---
|
||||
|
||||
type: object
|
||||
title: Format Object
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
---
|
||||
# yaml-language-server: $schema=http://json-schema.org/draft-07/schema
|
||||
---
|
||||
|
||||
title: Advanced Messaging & Queuing Protocol (AMQP)
|
||||
allOf:
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
---
|
||||
# yaml-language-server: $schema=http://json-schema.org/draft-07/schema
|
||||
---
|
||||
|
||||
allOf:
|
||||
- type: object
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
---
|
||||
# yaml-language-server: $schema=http://json-schema.org/draft-07/schema
|
||||
---
|
||||
|
||||
allOf:
|
||||
- type: object
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
---
|
||||
# yaml-language-server: $schema=http://json-schema.org/draft-07/schema
|
||||
---
|
||||
|
||||
allOf:
|
||||
- $ref: ../node.yaml
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
---
|
||||
# yaml-language-server: $schema=http://json-schema.org/draft-07/schema
|
||||
---
|
||||
|
||||
allOf:
|
||||
- type: object
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
---
|
||||
# yaml-language-server: $schema=http://json-schema.org/draft-07/schema
|
||||
---
|
||||
|
||||
allOf:
|
||||
- type: object
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
---
|
||||
# yaml-language-server: $schema=http://json-schema.org/draft-07/schema
|
||||
---
|
||||
|
||||
allOf:
|
||||
- type: object
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
---
|
||||
# yaml-language-server: $schema=http://json-schema.org/draft-07/schema
|
||||
---
|
||||
|
||||
allOf:
|
||||
- type: object
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
---
|
||||
# yaml-language-server: $schema=http://json-schema.org/draft-07/schema
|
||||
---
|
||||
|
||||
allOf:
|
||||
- type: object
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
---
|
||||
# yaml-language-server: $schema=http://json-schema.org/draft-07/schema
|
||||
---
|
||||
|
||||
allOf:
|
||||
- type: object
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
---
|
||||
# yaml-language-server: $schema=http://json-schema.org/draft-07/schema
|
||||
---
|
||||
|
||||
allOf:
|
||||
- type: object
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
---
|
||||
# yaml-language-server: $schema=http://json-schema.org/draft-07/schema
|
||||
---
|
||||
|
||||
allOf:
|
||||
- type: object
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
---
|
||||
# yaml-language-server: $schema=http://json-schema.org/draft-07/schema
|
||||
---
|
||||
|
||||
allOf:
|
||||
- type: object
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
---
|
||||
# yaml-language-server: $schema=http://json-schema.org/draft-07/schema
|
||||
---
|
||||
|
||||
allOf:
|
||||
- type: object
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
---
|
||||
# yaml-language-server: $schema=http://json-schema.org/draft-07/schema
|
||||
---
|
||||
|
||||
allOf:
|
||||
- type: object
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
---
|
||||
# yaml-language-server: $schema=http://json-schema.org/draft-07/schema
|
||||
---
|
||||
|
||||
allOf:
|
||||
- type: object
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
---
|
||||
# yaml-language-server: $schema=http://json-schema.org/draft-07/schema
|
||||
---
|
||||
|
||||
allOf:
|
||||
- type: object
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
---
|
||||
# yaml-language-server: $schema=http://json-schema.org/draft-07/schema
|
||||
---
|
||||
|
||||
allOf:
|
||||
- type: object
|
||||
|
|
|
|||
Some files were not shown because too many files have changed in this diff Show more
Loading…
Add table
Reference in a new issue