Usage Tutorial

Learn Rapid SCADA first, then extensions. Paths follow official ScadaDoc (v6.4) plus this repo’s deploy and topic guides.

Start with the hands-on course below. Each lesson includes actions, acceptance checks, and troubleshooting, followed by reference links. Open Docs Center →

FROM FIRST MEASUREMENT TO HANDOVER

Build a complete working project

8 practical lessons, 34 steps, and acceptance checks in every lesson. Start in order, or jump to the next task in your existing environment.

Start lesson one →

Prepare and install the platform

Understand the five applications, choose a deployment track, and verify service connectivity.

Steps and acceptance →02

Acquire your first measurement

Use one read-only Modbus measurement to connect device polling, a Server channel, and a Web table view.

Steps and acceptance →03

Build a live SVG screen

Start with one measurement and complete layout, binding, status display, save, and reopen.

Steps and acceptance →04

Build an operations dashboard

Organize live metrics and lists into a readable dashboard, validating data shape before publishing the runtime.

Steps and acceptance →05

Configure and handle an alarm

Verify thresholds, event timestamps, acknowledgement rights, and recovery before adding notifications.

Steps and acceptance →06

Create a report from a SQL dataset

Follow the current DynamicData → ReportStudio workflow through parameters, design, validation, and export.

Steps and acceptance →07

Use AI in the current editor

Provide real editor context, review a small change, and verify it through native preview and save.

Steps and acceptance →08

Deploy, back up, and troubleshoot

Separate packaged installation from source builds, deploy the selected product line, and retain a recoverable release.

Steps and acceptance →

Use a separate practice environment. New projects use the React extension line; Mimic uses its official editor. Verify device addresses, channel numbers, and screenshot values against your project.

Rapid SCADA · 01–26

Training & Teaching

Train by role. Do not mix install, HMI authoring, and duty operations in one session. Watch the demo first, then practice with docs and field notes.

Operators

Views, event ack, and commands when authorized. Focus on channel numbers, event ack, and video preview/playback boundaries.

Open doc →

Engineers

Objects, lines, devices, channels, and upload. Extensions follow Drv / Mod / Plg; do not mix same-named plugins.

Open doc →

Delivery

Base login, live CurData, views and reports on the same channel numbers. Drill Linux services and the acceptance checklist separately.

Open doc →

Foundation & delivery9

Field notes (reading drills)6

Industry field notes (published)11

Complete one acquisition loop first

1
Check environment
Check OS, .NET version, and web hosting against your distribution. Source builds use the .NET 8 SDK; follow the version-specific installer requirements for packaged releases.
Open doc →
2
Install the base
Install Server, Communicator, Webstation, Administrator, and Agent per official docs.
Open doc →
3
Create & upload a project
In Administrator: new project → objects/lines/devices/channels → upload to the instance.
Open doc →
4
Verify one acquisition path
Start with Modbus or a virtual device: line running → CurData present → visible in Web.
Open doc →
5
Then install extensions
After the base is stable, copy extension DLLs/UI (BuildScripts copy only) and activate modules/plugins in Admin.
Open doc →

Learning tracks

1. Five apps & architecture

Know Server / Communicator / Webstation / Administrator / Agent before configuring.

2. Install & services

Follow ScadaDoc Installation; activate extensions with the same Install Modules flow.

3. Project configuration (where most people stall)

Official Configuration path: database → polling → channels → views → users.

4. Deploying this repo’s extensions

Build slns in the IDE, then copy with BuildScripts. Never mix Legacy and React same-named plugins.

5. Visualization: SvgEditor / Big Screen / Twin

Get channel data first. React greenfield projects use SvgEditor; big screens, twins, maps, and apps keep separate projects and published artifacts.

6. Energy & field logic (EMS)

AGC/AVC via ModEmsLua + PlgEms; icing and other assistants via ModLogicRuntime—not inside AGC.

7. Operations: alarms, notify, analytics, video

Duty loop: events → notify → replay → analytics boards.

8. Video streaming & vision analytics

MediaMTX pulls RTSP once; ScadaStream WHEP preview; PlgStreamArchive playback; PlgCameraInspection + vision-analyze.

Common Pitfalls

Extension installed but no Web menu?

Confirm DLL is under Web, plugin activated in Admin, config uploaded, and Legacy/React same-named Plg* are not mixed.

Channels have data but HMI doesn’t refresh?

Check bound channel IDs, Web rights, and instance; verify CurData with a table view first.

EMS setpoint flashes to 0?

Often AGC-off logic rewrites local demand to current power each cycle. Check IsParkControlIntoService before blaming the UI.

Default login?

Often admin / scada—change password and tighten roles before production (see User Management).

BuildScripts can’t find DLLs?

Scripts only copy: build the matching sln in Release first, then run scripts 1–4.

Extension Portfolio (Selected)

Comm drivers (ScadaV6CommExt)

DrvIEC104 · DrvIEC61850 · DrvIEC103 · DrvIEC102 · DrvModbusSlave · DrvDLMS · DrvDLT645 · DrvSiemensS7 · DrvOmronPlc · DrvMelsecFx · DrvMelsecMc · DrvKeyencePlc · DrvBeckhoffPlc · DrvBACnet · DrvHJ212 · DrvRestGateway · DrvSocket · DrvSharedMemory · DrvRedis · DrvGpiod · DrvOsiPi · DrvHikvisionTool

Server modules (ScadaV6ServerExt)

ModServerIEC104 · ModServerIEC104Multi · ModServerIEC61850 · ModOpcUaServer · ModRestGateway · ModArcInfluxDb3 · ModArcKafka · ModArcRedis · ModArcIoTDB · ModArcTimescaleDB · ModArcSqlServer · ModArcMySql · ModDeviceAlarm · ModCalcCenter · ModDynamicEngine · ModAutoControl · ModWorkflowExecutor · ModWaveRecorder · ModAgvcSubstation · ModEmsLua · ModLogicRuntime · ModEnvControl · ModScadaHa · ModSmsService

Web plugins (ScadaV6WebPluginExtReact)

PlgBigScreen · PlgReportStudio · PlgInfluxReport · PlgSvgEditor · PlgEventLog · PlgEventMessage · PlgMapCustom · PlgMultiView · PlgComtradeStandard · PlgCameraInspection · PlgStreamArchive · PlgIrThermo · PlgChartExtra · PlgDynamicData · PlgDynamicEngineEditor · PlgWorkflowEditor · PlgGallery · PlgScadaAPPDesigner · PlgTwinStudio · PlgEms · PlgEnvControl · PlgGrafanaEmbed · PlgIec61850Designer · PlgSmsService · PlgScadaAiAssist · PlgSsoBridge · PlgStatisticsApi · PlgCnlLimit

Mimic & twin notes

New projects use the React host and independently deployed plugins. Use official PlgMimicEditor when Mimic is required, optionally embedded in ScadaWebExt; use PlgSvgEditor for SVG screens. Maintain the two Web product lines separately and never mix same-named plugin assemblies. Publish web 3D scenes before registering runtime views.

Current AI workflow

Use PlgAI inside the current editor: read the canvas snapshot, review the proposed change, then apply it. Native API tools cover capability discovery, conditional DynamicData SQL edits, and ReportStudio validation/save. Use the editors for other domains; archived MCP services and CLIs are retired.