DOCUMENTATION

Find what you need to build.

Use the standard to describe your data, the implementation docs to run fn-uns, and the guides to connect equipment and plan the work.

Common tasks

Where fn-uns fits

fn-uns is the reference implementation used in these docs. Its components collect machine signals, store current values and history, and serve results to dashboards and other applications. It uses fnkit to package and deploy the software. For a walkthrough of what it provides, explore the implementation.

How the implementation fits together

Capture signals through MQTT, process them into records, then use those records for metrics and analysis. The diagram shows the reference architecture; the architecture reference explains the shared services and deployment model.

CAPTURE PROCESS REPORT cnc-01 ACTIVE status cnc-02 IDLE program cnc-03 ACTIVE tool cnc-04 ALARM MQTT Broker v1.0/enterprise/site1/# Valkey Cache uns:data:* · uns:prev:* · uns:meta:* uns-state Go · state durations uns-stoppage Node · classification uns-productivity Go · production runs uns-log · uns-input · uns-cache PostgreSQL — 5 tables uns-kpi Go · HTTP · read-only 72% Utilisation 94% Avail 48/hr Thru 142m MTBF 8.3m MTTR STOPPAGE PARETO NO_WORK 240m SETUP 120m FAULT 30m GET /uns-kpi?hours=8&machine=cnc-01

Component reference

There are 12 documented components, including the dashboard and optional AI analysis. Start with the sample capture pipeline, then add the components your use case needs. Compare their roles and dependencies.