Module.yaml

displayName: 'Serial Input'              # Display name for the module that will be displayed in the UI.
moduleName: 'serial-input'               # Module name that will be used to reference the module, and uniquely identify the module and their versions.
description: 'This module allows users to read serial data and send it to next module.'       # 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.
  - 'Ingress'
type: 'Input'      # Module type (Input, Processing, Output) that will be used to group the module in the UI.
image:
  name: 'weevenetwork/serial-input'      # Image name from the docker registry.
  tag: 'v1.0.1'                          # Image tag from the docker registry.
  homepage: 'https://hub.docker.com/r/weevenetwork/serial-input'      # Image homepage from the docker registry.
repository: 'https://github.com/weeve-modules/serial-input'     # 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: Port                          # name of the field to be displayed on the UI.
    key: PORT                           # key to set in the environment variables.
    description: The USB port           # Description/helper text for the field.
    value: '/dev/ttyUSB0'               # 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: []
    dependencies: []
  - name: Baud Rate                     # name of the field to be displayed on the UI.
    key: BAUD_RATE                      # key to set in the environment variables.
    description: The baud rate          # Description/helper text for the field.
    value: '115200'                     # Value to be set in the environment variables.
    type: 'select'                      # 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
     - '1200'
     - '2400'
     - '4800'
     - '9600'
     - '57600'
     - '115200'
    dependencies: []
  - name: Data Bits                   # name of the field to be displayed on the UI.
    key: DATA_BITS                    # key to set in the environment variables.
    description: Number of data bits (optional)    # Description/helper text for the field.
    value: '8'                         # Value to be set in the environment variables.
    type: 'select'                    # 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
     - '5'
     - '6'
     - '7'
     - '8'
    dependencies: []
  - name: Parity                      # name of the field to be displayed on the UI.
    key: PARITY                       # key to set in the environment variables.
    description: Enable parity checking (optional)      # Description/helper text for the field.
    value: 'None'                     # Value to be set in the environment variables.
    type: 'select'                      # Type of the field. Possible values are: ['text', 'select', 'boolean', 'date', 'time', 'dateTime-local', 'number', 'multiple', 'CSV', 'file']
    options:
     - 'None'
     - 'Even'
     - 'Odd'
    dependencies: []
  - name: Stop Bits                 # name of the field to be displayed on the UI.
    key: STOP_BITS                  # key to set in the environment variables.
    description: Number of stop bits (optional)   # Description/helper text for the field.
    value: '1'                         # Value to be set in the environment variables.
    type: 'select'                    # 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
     - '1'
     - '1.5'
     - '2'
    dependencies: []
ports: []
envPorts: []
mounts: []
envMounts: []
devices: []
envDevices:
      - PORT
tags:                                   # Array of tags.
  - 'Serial'
  - 'Input'
  - 'serial-input'
  - '1.0.0'
icon: 'https://icons-020-demo.s3.eu-central-1.amazonaws.com/mi_usb-serial_input.png'    # Icon URL that will be displayed in the UI.