Guide
Release Notes
Unreleased - the first version
Smart.Industrial will be released as its own npm package, smart-industrial, and NuGet package, Smart.Blazor.Industrial. Neither is published yet. The first version will contain the following.
Components (54)
- Alarms and status: Alarm Grid (ISA-18.2 alarm summary on the Table), Alarm Banner, Annunciator (ISA-18.1 tile wall), Status Tile, Multi-State Indicator.
- Operator screens and process graphics: HMI Shell (ISA-101 display frame), Faceplate (control loop), Device Control (motor, pump and valve faceplate), Mimic (process diagram canvas), Mimic Symbol (33 ISA-5.1 shapes, and a template for the application's own), Pipe.
- Production floor: Stack Light, State Timeline, Shift Log (the shift's entries, searched and exported), Downtime Log (the line's stops and their reasons).
- Recipes, orders and scheduled jobs: Recipe Panel, Job Panel, Order Queue.
- Maintenance and sites: Asset Card, Site Map.
- Safety and interlocks: Cause and Effect Matrix, Permissive.
- Trends and signals: Trend (historian, with model bands and anomaly markers), Strip Chart, Scope, Spectrum, Control Chart (seven Shewhart chart types with Nelson and Western Electric rules), Comparison Chart.
- Test and measurement: Waveform Graph (waveform and XY records, stacked scales, cursors, annotations, zoom, CSV export), Intensity Graph (matrix as colour, graph and chart modes, colour maps and stops), Digital Waveform (lines and buses, logic analyser view), Bode Plot (transfer functions and measured responses, gain and phase margins), Polar Plot (orbits, antenna patterns, round-out), Octave Bands (IEC 61260 bands, IEC 61672 A and C weighting, limits), Resource Picker (VISA and DAQ resources, parsed).
- Model outputs: Anomaly Heatmap, Root Cause Tree.
- Instrument readouts and controls: Seven Segment, Bar Graph, Knob, Bit Field, Numeric Keypad, Momentary Button, Selector Switch (segmented, rotary, toggle, rocker and slide), Jog Panel, Panel Meter, Thermometer, Touch Keyboard.
- Machine state, sequences and sessions: State Machine (PackML and ISA-88 models built in), Sequence Editor, Terminal.
- Electronic records: E-Signature, Signature Block, Audit Trail (21 CFR Part 11).
The components that act on a plant follow one convention: they raise a request event and do not change their own value; the application writes to the plant and sets the value from what the plant reports. The input controls (knob, bar graph, bit field, thermometer, panel meter, numeric keypad) take the operator's value themselves and raise change.
Modules
- Connect - data sessions over WebSocket, SSE, HTTP polling, a simulator or a custom transport; bindings with quality, staleness and deadband; OPC UA and Sparkplug payload mappers.
- Units - conversion for 25 quantities, including gauge and absolute pressure and temperature differences; unit systems applied through bindings.
- Audit - a hash-chained audit trail, ISO timestamps with offset, record hashes, signature verification, CSV and JSON export.
- AI - context reduction for an operator assistant: alarm flood summaries, trend descriptions, test run reports.
- Maths - DSP (FFT, windows, spectrum, PSD), SPC (control limits, run rules, capability) and series reduction, as plain functions.
Frameworks and packaging
- A bundle, one ES module per component, and shadow-DOM builds under source/components/.
- TypeScript definitions for every component and a union file.
- Angular wrappers (smart-industrial/angular) and React wrappers (smart-industrial/react) inside the package; Vue 3 uses the elements directly.
- Smart.Blazor.Industrial for Blazor Server and WebAssembly on .NET 6 and later, with typed event details.
- Locale packs for German, French, Spanish and Chinese, as plain scripts and as ES modules.
- Two ISA-101 themes, light and dark, on the Smart UI theme system.
Documentation and demos
- A demo per component and 31 complete operator screens, including a DAQ acquisition, a vibration analysis and a logic analyser.
- Getting started pages per component for JavaScript, Angular, React, Vue and Blazor; an accessibility page and a CSS styling page per component; the API reference per framework.
- Guides for getting started, connectivity, units, localization, themes, frameworks, electronic records, engineering maths, AI analysis, performance, support and front panel users.
- Conformance statements for WCAG 2.2 AA, ISA-101, ISA-18.2, 21 CFR Part 11 and GAMP 5, IEC 61511 / ISA-84, ISA-88 and PackML, ISO 10816-3 and IEC 61850; a security statement with an IEC 62443 mapping; a performance page with measured figures.
- SECURITY.md and a CycloneDX SBOM in the package.
Known limitations
- The Content Security Policy needs style-src 'unsafe-inline'; see the security statement.
- The mimic diagram does not convey its topology to assistive technology; see the WCAG report.
- Two Smart UI suite components used by the screens (gauge, tree) report automated accessibility findings, recorded in the WCAG report.
- In the light theme the warning and advisory fills are below 3:1 against the white panel; see the WCAG report.
- The React wrappers need React 18 or later, and a Vue template listener on an event with capitals in its name needs Vue 3.2.38 or later; see the frameworks guide.
Each version will list its changes here. The version number will follow Smart UI; a published version is never changed in place.