Skip to content

Phase Template: set-agitator

Set the agitator speed on a reactor or tank (0-100 %). It is a single-action building block that writes the speed and completes. Write 0 to stop the agitator. There is no separate stop-agitator template.

Where to find it

System endpoint → Equipment Library → Phases → select set-agitator.

graph TD
    Start([initial]) --> EX["execute<br/>agitator.CMD := speed"]
    EX --> Done([done])

See Phases for the diagram conventions.

What you see when it runs

Element Meaning
Active step execute — the phase completes as soon as the write is issued
Parameters speed resolved from the recipe formula
Bound modules The concrete control-module instance the agitator role resolved to

HMI screenshot pending

An annotated capture of a running set-agitator phase will be added here.

Parameters

Parameter Type Unit Range Default Required
speed REAL % 0-100 — yes

Required control modules

Role Module type Description
agitator analog-control Agitator speed control

Capability: mixing.

How it works

The phase has a single execute step. It writes speed to agitator.CMD and the phase completes. The agitator keeps running at that speed after the phase ends, until a later step changes it. The holding, stopping, aborting, and resetting charts zero the agitator. The restarting chart re-applies speed.

This is a single-action phase. There is no ramp-up confirmation. The purpose-built phases (tank-mix, smooth-cake) wait for agitator.POS to reach 80 % of setpoint before proceeding. Use one of those when downstream steps depend on the agitator actually turning.

Used in recipes

No shipped reference recipe uses this template. It is a building block for composing your own.

Try it

  1. System endpoint → Recipes → create a draft recipe with a set-agitator step on mix-tank-1 (the agitator role binds to mt1-agitator)
  2. Approve and start it from HMI endpoint → Batch Execution
  3. Open the agitator faceplate and watch CMD jump to speed and POS ramp toward it

Modify this template

Want to clone this and adapt it for your own equipment? Walk through Adaptation Guide for the full clone → rebind → deploy → run workflow, and Parameter Binding to understand how recipe values flow through to control-module tags.