Docs Center
Articles mirror official ScadaDoc (v6.4), plus custom drivers/modules/plugins from this repo. If you’re unsure where to start, open the Tutorial first.
149 documents found
Overview
IntroductionRapidSCADA is an open source industrial automation platform. The out of the box software provides tools for rapid creation of monitoring an...ApplicationsServer manages the data archives, performs mathematical calculations and provides information to the client applications. Server writes data...Software ArchitectureRapidSCADA software has a multi-tier architecture. Applications (services) included in the software interact with each other using the TCP ...
Installation
System RequirementsWindows:Install on WindowsRapidSCADA requires Internet Information Services (IIS) and .NET Runtime to be installed. Depending on the version of Windows, the installa...Install on Windows ManuallyManual RapidSCADA setup provides full control over the process of the software installation, update and uninstallation.Install on LinuxThis article provides commands for Ubuntu and Debian operating systems. When installing RapidSCADA on other OS of the Linux family, use the...Install ModulesRapidSCADA supports additional modules which extend the software functionality. Module distributions are available in the Download section ...Service ManagementThe Server, Communicator and Agent applications run as services. On Linux, the Webstation application also runs as a separate service. To ma...Transfer to New ServerThis article describes how to migrate a running RapidSCADA instance from one server to another. The sequence of actions is as follows:Safety RecommendationsIf RapidSCADA is used in a corporate environment, ensure that other users do not have access to the RapidSCADA installation directory . On...
Configuration
Configuration BasicsConfiguration of RapidSCADA is performed on a project basys. A project is a set of files in various formats that are stored in the project ...Configuration DatabaseThe configuration database is a part of the project, consisting of tables and common to all project instances. The applications included in ...Device PollingInteraction with devices is performed by the Communicator application, which requests data and sends commands to devices, acting as a master...ChannelsA channel is an entity that has a number and name, with which current and historical data, as well as events, are associated. Synonyms in ot...Scripts and FormulasThe Server application has a built-in engine for executing user scripts. Scripts are used to calculate channel values and statuses, as well ...ViewsView is a form of data representation in the Webstation application. There are 3 types of views supported by default: table views, mimic dia...Table ViewsA table view (see Figure 1) is designed to display historical data for a day with a specified period, as well as current data. Clicking a ta...User ManagementCreating, editing and deleting users is performed in the Administrator application in the Users table (see Figure 1).
Modules
Chart Pro PluginChart Pro Plugin is the additional plugin for the Webstation application extends the capabilities of RapidSCADA charts: adds scaling, displ...Dashboard PluginDashboard Plugin displays useful widgets on dashboards: charts, current data and arbitrary frames, for example, CCTV camera stream. Settings...Elastic Report PluginElastic Report Plugin allows to generate reports according to a custom configuration. Using this plugin, you can build almost any desired re...Map PluginMap Plugin displays the status and parameters of stationary and moving objects on interactive OpenStreetMap maps. The plugin provides visual...Notification PluginNotification Plugin helps an operator to pay attention to the most important events. The plugin generates notifications based on events acco...Automatic Control ModuleAutomatic Control Module is an additional module for the Server application that sends commands and generates events when certain conditions...Database Export ModuleDatabase Export Module provides real-time export of data received from devices to popular databases. Supported DBMS are Microsoft SQL Server...Rapid Gate ModuleRapid Gate Module is designed to synchronize data between RapidSCADA instances. Download the module using the link . The following figure s...Database Import DriverDatabase Import Driver is designed to read current data from a third-party database, as well as to write to a third-party database using com...Modbus Slave DriverThe driver implements the popular Modbus communication protocol and operates as a slave. Using the driver, Communicator waits for incoming r...Telegram DriverTelegram Driver is designed to send notifications using the popular Telegram messenger. The advantages of using Telegram is quickness of rec...
Additional Applications
Enterprise Edition
Enterprise Edition OverviewRapidSCADA Enterprise is proprietary software built on an open source core. RapidSCADA Enterprise is designed for large-scale implementati...Audit Log PluginAudit Log Plugin records the actions of Webstation application users in a PostgreSQL database. The following types of actions are recorded:Guard PluginGuard Plugin constantly monitors all user requests to the Webstation application, detects attempts to brute force attack the web application...
Developers
Development BasicsRapidSCADA is an open source project. Therefore, engineers and programmers can join the RapidSCADA community to develop software that comm...Logic Module DevelopmentLogic modules have the following features:Driver DevelopmentAdvantages of RapidSCADA as a platform for driver creation:Web Plugin DevelopmentUsing web plugins you can create:Module StoreRapidSCADA Module Store helps users find and download additional modules developed by various authors. For developers, Module Store is a pl...
Version History
Custom Extensions
PlgBigScreen Plugin (Custom)Provides big-screen visualization editing and publishing, including module management, dynamic data sources, and dynamic datasets.PlgCameraCenter Plugin (Custom)Documentation for PlgCameraCenter including entry points, APIs, deployment, and troubleshooting.PlgCameraInspection Plugin (Custom)Documentation for PlgCameraInspection including entry points, APIs, deployment, and troubleshooting.PlgChartExtra Plugin (Custom)Documentation for PlgChartExtra including entry points, APIs, deployment, and troubleshooting.PlgCnlLimit Plugin (Custom)Documentation for PlgCnlLimit including entry points, APIs, deployment, and troubleshooting.PlgComtradeStandard Plugin (Custom)Documentation for PlgComtradeStandard including entry points, APIs, deployment, and troubleshooting.PlgDamonWcsPlc Plugin (Custom)Documentation for PlgDamonWcsPlc including entry points, APIs, deployment, and troubleshooting.PlgEventLog Plugin (Custom)Documentation for PlgEventLog including entry points, APIs, deployment, and troubleshooting.PlgEventMessage Plugin (Custom)Documentation for PlgEventMessage including entry points, APIs, deployment, and troubleshooting.PlgInfluxReport Plugin (Custom)Documentation for PlgInfluxReport including entry points, APIs, deployment, and troubleshooting.PlgInkscape Plugin (Custom)Documentation for PlgInkscape including entry points, APIs, deployment, and troubleshooting.PlgMapCustom Plugin (Custom)Documentation for PlgMapCustom including entry points, APIs, deployment, and troubleshooting.PlgMultiView Plugin (Custom)Documentation for PlgMultiView including entry points, APIs, deployment, and troubleshooting.PlgResetData Plugin (Custom)Documentation for PlgResetData including entry points, APIs, deployment, and troubleshooting.PlgScadaAPPDesigner Plugin (Custom)Documentation for PlgScadaAPPDesigner including entry points, APIs, deployment, and troubleshooting.PlgSchBigScreenComp Plugin (Custom)Documentation for PlgSchBigScreenComp including entry points, APIs, deployment, and troubleshooting.PlgSchDamonExtraComp Plugin (Custom)Documentation for PlgSchDamonExtraComp including entry points, APIs, deployment, and troubleshooting.PlgSchEChartComp Plugin (Custom)Documentation for PlgSchEChartComp including entry points, APIs, deployment, and troubleshooting.PlgSchSvgExtComp Plugin (Custom)Documentation for PlgSchSvgExtComp including entry points, APIs, deployment, and troubleshooting.PlgSchWebCameraComp Plugin (Custom)Documentation for PlgSchWebCameraComp including entry points, APIs, deployment, and troubleshooting.PlgSchYiNengKeComp Plugin (Custom)Documentation for PlgSchYiNengKeComp including entry points, APIs, deployment, and troubleshooting.PlgSmartReport Plugin (Custom)Documentation for PlgSmartReport including entry points, APIs, deployment, and troubleshooting.PlgSsoBridge Plugin (Custom)Documentation for PlgSsoBridge including entry points, APIs, deployment, and troubleshooting.PlgStatisticsApi Plugin (Custom)Documentation for PlgStatisticsApi including entry points, APIs, deployment, and troubleshooting.PlgSvgEditor Plugin (Custom)Documentation for PlgSvgEditor including entry points, APIs, deployment, and troubleshooting.PlgTableStudio Plugin (Custom)Documentation for PlgTableStudio including entry points, APIs, deployment, and troubleshooting.PlgDynamicData Plugin (Custom)Web extension for dynamic data and intelligent query workflows.PlgDynamicEngineEditor Plugin (Custom)Visual editor and management UI for dynamic engine rules.PlgWorkflowEditor Plugin (Custom)Workflow orchestration with trigger validation and run history.PlgGallery Plugin (Custom)Gallery asset management for Mimic and big-screen editors via /api/gallery/.PlgReportStudio Plugin (Custom)Report studio for template design, publishing, and analytics export.PlgSmsService Plugin (Custom)SMS alarm publishing with device mapping and delivery tracking.PlgMimic Plugin (Custom)Mimic (.mim) authoring and runtime: PlgMimic, PlgMimicEditor, and component packs such as PlgMimBigScreenComp view jump.
Custom Admin Extensions
ExtCodeEditor Admin Extension (Custom)ExtCodeEditor admin extension docs with structure, dependencies, and deployment checklist.ExtDepBundle Admin Extension (Custom)ExtDepBundle admin extension docs with structure, dependencies, and deployment checklist.ExtDepMySql Admin Extension (Custom)ExtDepMySql admin extension docs with structure, dependencies, and deployment checklist.ExtDepSqlServer Admin Extension (Custom)ExtDepSqlServer admin extension docs with structure, dependencies, and deployment checklist.ExtMapEditor Admin Extension (Custom)ExtMapEditor admin extension docs with structure, dependencies, and deployment checklist.MySqlStorage Admin Extension (Custom)MySqlStorage admin extension docs with structure, dependencies, and deployment checklist.SqlServerStorage Admin Extension (Custom)SqlServerStorage admin extension docs with structure, dependencies, and deployment checklist.
Custom Communicator Drivers
DrvABPlc Driver (Custom)DrvABPlc: install, line/device config, DeviceTemplate, CustomOptions.DrvBachmannSvi Driver (Custom)DrvBachmannSvi: install, line/device config, DeviceTemplate, CustomOptions.DrvBACnet Driver (Custom)DrvBACnet: install, line/device config, DeviceTemplate, CustomOptions.DrvBeckhoffPlc Driver (Custom)DrvBeckhoffPlc: install, line/device config, DeviceTemplate, CustomOptions.DrvBrPvi Driver (Custom)DrvBrPvi: install, line/device config, DeviceTemplate, CustomOptions.DrvCameraControl Driver (Custom)DrvCameraControl: install, line/device config, DeviceTemplate, CustomOptions.DrvCnlDLMS Driver (Custom)DrvCnlDLMS: install, line/device config, DeviceTemplate, CustomOptions.DrvDeviceInfo Driver (Custom)DrvDeviceInfo: install, line/device config, DeviceTemplate, CustomOptions.DrvDLMS Driver (Custom)DrvDLMS: install, line/device config, DeviceTemplate, CustomOptions.DrvDLT645 Driver (Custom)DrvDLT645: install, line/device config, DeviceTemplate, CustomOptions.DrvGpiod Driver (Custom)DrvGpiod: install, line/device config, DeviceTemplate, CustomOptions.DrvHikvisionCounter Driver (Custom)DrvHikvisionCounter: install, line/device config, DeviceTemplate, CustomOptions.DrvHikvisionTool Driver (Custom)DrvHikvisionTool: install, line/device config, DeviceTemplate, CustomOptions.DrvHJ212 Driver (Custom)DrvHJ212: install, line/device config, DeviceTemplate, CustomOptions.DrvIEC102 Driver (Custom)DrvIEC102: install, line/device config, DeviceTemplate, CustomOptions.DrvIEC103 Driver (Custom)DrvIEC103: install, line/device config, DeviceTemplate, CustomOptions.DrvIEC104 Driver (Custom)DrvIEC104: install, line/device config, DeviceTemplate, CustomOptions.DrvIEC61850 Driver (Custom)DrvIEC61850: install, line/device config, DeviceTemplate, CustomOptions.DrvInfluxDbImportV1 Driver (Custom)DrvInfluxDbImportV1: install, line/device config, DeviceTemplate, CustomOptions.DrvKeyencePlc Driver (Custom)DrvKeyencePlc: install, line/device config, DeviceTemplate, CustomOptions.DrvLafei485 Driver (Custom)DrvLafei485: install, line/device config, DeviceTemplate, CustomOptions.DrvMelsecFx Driver (Custom)DrvMelsecFx: install, line/device config, DeviceTemplate, CustomOptions.DrvMelsecMc Driver (Custom)DrvMelsecMc: install, line/device config, DeviceTemplate, CustomOptions.DrvMelsecPlc Driver (Custom)DrvMelsecPlc: install, line/device config, DeviceTemplate, CustomOptions.DrvModbusGst Driver (Custom)DrvModbusGst: install, line/device config, DeviceTemplate, CustomOptions.DrvModbusSlave Driver (Custom)DrvModbusSlave: install, line/device config, DeviceTemplate, CustomOptions.DrvMouseControl Driver (Custom)DrvMouseControl: install, line/device config, DeviceTemplate, CustomOptions.DrvOsiPi Driver (Custom)DrvOsiPi: install, line/device config, DeviceTemplate, CustomOptions.DrvRedis Driver (Custom)DrvRedis: install, line/device config, DeviceTemplate, CustomOptions.DrvResetData Driver (Custom)DrvResetData: install, line/device config, DeviceTemplate, CustomOptions.DrvRestGateway Driver (Custom)DrvRestGateway: install, line/device config, DeviceTemplate, CustomOptions.DrvSharedMemory Driver (Custom)DrvSharedMemory: install, line/device config, DeviceTemplate, CustomOptions.DrvSiemensS7 Driver (Custom)DrvSiemensS7: install, line/device config, DeviceTemplate, CustomOptions.DrvSocket Driver (Custom)DrvSocket: install, line/device config, DeviceTemplate, CustomOptions.DrvUdpCameraControl Driver (Custom)DrvUdpCameraControl: install, line/device config, DeviceTemplate, CustomOptions.DrvVNode Driver (Custom)DrvVNode: install, line/device config, DeviceTemplate, CustomOptions.DrvWeihenstephan Driver (Custom)DrvWeihenstephan: install, line/device config, DeviceTemplate, CustomOptions.
Custom Server Extensions
ModArcIoTDB Server Module (Custom)ModArcIoTDB server extension docs with routes, config, dependencies, and deployment checks.ModArcKafka Server Module (Custom)ModArcKafka server extension docs with routes, config, dependencies, and deployment checks.ModArcMySql Server Module (Custom)ModArcMySql server extension docs with routes, config, dependencies, and deployment checks.ModArcRedis Server Module (Custom)ModArcRedis server extension docs with routes, config, dependencies, and deployment checks.ModArcSqlServer Server Module (Custom)ModArcSqlServer server extension docs with routes, config, dependencies, and deployment checks.ModArcTimescaleDB Server Module (Custom)ModArcTimescaleDB server extension docs with routes, config, dependencies, and deployment checks.ModAutoControl Server Module (Custom)ModAutoControl server extension docs with routes, config, dependencies, and deployment checks.ModBlockly Server Module (Custom)ModBlockly server extension docs with routes, config, dependencies, and deployment checks.ModCalcCenter Server Module (Custom)ModCalcCenter server extension docs with routes, config, dependencies, and deployment checks.ModCameraControl Server Module (Custom)ModCameraControl server extension docs with routes, config, dependencies, and deployment checks.ModComtradeStandard Server Module (Custom)ModComtradeStandard server extension docs with routes, config, dependencies, and deployment checks.ModDeviceAlarm Server Module (Custom)ModDeviceAlarm server extension docs with routes, config, dependencies, and deployment checks.ModDnp3 Server Module (Custom)ModDnp3 server extension docs with routes, config, dependencies, and deployment checks.ModDynamicEngine Server Module (Custom)ModDynamicEngine server extension docs with routes, config, dependencies, and deployment checks.ModJiaTai Server Module (Custom)ModJiaTai server extension docs with routes, config, dependencies, and deployment checks.ModOpcUaServer Server Module (Custom)ModOpcUaServer server extension docs with routes, config, dependencies, and deployment checks.ModResaveTextData Server Module (Custom)ModResaveTextData server extension docs with routes, config, dependencies, and deployment checks.ModRestGateway Server Module (Custom)ModRestGateway server extension docs with routes, config, dependencies, and deployment checks.ModSample Server Module (Custom)ModSample server extension docs with routes, config, dependencies, and deployment checks.ModServerIEC104 Server Module (Custom)ModServerIEC104 server extension docs with routes, config, dependencies, and deployment checks.ModServerIEC104Multi Server Module (Custom)ModServerIEC104Multi server extension docs with routes, config, dependencies, and deployment checks.ModServerIEC61850 Server Module (Custom)ModServerIEC61850 server extension docs with routes, config, dependencies, and deployment checks.ModSmsFourFaithService Server Module (Custom)ModSmsFourFaithService server extension docs with routes, config, dependencies, and deployment checks.ModSmsService Server Module (Custom)ModSmsService server extension docs with routes, config, dependencies, and deployment checks.ModTransCdtByUdp Server Module (Custom)ModTransCdtByUdp server extension docs with routes, config, dependencies, and deployment checks.ModWaveRecorder Server Module (Custom)Fault wave recording server module; web UI relies on PlgTableStudio wave pages.