Introduction

Welcome to UNS Framework, the open-source initiative which presents a technically-driven approach towards MQTT and Unified Namespace (UNS) using YAML files. This project establishes a standard that operates similarly to the definition of Docker or Kubernetes.

The standard's utilisation of YAML not only makes it human-readable but also machine-readable. When a UNS is articulated using the UNS Framework, it facilitates documentation, applications, analytics, security tools, and AI to seamlessly integrate and comprehend your UNS.

This project primarily aims at establishing a standard that leverages the simplicity of YAML for defining UNS and MQTT. The conceived standard is intuitive and user-focused, crafted for easy adoption and implementation.

Analogous to how a Docker or Compose file does not impose restrictions on the operations within a container, It's essential to note that the UNS framework and its standard are not intended to replace existing contributions in this area, such as Sparkplug, OPC/UA Information Models like Umati, or other initiatives like MT Connect. Instead, the UNS Framework is deliberately designed to harmonize with these efforts, focusing on detailing what you have, not what you do or how you do it.
‍
The UNS Framework accommodates templates for equipment and sensors, thereby simplifying the incorporation of equipment into the UNS. These templates, based on the same user-friendly format, endorse efficient integration and reuse.

In addition to the standard, a software implementation that constructs a UNS based on the UNS Framework has also been developed. It's designed to be a practical tool for implementing the framework. The implementation is capable of interpreting the YAML files and creating a structured UNS. It also manages the execution of knative functions, written in various languages and MQTT communication, ensuring seamless data flow between the framework's different components.