-
Notifications
You must be signed in to change notification settings - Fork 1
/
Module.yaml
52 lines (52 loc) · 3.3 KB
/
Module.yaml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
displayName: 'Fluctuation Filter' # Display name for the module that will be displayed in the UI.
moduleName: 'fluctuation-filter' # Module name that will be used to reference the module, and uniquely identify the module and their versions.
description: 'Providing stable data by filtering out spikes.' # Module description that will be displayed in the UI.
versionName: 'v1.0.1' # Module version name that will be used to reference the module version, and uniquely identify the module version with a common name.
isPublic: true # Boolean value that indicates if the module is Public or Private.
categories: # Array of category that will be used to group the module in the UI.
- 'Filter'
type: 'Processing' # Module type (Input, Processing, Output) that will be used to group the module in the UI.
image:
name: 'weevenetwork/fluctuation-filter' # Image name from the docker registry.
tag: 'v1.0.1' # Image tag from the docker registry.
homepage: 'https://hub.docker.com/r/weevenetwork/fluctuation-filter' # Image homepage from the docker registry.
repository: 'https://github.com/weeve-modules/fluctuation-filter' # Repository URL to source code.
envs: # Array of environment variables that will be used to configure the module. Also used to show related fields on the UI.
- name: Input Label # name of the field to be displayed on the UI.
key: INPUT_LABEL # key to set in the environment variables.
description: The field to apply module logic on # Description/helper text for the field.
value: 'temperature' # Value to be set in the environment variables.
type: 'text' # Type of the field. Possible values are: ['text', 'select', 'boolean', 'date', 'time', 'dateTime-local', 'number', 'multiple', 'CSV', 'file']
options: [] # Options for the field if it is a select or multiple select. An array of string options
dependencies: [] # List of dependencies for the field. This field is only displayed if all the dependencies are met. If
- name: Window Size
key: WINDOW_SIZE
description: Number of stable data instances to consider
value: '3'
type: 'number'
options: [] # Options for the field if it is a select or multiple select. An array of string options
dependencies: [] # List of dependencies for the field. This field is only displayed if all the dependencies are met. If
- name: Send On Change
key: SEND_ON_CHANGE
description: Output data only when stable value changes.
value: 'True'
type: 'select'
options:
- 'True'
- 'False'
dependencies: [] # List of dependencies for the field. This field is only displayed if all the dependencies are met. If
ports: []
envPorts: []
mounts: []
envMounts: []
devices: []
envDevices: []
tags: # Array of tags.
- 'Python'
- 'Processing'
- 'Fluctuation'
- 'Filter'
- 'Spike'
- 'stable'
- 'data'
icon: 'https://icons-020-demo.s3.eu-central-1.amazonaws.com/mi_fluctuation_filter_process.png' # Icon URL that will be displayed in the UI.