SIEMENS西门子 5SL系列小型断路器230-400V 6kA 5SL6310-6CC
什么是 Web API? 在我们理解什么是 Web API 之前,我们先看看什么是 API:在计算机编程 领域,API (application programming interface)是一类提供指定功能,提 供特殊能力的函数集合,可以用来操作数据,系统和设备。 Web API 是一个很宽泛的概念,如同名字所示,是通过 Web 服务的 HTTP 协议通道来提供 API 能力的特性。 SIMATIC S7-200 SMART SR/ST 0AA1 系列 CPU 上,所实现的 Web API 是 一个标准的 JSON-RPC 规范的 API 特性,遵循 JSON-RPC 2.0 规范.JSON (java-script object notation): 一个轻量级的数据交换格式,简洁清 晰,易于读取,易于解析。 JSON-RPC 2.0: 一种开放性 API 框架,也是一个轻量级、无状态的远程调 用协议。
● 在放置地线时,还必须考虑安全接地要求以及保护性断开设备的正确操作。 ● 在大多数网络安装中,如果将 CPU 传感器电源 M 端子接地,可以获得zuijia抗扰性。 以下介绍了 S7-200 系列的常规隔离特性,但特定产品的某些特性可能会有所不同。有关 哪些电路包含隔离边界以及这些边界的额定值的信息,请参阅相应手册中的产品规范。额 定值小于 1,500 VAC 的隔离边界只能用作功能性隔离,而不能用作安全边界。 ● 逻辑电路的参考值与 DC 传感器电源 M 值相同。 ● 逻辑电路的参考值与带 DC 电源的 CPU 上的输入电源 M 值相同。 ● CPU 通信端口与逻辑电路具有相同的参考值。 ● 模拟量输入、输出与逻辑电路不隔离。模拟量输入采用全差动式,用于提供低电压共 模衰减。 ● 逻辑电路与地线隔离,隔离电压为 500 VAC。 ● DC 数字量输入、输出与逻辑电路隔离,隔离电压为 500 VAC。 ● DC 数字量 I/O 组相互隔离,隔离电压为 500 VAC。 ● 继电器输出与逻辑电路隔离,隔离电压为 1500 VAC。 ● 继电器输出组相互隔离,隔离电压为 1500 VAC。 ● AC 电源线、零线与地线、逻辑电路和所有 I/O 隔离,隔离电压为 1500 VAC。
2 Web API 能做什么? Web APIs 提供了Zui基本的远程访问 CPU 数据的能力,根据 Web 用户权限 控制,你可以远程读写 CPU 的数据。 因此,你可以将 Web API 能力集成到你的自定义网页,终端脚本,应用 程序中以管理你的 CPU。 2.1 实时控制 • 读写 CPU 数据。 • 调整 CPU 时间。能够: • 你可以在 CPU 运行时读写 CPU 主要的数据区,因此你能够在运行 时动态调整用户程序参数。 • 你可以手动触发、移除一些信号,与用户程序相配套时能够简化 用户程序逻辑,比如,清除业务告警灯,调整温控限。 • 你可以同步时钟,比如,由于 CPU 电池没电导致的时钟丢失。2.2 网络管理 • 远程监控。 • 中心化监控。 • 多终端监控。 能够: • 你可以在远程修复一些错误问题、逻辑流程,而不需要去实地站 点。 • 你可以和其他管理员,通过配置不同的用户和不同的权限,共享 管理同一个 CPU。 • 你可以同时远程管理多个 CPU。
3 配置 Web API 要在一个全新的 CPU 上使用 Web API,你需要通过 STEP 7-Micro/WIN 做 一些必要的 Web 配置。提示:你需要确保将你的 CPU 和 STEP 7-Micro/WIN 都升级到 V2.7 或更 高版本! 1. 通过 STEP 7-Micro/WIN 连接到 CPU 需要确保你的 STEP 7-Micro/WIN(PC)和 CPU 之间的通信是正常的。 2. 激活 Web Server 和 Web API 1) 在 STEP 7-Micro/WIN 中打开 Web server 向导。 2) 在向导中,选中“激活 Web 服务器”。 3) 输入要连接的 CPU 模块的 IP 地址和站名称(可选)。 4) 选中“第三方程序接口和用户自定义网页(CPU 数据可读)”,设置 用户自定义 Web 页面 CPU 数据的读取权限。3. 配置 Web server 用户 1) 点击导航栏中的 “用户管理” ,进入用户管理页面。 2) 点击 “增加” 添加新的 Web 用户。你可以Zui多添加 4 个 Web 用户。 S7-200 SMART Web API 开发手册 9 3) 在弹出框中输入用户名和密码,在权限配置页面中配置你需要的权 限。 4) 点击 “生成” 保存配置。4. 下载配置到 CPU5. 添加 TLS 证书 要使用 S7-200 SMART CPU 的 Web server 服务,你需要先在 STEP 7- Micro/WIN SMART 的证书管理向导中配置 TLS 证书。 STEP 7-Micro/WIN SMART 提供两种证书配置方案: • “外部证书” 方案,设备证书由用户提供的证书颁发机构(CA)签 名。 • “内部证书”方案,设备证书由 CPU 生成的证书颁发机构 (CA) 签 名。
4 Web API 基本功能 在使用 Web API 之前,你需要先了解一下基本知识。 4.1 API 列表 当前 Web API 的版本是 V1.0.0。API 使用建议 列表 描述 login 用户登录,成功登录之后可以访问 CPU。 logout 用户登出,成功登出之后用户的临时 cookie 将失效。 get_permission 用户登录成功后,可用于获取用户的权限列表。 read 从 CPU 中读取数据。 write 向 CPU 中写入数据。 browse 访问 CPU 支持的 API 的列表。 建议 建议描述 控制调用频率 推荐调用 API Zui快一秒一次。 Web API 的处理会占用部分 CPU 资源:网络、TLS 加解密、JSON 解 析、业务检查等,调用过快会导致请求阻塞。 压缩 JSON 文本 推荐使用压缩后的 JSON 文本。 JSON 压缩之后会变得更小,能提高信息传输效率。 高效利用 API 请求 推荐在一次 API 调用中,尽可能多的携带数据。 Web 请求支持很大的缓冲区,同时一次请求Zui多能支持到 32 个数据的 读写处理,所以降低请求次数的频率,提升单次请求数据的效率。 使用 HTTP 长连接 推荐使用 HTTP 长连接。 新建 TLS 的连接会占用很多 CPU 资源,建立连接时间也会较长,在既 有连接上传输数据的效率远高于新建连接。4.3 API 通用模板 1. 所有 API 数据都需要使用 UTF-8 编码。 2. 整体 HTTP 负载长度不能超过 15 KB。 下面是 JSON-RPC 2.0 API 的通用模板。 4.3.1 JSON-RPC 请求模板4.4 API 使用限制 1. HTTP 的 URL 必须是"https://ip_address/Web_api"。 2. 所有的 HTTP 数据必须使用 UTF-8 来编码。 3. HTTP 头部的 Content-Type 必须是"application/json"。 4. HTTP 的方法必须是 POST。 5.当前 Web API V1.0.0 版本不支持批量 API 请求模式。 5 login 调用登录接口时 CPU 会检查用户信息,如果登录成功会返回一个随机生 成的用户 cookie,该 cookie 用于后续的 API 交互。 5.1 使用说明 a.需要提前配置好 Web 用户。 b. 重复登录同一用户,会导致该用户之前的 cookie 失效。 c. 已登陆用户半个小时内无操作会被自动登出使用样例 测试须知: • 这是一个 Windows Powershell 脚本,所以只能在 Powershell 终端上使用。 • 脚本使用了 curl 命令,测试机器上需要集成 curl 工具。 • 脚本使用了假想的用户和 IP,你需要修改成真实的用户和 IP 地 址。• 这是一个 Windows Powershell 脚本,所以只能在 Powershell 终端上使用。 • 脚本使用了 curl 命令,测试机器上需要集成 curl 工具。 • 脚本使用了假想的用户和 IP,你需要修改成真实的用户和 IP 地 址。• 这是一个 Windows Powershell 脚本,所以只能在 Powershell 终端上使用。 • 脚本使用了 curl 命令,测试机器上需要集成 curl 工具。 • 脚本使用了假想的用户和 IP,你需要修改成真实的用户和 IP 地 址。8.1 使用说明 8.2 API 请求格式 a. 用户必须已经成功登录,并且已获取用户标识 cookie。 b. 必须将用户 cookie 标识设置到 HTTP 头部的 cookie 字段。 c. 一次请求Zui多可以读取 32 个数据节点。 d. 可以发送空请求用于读取系统状态。 参数 说明 params JSON 数组,每一个节点都标识了要读取的一个数据,Zui多可同时读取 32 个数据节点。 type "type" 标识要读取的数据类型,当前版本只支持读取具体地址,可以缺 省。