Machine state, sequences and sessions
State Machine <smart-state-machine>
StateMachine displays the state model of a machine as a diagram with the current state highlighted, the time in the state, the unit mode and the commands that are available from the current state.
Getting Started with State Machine in Blazor
Smart.Blazor.Industrial targets .NET 6 and later, for Blazor Server and Blazor WebAssembly.
The State Machine component is part of the Smart.Blazor.Industrial NuGet package, which contains all 54 Industrial components as Razor components. The package includes the Smart.Industrial runtime in its wwwroot and does not depend on Smart.Blazor.
Quick start
- Install the package:
dotnet add package Smart.Blazor.Industrial
- Add the styles and the runtime to the application page (
App.razor,_Host.cshtmlorindex.html):
<link rel="stylesheet" href="_content/Smart.Blazor.Industrial/css/smart.default.css" /> <link rel="stylesheet" href="_content/Smart.Blazor.Industrial/css/smart.industrial-elements.css" /> <link rel="stylesheet" href="_content/Smart.Blazor.Industrial/css/smart.industrial.css" /> <script src="_content/Smart.Blazor.Industrial/js/smart.blazor.js"></script> <script src="_content/Smart.Blazor.Industrial/js/smart.industrial.js"></script>
- Register the services in
Program.csand add the namespace to_Imports.razor:
using Smart.Blazor.Industrial; builder.Services.AddSmartIndustrial();
@using Smart.Blazor.Industrial
- Use the component in a page. In a Blazor Web App (.NET 8 and later) the page needs an interactive render mode:
@rendermode InteractiveServeras below,InteractiveWebAssemblyorInteractiveAuto, or one render mode for the whole app on<Routes @rendermode="InteractiveServer" />inApp.razor. Without it the component renders as an empty box and its parameters and events do not arrive. On .NET 6 and 7 leave the@rendermodeline out. The parameters are the component's properties in PascalCase; the events areEventCallbacks namedOn<EventName>. This is the first element of the demo:
@page "/" @* .NET 8 and later: an interactive render mode, on the page or for the whole app *@ @rendermode InteractiveServer <StateMachine Model="StateMachineModel.Packml" State="Stopped" Label="Filler F-01" Mode="Production" OnCommandRequest="OnCommandRequest" /> @code { void OnCommandRequest(Event ev) { // Event is a Dictionary<string, dynamic>; "Detail" is the typed detail of the event. StateMachineCommandRequestEventDetail detail = ev["Detail"]; // Write the request to the plant here, then set the parameter from the value the plant reports. } } - The component raises
OnCommandRequestas a request and does not change its own value: the handler writes to the plant, and the parameter is set from the value the plant reports. The typed detail classStateMachineCommandRequestEventDetailcarries the event data. - Set the license key once, in
Program.cs:Smart.Blazor.Industrial.License.Key = "YOUR-KEY";
Parameters
The most used parameters of <StateMachine>; the API page lists them all.
| Parameter | Type |
|---|---|
Model | StateMachineModel |
States | IEnumerable<object> |
Transitions | IEnumerable<object> |
State | string |
EnteredAt | double |
Mode | string |
Modes | IEnumerable<object> |
View | StateMachineView |
ShowCommands | bool |
ShowHistory | bool |
HistoryLength | int |
Interactive | bool |
Events
OnCommandRequest, OnCommandTimeout, OnModeRequest, OnStateChange
The frameworks guide describes the parameter types, the naming rules and the request/confirm round trip in C#.