Core Definitions

Here, we delve into the configuration details of key components within the UNS Framework. As you navigate through this information, you'll gain insights into the various components that make up our framework, from the broad scope of the site and area to the minute details of the sensors and functions.

Overview

The UNS Framework configuration is an organised structure that encompasses various elements.

'Site', a physical or logical location. Within each site, we identify 'Areas', which can be any subdivision, physical or logical. These areas contain 'Lines' and 'Cells', representing specific sections, often found in a manufacturing context. 'Equipment', the actual hardware performing tasks within a cell, and 'Sensors' that monitor various equipment parameters.
‍
The framework also includes 'Functions', self-contained blocks of code designed for specific tasks. Information flow is facilitated by 'Producers' and 'Consumers', entities that send and receive information, respectively.

Producers, consumers, and functions are fundamental parts of the system. They contribute significantly to the overall operation and functionality of a UNS.

'Mqtt' is also a part of this configuration. Additionally, any 'Database' used for storing and retrieving information is described.

Definition

Description

UNS

Configuration of the Unified Namespace.

Site

Configuration for the site, a physical or a logical site.

Area

A specific area within the site. This could be a building, a floor, a room, or any other logical or physical partition within the site.

Line

A specific line within an area. In a manufacturing context, this could be a production line.

Cell

A specific cell within a line. This could be a workstation or a unit in the production line.

Equipment

The actual equipment within a cell. This could be a machine, a device, or any other piece of hardware that performs certain tasks.

Sensor

These are the sensors attached to the equipment. They could be used to monitor various parameters of the equipment like temperature, pressure, humidity, etc.

Function

A function is a self-contained block of code designed to perform a specific task.

Producer

This is the configuration for the producer, an entity that sends information.

Consumer

This is the configuration for the consumer, an entity that receives information.

Mqtt

The configuration for the MQTT broker, which is a server that facilitates the transmission of messages in the MQTT protocol.

Database

The description of any database which is used to store and retrieve information.

Template

Reusable template for configuring the equipment and sensors.

Schema with comments

YAML

# Version of the configuration
version: '1.0'

# Unified Namespace (UNS) configuration
uns:
  name: string # Name of the UNS
  timezone: string # Timezone of the UNS
  region: string # Region of the UNS
  topic_structure: 'version/site/area/line/cell/equipment/sensor/data/' # The structure of the MQTT topic
  topic_standard: string # The standard of the MQTT topic
  information_model: string # The information model used

# Site, area, line, cell, equipment and sensor definitions
site:
  - name: string # Name of the site
    id: string # ID of the site
    location: string # Location of the site
    description: string # Description of the site
    area:
      - name: string # Name of the area
        id: string # ID of the area
        location: string # Location of the area
        description: string # Description of the area
        line:
          - name: Line US1 # Name of the line
            id: LIS1 # ID of the line
            location: string # Location of the line
            description: string # Description of the line
            cell:
              - name: string # Name of the cell
                id: string # ID of the cell
                location: string # Location of the cell
                description: string # Description of the cell
                equipment:
                  - id: string # ID of the equipment
                    name: string # Name of the equipment
                    <<: *template_equipment # Reference to the equipment template
                    sensors:
                      - id: string # ID of the sensor
                        <<: *template_sensor # Reference to the sensor template

# Function configuration                       
function:
  - name: string
    url: string
    description: string


# Consumer configuration
consumer:
  - name: string
    endpoint: string
    description: string

# Producer configuration
producer:
  - name: string
    endpoint: string
    description: string

# MQTT broker configuration
mqtt:
  broker:
    host: 'mqtt.broker.com' # Host of the MQTT broker
    port: 1883 # Port of the MQTT broker
    username: 'username' # Username for the MQTT broker
    password: 'password' # Password for the MQTT broker

# Database configuration
database:
  timeseries:
    host: 'timeseries.db.com' # Host of the timeseries database
    port: 5432 # Port of the timeseries database
    username: 'username' # Username for the timeseries database
    password: 'password' # Password for the timeseries database

# Equipment and sensor templates
template_equipment: &template_equipment
  dataops:
    normalization:
      units: string # Units for normalization
      scale: float # Scale for normalization
      offset: float # Offset for normalization
      method: string # Method for normalization
      missing_values: 
        strategy: string # Strategy for handling missing values
        fill_value: string # Fill value for missing values
    transformation:
      aggregation:
        method: string # Method for aggregation
        window: int # Window for aggregation
        stride: int # Stride for aggregation
      calculation:
        operation: string # Operation for calculation
        operands: list # Operands for calculation
      filtering:
        method: string # Method for filtering
        parameters: list # Parameters for filtering
      feature_extraction:
        method: string # Method for feature extraction
        parameters: list # Parameters for feature extraction
      dimensionality_reduction:
        method: string # Method for dimensionality reduction
        number_of_dimensions: int # Number of dimensions for dimensionality reduction
        
template_sensor: &template_sensor
  information_model:
    item: float # Sensor data item

On this page

Overview Definition Schema