中文文档站点 | English

EdgeX（工业边缘网关）是一款轻量级工业边缘计算网关软件，面向制造、能源、楼宇等现场部署。后端采用 Go，管理界面采用 Vue 3 + Vuetify。

图 1：数据流向总览

EdgeX 部署在工业现场，使命是打通 OT 设备 ↔ IT 系统 的数据通道 — 南向统一接入、边缘就地处理、北向灵活对接，一机完成采集到上报的闭环。以南向 13 协议采集写入 ShadowCore 影子真源，联动虚拟设备、边缘规则、持久化与北向通道；并以工业级 SLA 与 Soak 长稳验证保障现场长期可靠运行。

• 统一接入：异构 PLC、表计、楼宇与网络设备，一套网关采集
• 影子真源：内存 ShadowCore 统一服务 UI、边缘计算与北向上报
• 边缘智能：本地规则与派生点位，联动控制、减轻上行
• 开放集成：对接云平台、SCADA 与企业应用，支持反向写控
• 工业级稳定：内置指标门控、Soak 长稳回归与 CI 五 gate，SLA 可观测、可验证

以工业现场为设计原点，坚持稳定性优先、统一架构、长期可维护，构建面向未来的工业边缘计算平台。

能力与指标详见 产品优势；精简宣传见 产品手册；完整说明见 产品说明（源码）。

每个工业现场都有一批「还没被接进来」的设备与数据 — 不同协议、不同年代、不同厂商，各自沉默在 OT 一侧。它们像是一群尚未被发现的潜能：有价值，却还没进入 IT 的视线。

我们把这个未知数叫作 X。

Edge 是它们所在的地方：产线旁的控制柜、楼宇的弱电间、站场的边缘机柜 — 离数据源最近、也最该做决策的位置。X 则是现场的交叉点：多协议在此汇聚，边缘规则在此运行，OT 与 IT 在此第一次真正对话。

EdgeX 因此不是两个字母的简单拼接，而是 Edge（边缘）+ X（未知潜能的交叉点）：部署在现场侧的那支「X 因子」 — 让沉默的设备开口说话，让边缘智能成为工业现场的可靠能力，并以 SLA 与 Soak 长稳验证，把这种能力交付为可观测、可验证的工程承诺。

工业级稳定性是 EdgeX 的核心点：在功能丰富的同时，通过内置指标门控、Soak 长稳回归与 CI 五 gate 持续验证 SLA，保障现场长期可靠运行。

完整说明见 产品说明 — 产品优势（源码）。

统计 SLA（非硬实时 PLC），内置门控与 GET /api/diagnostics/scan-engine 可观测。验证链路覆盖：运行时指标监测 → 诊断 API 可观测 → CI 五 gate 回归 → Soak 长稳验证。阈值定义、万 Tag 压测、Soak 长稳与部署建议见 产品说明 — 工业级 SLA（源码）。

图 2：产品能力维度

架构图、组件职责与数据路径等运行时细节见 文档站点（本地源码见 docs/）：

项目使用 GoReleaser（.goreleaser.yml）统一构建前端与后端，并生成分平台安装包。GoReleaser 内置 nfpm，用于生成 .deb / .rpm 包，无需单独安装 nfpm。

go install github.com/goreleaser/goreleaser/v2@latest

# 在仓库根目录执行：清理 dist/ 并构建（snapshot 模式，不发布 GitHub Release）
goreleaser release --snapshot --clean

构建流水线（before.hooks）：

1. go mod tidy — 整理 Go 依赖
2. npm run build --prefix ./ui — 构建 Vue 前端至 ui/dist/

交叉编译目标（CGO_ENABLED=0，入口 ./cmd/main.go，二进制名 edgex）：

产物目录 ./dist/：

git clone https://github.com/anviod/edgex.git
cd edgex
go mod tidy

# 后端：静态编译，无 CGO 依赖
CGO_ENABLED=0 go build -o edgex ./cmd/main.go

# 前端（生产环境推荐，产物由后端托管 ui/dist）
cd ui && npm install && npm run build && cd ..

从 GitHub Releases 或本地 dist/ 目录获取对应架构的安装包（amd64 / arm64 / arm），文件名形如 edgex-v{version}-{arch}.deb 或 .rpm。

包内会安装二进制至 /usr/local/bin/edgex/，注册 systemd 服务 edgex；升级时 preinstall / postinstall 脚本会自动备份并恢复 config/ 与 data/，无需手工迁移配置。

# 首次安装
sudo dpkg -i edgex-v{version}-amd64.deb
sudo apt-get install -f -y

# 升级
sudo dpkg -i edgex-v{new-version}-amd64.deb
# 或
sudo apt install ./edgex-v{new-version}-amd64.deb

# 卸载
sudo apt remove -y edgex

# 首次安装
sudo rpm -ivh edgex-v{version}-amd64.rpm
# 或
sudo dnf install ./edgex-v{version}-amd64.rpm

# 升级
sudo rpm -Uvh edgex-v{new-version}-amd64.rpm
# 或
sudo dnf upgrade ./edgex-v{new-version}-amd64.rpm

# 卸载
sudo rpm -e edgex

sudo systemctl status edgex
sudo systemctl enable --now edgex   # 若未自动启动

浏览器访问 http://<主机>:<port> 进入管理界面；首次启动若 data/config.db 不存在，将进入 Web 安装向导。

tar.gz 裸机部署：若使用 edgex-{version}-linux-{arch}.tar.gz，解压后参考下方「目录与配置」与「启动服务」，或自行配置 systemd（包内附带 edgex.service 示例）。

首次启动若 data/config.db 不存在，网关以安装模式启动，通过 Web UI 完成初始化。

# 默认配置目录 ./conf，HTTP 端口见 server 配置（常见 8080/8082）
./edgex

# 指定遗留 YAML 迁移目录
./edgex -conf ./conf/

访问 http://localhost:<port> 进入管理界面。默认账号见安装向导或 conf/users.yaml。

• systemd 服务、防火墙端口、配置初始化：见 用户手册 — 部署流程（源码）
• 系统包安装与升级（deb / rpm）：见 用户手册 — 安装指南（源码）
• EdgeOS 集成与北向通道：见 EdgeOS 快速入门（源码）
• 多从站 Modbus 配置：见 多从站快速入门（源码）

日常开发在 **dev** 分支进行；功能与修复 PR 请以 **dev** 为合并目标。main 保留为稳定发布线，由维护者从 dev 按需合并。

go mod tidy
go run cmd/main.go          # 后端，默认 -conf ./conf
cd ui && npm install && npm run build && cd ..   # 前端（可选）

# 短测门控（详见 test/README.md）
make test-short

默认管理端口取决于 server 配置；BACnet 需开放 UDP 47808。

• 产品说明：在线阅读 · 源码
• 用户手册：在线阅读 · 源码

English documentation: README.en.md