quick start

从下载到第一个点。

两步安装,一个测试。先确认“通不通、值是多少”,再决定要不要装场景、接更多设备。 全程离线可做;终端不需要访问 GitHub。

downloads

先下这两个。

客户端装好就是一个可用的空终端。需要更多能力时,从插件页装驱动或场景插件。

01 · 必装

Windows 客户端

Windows 10/11 x64

安装包,装好打开就是完整界面:存储、设备底座、语义 UI 与设备管理页已内置。未做商业代码签名,SmartScreen 可能提示“未知发布者”。

下载安装包
02 · 按需

驱动与插件

ModbusTCP / EtherNet/IP · 插件生态

建设备前先装一个通讯驱动:在线在「插件管理」搜索安装,离线从插件页取驱动 zip 拖入。

浏览插件与驱动

安装包未做商业代码签名;企业可自行签名。安装包、驱动与插件 zip 都可以离线拷贝; feed 同源,客户端内“软件更新”走同一目录。

the first run

四步,跑通一个点。

安装只有一步;后续是“装驱动 → 建设备 → 测连接 → 建点”,每一步都可在车间离线完成。

01

装客户端

双击安装包。SmartScreen 提示时点“更多信息 → 仍要运行”。装完打开就是完整界面——存储、设备底座、设置中心与设备管理页都已内置。

首次启动
无需装基座;需要更多能力时再拖入插件 zip
02

装驱动

「设置 → 插件管理」搜索安装 ModbusTCP 驱动(范本);离线现场把 driver-modbus 的 zip 拖进「安装插件」。

插件管理 → 安装插件
ModbusTCP 驱动 · 可多装共存

驱动是纯协议适配器:设备、组、点都住在底座表里,驱动卸载不丢配置。

03

新建设备,点“测试连接”

设置 → 设备管理 → 新建设备。选 ModbusTCP,填 IP、端口、单元号,点“测试连接”。

✓ 连接成功 · 12 ms
Unit 1 · FC3 @ 0 = 1843

失败也能先保存;按提示检查 IP、端口、防火墙、单元号。部分 PLC 只允许单连接,测试前先停用已有设备。

04

套模板,建点

保存设备后,点“从模板添加点位”。示例给 count / rate / running;地址按设备手册改。

line / count
FC3 @ 0 · int · 实时刷新

没有模板的驱动,也可以手动新建分组和点位;点位地址 = (设备, 组, 点) 三元组。

where things live

东西都在哪。

现场排查时,先知道文件在哪、状态从哪看。

要找什么在哪说明
数据 / 配置%APPDATA%\snap-railSQLite 库、settings.json、presets、插件池;可用 SNAP_RAIL_HOME 改。
插件池%APPDATA%\snap-rail\plugins每个插件一个目录;安装/卸载走客户端,不建议手改。
场景预设%APPDATA%\snap-rail\presets组合包安装后写入 recipe-<id>.yml;删除即停用。
插件源设置 → 插件 → ⚙静态目录/Release 地址,可加多个;没网就留空,用 zip。
连接状态设置 → 设备管理设备在线灯、组健康灯、点位实时值;驱动未加载会显示“驱动未加载”。

troubleshooting

连不上时,先看这四行。

错误文案按“人话 + 下一步”写;先排除最常见的原因,再动设备。

现象先检查下一步
连接超时IP、端口、网线、防火墙;PLC 是否只允许一个连接先在 PC 上 ping 通,再用测试连接
连接被拒绝端口是否开在 PLC 上;ModbusTCP 默认 502,EtherNet/IP 默认 44818核对设备手册 / PLC 以太网设置
Modbus 异常码地址是否存在、功能码是否匹配、单元号是否正确按异常码查地址表;先用一个已知寄存器试
“驱动未加载”驱动插件是否安装/启用;设备页是否已重启插件页启用驱动,重启一次

next

跑通一个点之后。

你可以继续接更多设备、装场景包,或者开始做自己的插件。

MORE DEVICES

接第二条线

复制设备结构,改地址/单元号;组和点可以按工艺重命名。一个终端可以管多台设备。

看场景怎么组织
SCENE PACK

装一个场景包

场景包把驱动、页面与套件打成一组;用插件 SDK 自建,或从社区插件源安装别人做好的场景。

看场景包
BUILD YOUR OWN

做自己的插件

驱动、界面、套件都可以独立发布;用你自己的密钥签名,自己的插件源分发。

看插件开发
snap-rail Windows 客户端
下载客户端