MCPcopy Index your code
hub / github.com/anviod/edgex

github.com/anviod/edgex @v0.0.7

Chat with this repo
repository ↗ · DeepWiki ↗ · release v0.0.7 ↗ · + Follow
6,157 symbols 26,047 edges 662 files 1,582 documented · 26%
What it actually does AI analysis from the code graph — generated when you open this
loading…
README

Industrial Edge Gateway

中文文档站点 | English

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

产品概览

EdgeX 部署在工业现场,使命是打通 OT 设备 ↔ IT 系统 的数据通道——南向统一接入、边缘就地处理、北向灵活对接,一机完成采集到上报的闭环。功能覆盖南向 12 协议、边缘规则与北向多通道集成,并以工业级 SLA 与 Soak 长稳验证保障现场长期可靠运行。

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

能力与指标详见 产品优势;完整说明见 产品说明源码)。

为何叫 EdgeX?

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

我们把这个未知数叫作 X

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

如果你熟悉 X 战警,会认出这个隐喻:每个成员能力各异,组合起来才能守护一个复杂世界。EdgeX 的 12 种南向协议也是如此——Modbus、S7、OPC UA……各自施展所长,在边缘组成一支协同团队,把采集、派生计算与北向上报串成闭环。

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

产品优势

工业级稳定性是 EdgeX 的核心卖点:在功能丰富(12 协议南向、规则引擎、北向多通道)的同时,通过内置指标门控、Soak 长稳回归与 CI 五 gate 持续验证 SLA,保障现场长期可靠运行。

能力维度 核心价值 关键指标 / 交付物
质量保障 内置指标门控 + Soak 长稳回归 + CI 五 gate lag P95 <100ms · miss deadline =0 · 万 Tag 压测 · 可观测诊断
南向接入 12 种工业协议,异构 OT 统一采集 设备发现 · 对象扫描 · 批量点位注册
采集调度 10ms 级调度内核,内存影子真源 P99 调度 lag <150ms(≤10k tag,统计 SLA)
边缘智能 规则引擎 + 虚拟影子派生计算 跨设备映射 · 公式聚合 · 本地联动控制
北向集成 多协议对接云平台、SCADA 与企业应用 MQTT · Sparkplug B · OPC UA · EdgeOS

EdgeX 产品能力分层总览:接入 → 采集 → 边缘 → 北向 → 质量层

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

工业级 SLA 与稳定性验证

EdgeX SLA 验证闭环:运行时监测 → 可观测 → CI/Soak 验证

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

轻量灵活部署

项目 规格
交付形态 单二进制 · CGO_ENABLED=0 静态编译 · 无运行时依赖
最低配置 128MB 内存 · 1GB 存储
支持架构 x86_64 · ARMv7 · ARM64
部署方式 裸机 / systemd · 嵌入式设备

功能索引

模块 说明
南向采集 工业协议 · 调度与影子 · 采集优化
北向上报 北向平台集成
虚拟影子 虚拟影子设备
边缘计算 规则与联动
系统管理 Vue 3 管理 UI · JWT / LDAP · 安装向导 · config.db · 日志 · WebSocket 实时推送
质量保障 工业级 SLA · 轻量部署

文档导航

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

文档 说明
架构设计 · 源码 ScanEngine 调度内核、ShadowCore、系统架构图
产品说明 · 源码 能力详解、SLA 指标与功能说明
边缘网关架构设计总览 · 源码 边缘网关组件划分与数据流
南向驱动矩阵 · 源码 12 种协议驱动与开发规范
测试验证 · 源码 · test/ 维护 SLA 压测、Soak 与 go test 维护原则

部署流程

1. 编译方式

一键多平台打包(推荐)

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

# 安装 GoReleaser(任选其一)
go install github.com/goreleaser/goreleaser/v2@latest
# 或 brew install goreleaser

# 在仓库根目录执行:清理 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):

平台 架构
Linux amd64、arm64、arm/v7
Windows amd64(不含 arm/arm64)

产物目录 ./dist/

类型 说明
tar.gz edgex-{version}-{os}-{arch}.tar.gz,含二进制、conf/scripts/edgex.serviceedgex.shui/dist/
deb edgex-v{version}-{arch}.deb,安装至 /usr/local/bin/edgex,含 systemd 单元与前端静态资源
SHA256SUMS 各产物校验和

手动编译(开发 / 单平台)

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 ..

2. 目录与配置

路径 说明
data/ 运行时数据目录;config.db 存储配置(首次启动为空则进入安装向导)
logs/ 运行日志(默认 logs/gateway.edgex.log
conf/ 遗留 YAML 配置,用于一次性迁移(-conf 参数指定,默认 ./conf

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

3. 启动服务

# 默认配置目录 ./conf,HTTP 端口见 server 配置(常见 8080/8082)
./edgex

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

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

4. 生产部署参考


文档索引

类别 链接
文档站点(GitHub Pages) https://anviod.github.io/edgex/
开发原则与验收标准 在线阅读 · 源码
分阶段路线图 在线阅读 · 源码
版本发布门禁 在线阅读 · 源码
驱动文档 在线阅读 · 源码
部署指南 在线阅读 · 源码
架构设计 在线阅读 · 源码
开发计划 / TODO docs/TODO/(未发布至 Pages)
Q3 南向采集优化方案 docs/[TODO]边缘计算南向采集优化方案2026第三季度.md(未发布至 Pages)
测试验证 在线阅读 · 源码 · test/ 维护
运维参考 在线阅读 · 源码

分支与协作

日常开发在 **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

Extension points exported contracts — how you extend this code

Driver (Interface)
Driver is the unified interface for all protocol drivers [28 implementers]
internal/driver/interface.go
StorageInterface (Interface)
StorageInterface defines the storage interface [24 implementers]
internal/sync/domain_sync.go
PersistBackend (Interface)
PersistBackend persists network configuration through OS-specific tools. [5 implementers]
internal/network/backend.go
ProtocolAdapter (Interface)
ProtocolAdapter 协议适配器接口 [4 implementers]
internal/core/protocol_adapter.go
SouthboundManager (Interface)
SouthboundManager interface defines methods required by Northbound components to interact with southbound devices (e.g. [3 …
internal/model/types.go
VirtualShadowLister (Interface)
VirtualShadowLister supplies virtual shadow device configs for OPC UA address space. [1 implementers]
internal/northbound/opcua/server.go
ObjectScanner (Interface)
ObjectScanner is an optional interface for drivers that support object/point discovery on a device [5 implementers]
internal/driver/interface.go
NetworkAdapter (Interface)
NetworkAdapter defines the interface for OS-specific network operations [3 implementers]
internal/network/adapter.go

Core symbols most depended-on inside this repo

Error
called by 425
internal/pkg/dataformat/format.go
Status
called by 349
internal/network/dns_proxy.go
String
called by 326
internal/model/types.go
Error
called by 284
internal/driver/bacnet/encoding/decoder.go
Run
called by 235
internal/core/scan_engine.go
Close
called by 201
internal/driver/omron/fins.go
String
called by 194
internal/driver/bacnet/btypes/null/null.go
Load
called by 184
internal/core/virtual_shadow_manager.go

Shape

Function 2,776
Method 2,737
Struct 558
TypeAlias 42
Interface 28
FuncType 9
Class 7

Languages

Go94%
TypeScript4%
Python1%

Modules by API surface

internal/server/server.go134 symbols
internal/driver/opcua/opcua.go85 symbols
internal/core/edge_compute_manager.go81 symbols
internal/sync/sync_manager.go76 symbols
internal/core/channel_manager.go76 symbols
internal/core/scan_engine.go75 symbols
internal/model/types.go66 symbols
internal/driver/omron/fins.go58 symbols
internal/driver/s7/transport_test.go55 symbols
internal/northbound/edgos_mqtt/client.go52 symbols
test/ethernet_ip_server_v3.py51 symbols
internal/driver/modbus/transport.go49 symbols

For agents

$ claude mcp add edgex \
  -- python -m otcore.mcp_server <graph>

⬇ download graph artifact

Ask about this repo answers extend the page