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.

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.

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

Definitions

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.
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.
Sensor	Sensors attached to the equipment. Used to monitor parameters like temperature, pressure, humidity, etc.
Function	A self-contained block of code designed to perform a specific task.
Producer	Configuration for the producer, an entity that sends information.
Consumer	Configuration for the consumer, an entity that receives information.
MQTT	Configuration for the MQTT broker, facilitating message transmission.
Database	Description of any database used to store and retrieve information.
Artifact	Static data and reusable templates.

Schema

# 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

site:
  - name: string
    id: string
    area:
      - name: string
        line:
          - name: string
            cell:
              - name: string
                equipment:
                  - name: string
                    sensors:
                      - id: string

mqtt:
  broker:
    host: string
    port: int

database:
  timeseries:
    host: string
    port: int

Previous Introduction Next UNS