OpenPLC Runtime v4

OpenPLC Runtime v4 是一款无头工业可编程逻辑控制器（PLC）运行时，可在标准计算硬件上运行 IEC 61131-3 程序。它设计为可通过 REST API 由 https://github.com/Autonomy-Logic/openplc-editor 桌面应用程序控制，或通过 Autonomy Edge Cloud 控制。

OpenPLC Runtime 组件

OpenPLC Runtime v4 包含两个主要组件：

1. REST API 服务器（Python/Flask） - 端口 8443 上的 HTTPS 接口，供 OpenPLC Editor 上传程序、监控编译和控制执行
2. PLC 运行时核心（C/C++） - 具有确定性扫描周期的实时执行引擎

运行时执行在 OpenPLC Editor 中创建的程序，支持 IEC 61131-3 编程语言（梯形图、结构化文本、功能块图等）。

快速开始

Docker（推荐）

最快的入门方式：

docker pull ghcr.io/autonomy-logic/openplc-runtime:latest

docker run -d \
--name openplc-runtime \
-p 8443:8443 \
--cap-add=SYS_NICE \
--cap-add=SYS_RESOURCE \
-v openplc-runtime-data:/var/run/runtime \
ghcr.io/autonomy-logic/openplc-runtime:latest

运行时将启动并在端口 8443 上监听来自 OpenPLC Editor 的连接。**不要在浏览器中打开 https://localhost:8443**——与 v3 运行时不同，此处没有 Web 界面。相反，请打开 OpenPLC Editor 桌面应用程序，配置运行时 IP 地址和凭据以进行连接。

预构建二进制文件： amd64、arm64、armv7

Linux 安装

对于原生 Linux 安装：

# Clone repository
git clone https://github.com/Autonomy-Logic/openplc-runtime.git
cd openplc-runtime
git checkout development

# Install dependencies and compile
sudo ./install.sh

# Start the runtime
sudo ./start_openplc.sh

运行时将启动并在端口 8443 上监听。通过在 OpenPLC Editor 桌面应用程序中配置运行时 IP 地址并从编辑器登录来连接到它。

支持的发行版： Ubuntu、Debian、Fedora、CentOS、RHEL

要求：

• GCC 编译器
• CMake
• Python 3.8+
• root 权限（用于实时调度和端口绑定）

工作原理

1. 创建程序 - 在 OpenPLC Editor v4 中使用梯形图、FBD、ST 或其他 IEC 61131-3 语言设计 PLC 程序
2. 在编辑器中编译 - 编辑器在本地编译（JSON → XML → ST → C 文件）并将源代码打包为 program.zip
3. 上传 - 编辑器通过带有 JWT 身份验证的 HTTPS POST 请求将 ZIP 文件上传到运行时的 /api/upload-file 接口
4. 在运行时编译 - 运行时验证、提取并使用 CMake 编译程序（编辑器轮询 /api/compilation-status 获取进度）
5. 控制 - 编辑器通过 /api/start-plc 和 /api/stop-plc 端点控制 PLC 执行
6. 调试 - 编辑器连接到 /api/debug 处的 WebSocket 调试接口以进行实时变量监控

运行时将上传的程序编译为共享库并动态加载。PLC 核心以实时优先级（SCHED_FIFO）执行，以实现确定性时序。

有关编辑器-运行时集成的详细信息，请参见 docs/EDITOR_INTEGRATION.md。

Docker 使用方法

基本使用

# 拉取镜像
docker pull ghcr.io/autonomy-logic/openplc-runtime:latest

# 使用持久化存储运行
docker run -d \
--name openplc-runtime \
-p 8443:8443 \
-v openplc-runtime-data:/var/run/runtime \
ghcr.io/autonomy-logic/openplc-runtime:latest

# 查看日志
docker logs -f openplc-runtime

# 停止容器
docker stop openplc-runtime

Docker Compose

创建 docker-compose.yml 文件：

version: '3.8'

services:
  openplc-runtime:
    image: ghcr.io/autonomy-logic/openplc-runtime:latest
    container_name: openplc-runtime
    ports:
      - "8443:8443"
    volumes:
      - openplc-runtime-data:/var/run/runtime
    restart: unless-stopped

volumes:
  openplc-runtime-data:

启动命令：docker-compose up -d

完整的 Docker 文档请参见 docs/DOCKER.md。

从源码构建

前提条件

安装依赖项：

# Ubuntu/Debian
sudo apt-get install build-essential gcc make cmake \
python3-dev python3-pip python3-venv

# Fedora/RHEL/CentOS
sudo dnf install gcc gcc-c++ make cmake \
python3 python3-devel python3-pip python3-venv

构建步骤

# 克隆仓库
git clone https://github.com/Autonomy-Logic/openplc-runtime.git
cd openplc-runtime
git checkout development

# 运行安装脚本
sudo ./install.sh

安装脚本将执行以下操作：

1. 检测 Linux 发行版
2. 安装系统依赖项
3. 在 venvs/runtime/ 创建 Python 虚拟环境
4. 安装 Python 依赖项
5. 使用 CMake 编译 PLC 运行时核心

手动构建

手动编译步骤：

# 创建 Python 虚拟环境
python3 -m venv venvs/runtime
source venvs/runtime/bin/activate
pip install -r requirements.txt
pip install -e .

# 编译运行时核心
mkdir -p build
cd build
cmake ..
make -j$(nproc)
cd ..

启动运行时

sudo ./start_openplc.sh

启动脚本将执行以下操作：

1. 检查安装状态
2. 设置插件虚拟环境（如果插件包含 requirements.txt）
3. 激活运行时虚拟环境
4. 启动 Web 服务器（自动管理 PLC 运行时进程）

注意： 需要 root 权限以执行以下操作：

• 实时调度（SCHED_FIFO 优先级）
• 绑定到端口 8443
• 在 /run/runtime/ 创建 Unix 域套接字

openplc-runtime/
├── webserver/ # Flask Web应用程序（Python）
│ ├── app.py # 主应用入口
│ ├── restapi.py # REST API 蓝图
│ ├── debug_websocket.py # WebSocket 调试接口
│ └── ...
├── core/
│ ├── src/plc_app/ # PLC 运行时源代码（C/C++）
│ │ ├── plc_main.c # 主入口点
│ │ ├── plc_state_manager.c/h # 状态管理
│ │ ├── unix_socket.c/h # IPC 服务器
│ │ └── utils/ # 工具（日志、看门狗、定时）
│ └── src/drivers/ # 插件驱动系统
├── scripts/ # 构建和管理脚本
│ ├── compile.sh # 编译 PLC 程序
│ ├── compile-clean.sh # 清理并重命名库
│ └── manage_plugin_venvs.sh # 插件虚拟环境管理
├── build/ # 编译输出
│ ├── plc_main # 编译后的运行时可执行文件
│ └── libplc_*.so # 编译后的 PLC 程序库
├── docs/ # 文档
├── CMakeLists.txt # CMake 构建配置
├── Dockerfile # 容器定义
├── install.sh # 安装脚本
└── start_openplc.sh # 启动脚本

系统要求

最低要求

• CPU： 1 GHz 单核
• RAM： 512 MB
• 磁盘： 500 MB 可用空间
• 操作系统： Linux（Ubuntu 20.04+、Debian 11+、Fedora、CentOS、RHEL）

推荐要求

• CPU： 2 GHz 双核或更高
• RAM： 1 GB 或更多
• 磁盘： 1 GB 可用空间
• 操作系统： Ubuntu 22.04 LTS 或 Debian 12

实时性能

为实现确定性实时性能：

• 建议使用专用 CPU 核心
• 实时内核（PREEMPT_RT）可选但有益
• 最少后台进程
• SCHED_FIFO 调度所需的 root 权限

许可证

详情参见 LICENSE 文件。

支持

• 问题反馈： https://github.com/Autonomy-Logic/openplc-runtime/issues
• 文档： 参见 docs/ 目录
• OpenPLC 编辑器： https://github.com/Autonomy-Logic/openplc-editor

相关项目

• https://github.com/Autonomy-Logic/openplc-editor - PLC 编程环境
• https://github.com/thiagoralves/OpenPLC_v3 - 先前版本

致谢

OpenPLC Runtime v4 由 Autonomy Logic 开发和维护。