有关 API 的更多详细信息
常规
内部和外部访问都支持 Web 服务命令。
当前的迷你服务器也支持 HTTPS。
Web 服务命令的结构如下:
http://Benutzer:Passwort@IPAdresseMiniserver/command/control/value
因此,在使用 HTTP (Miniserver Gen.1) 时,在地址栏中输入命令时,应暂时省略访问数据。
某些命令需要具有完全访问权限的用户的凭证。
之后,执行命令并在浏览器中显示结果。
在下面的示例中,我们获取迷你服务器的当前软件版本:
代码 “200” 表示该命令已被接受和处理。
结构详解
- “control”:可以是任何输入或输出(包括虚拟输入和输出)。但是,输出只能用于状态查询。
- “value”:如果 'value' 不存在,则返回控件的当前值。值允许使用以下值:'On'、'On'、'Off'、'Pulse'、'Pulse' 或小数值(带小数位)。(只有有权更改相应对象的用户才能通过 Web 服务更改此对象的值)
- 对于具有 2 个输出(上下、左右)的数字虚拟输入,值如下:
ImpulsPlus ImpulsMinus |
PulseUp 脉冲下 |
ImpulseOn impulseFrom |
脉冲打开 脉冲关闭 |
PlusA PlusOff |
UpOn UpOff |
在 A 向上 |
OpenOn OpenOff 开场 |
减 A 减 Off |
DownOn DownOff |
AbA AbOff 公司 |
CloseOn 关闭 |
- 对于数字输入和输出,“On”始终为 1,“Off”始终为 0。
- 模拟 (0-10V) 输入在 0 到 10.00 之间工作。没有正式的限制(例如 EIB 温度,如 21.5 或 -5.2)。
- 该点用作输出的小数点。
状态和切换
控件的状态查询
命令 | http://miniserver/dev/sps/io/LichtWohnzimmer/state |
功能 | 提供收据的状态 |
答 | <LL control=“dev/sps/io/LichtWohnzimmer” value=“0” Code=“200”/> |
命令 | http://miniserver/dev/sps/io/LichtWohnzimmer/astate |
功能 | 返回关联输出的值(所有值的唯一值 – 或 ?不同值) |
答 | <LL control=“dev/sps/io/LichtWohnzimmer” value=“1” Code=“200”/> |
命令 | http://miniserver/data/status |
功能 | 列出连接到迷你服务器的所有设备及其状态。 |
答 | <状态修改=“”> <迷你服务器名称=“迷你服务器办公室” internalname=“” IP=“” mask=“” gateway=“” DHCP=“” DNS1=“” DNS2=“” MAC=“” device=“” version=“> <扩展名称=”“ internalname=”“ serial=”“ version=”“ online=”“/> </miniserver> </status> |
通过 Web 服务进行状态查询仅适用于输入和输出,而不适用于程序模块。
开关
命令 | http://miniserver/dev/sps/io/TasterLichtWohnzimmer/Ein |
功能 | 切换模拟或数字输入 |
答 | <LL control=“dev/sps/io/ButtonLightLiving Room” value=“1” Code=“200”/> |
如果需要可视化密码,则必须以加密方式发送命令。您可以在我们的 API 文档中找到有关此内容的更多详细信息。
查询状态更改
命令 | http://miniserver/dev/sps/enablestatusupdate |
功能 | 允许您在 websockets 中自动发送状态更改。 |
答 | 通过 websockets 发送当前状态。 |
配置和统计
PLC 命令
命令 | 功能 | 需要完全控制吗? |
http://miniserver/dev/sps/state | PLC 状态查询
0 – 无状态 |
X |
http://miniserver/dev/sps/status | 查询当前 PLC 频率 | X |
http://miniserver/dev/sps/restart | 重新启动 PLC | ✓ |
http://miniserver/dev/sps/stop | 停止 PLC | ✓ |
http://miniserver/dev/sps/run | 恢复 PLC | ✓ |
http://miniserver/dev/sps/log | 允许 PLC 全局日志记录 | ✓ |
http://miniserver/dev/sps/enumdev | 列出 PLC 的所有设备(Miniservers、Extensions,...) | ✓ |
http://miniserver/dev/sps/enumin | 列出 PLC 的所有输入 | ✓ |
http://miniserver/dev/sps/enumout | 列出 PLC 的所有输出 | ✓ |
http://miniserver/dev/sps/identify | 对于 扩展,序列号必须作为参数输入。 |
✓ |
CONFIG 命令
命令 | 功能 | 需要完全控制吗? |
http://miniserver/dev/cfg/mac | 获取 MAC 地址 | X |
http://miniserver/dev/cfg/version | 获取固件版本 | X |
http://miniserver/dev/cfg/versiondate | 获取固件创建日期 | X |
http://miniserver/dev/cfg/dhcp | 获取 DHCP 配置 | ✓ |
http://miniserver/dev/cfg/ip | 获取 IP 地址 | ✓ |
http://miniserver/dev/cfg/mask | 获取 IP 掩码 | ✓ |
http://miniserver/dev/cfg/gateway | 获取网关地址 | ✓ |
http://miniserver/dev/cfg/device | 获取迷你服务器设备名称 | ✓ |
http://miniserver/dev/cfg/dns1 | 获取 DNS 地址 1 | ✓ |
http://miniserver/dev/cfg/dns2 | 获取 DNS 地址 2 | ✓ |
http://miniserver/dev/cfg/ntp | 获取 NTP 地址 | ✓ |
http://miniserver/dev/cfg/timezoneoffset | 获取时区偏移量 | X |
http://miniserver/dev/cfg/http | 获取 HTTP 端口 | ✓ |
http://miniserver/dev/cfg/ftp | 获取 FTP 端口 | ✓ |
http://miniserver/dev/cfg/LoxPLAN | 获取配置软件端口 | ✓ |
http://miniserver/dev/cfg/ftllocalonly | 获取“FTP、Telnet、仅允许本地访问软件” | ✓ |
系统命令
命令 | 功能 | 需要完全控制吗? |
http://miniserver/dev/lan/txp | 获取发送的 LAN 数据包数 | ✓ |
http://miniserver/dev/lan/txe | 具有 Fetch 错误的 LAN 发送数据包数 | ✓ |
http://miniserver/dev/lan/txc | 检索 LAN 发送的冲突数据包数 | ✓ |
http://miniserver/dev/lan/exh | 获取 LAN 缓冲区错误数 | ✓ |
http://miniserver/dev/lan/txu | 获取 LAN 欠载错误的数量 | ✓ |
http://miniserver/dev/lan/rxp | 获取 LAN 接收的数据包数 | ✓ |
http://miniserver/dev/lan/eof | 获取 LAN EOF 错误数 | ✓ |
http://miniserver/dev/lan/rxo | 获取 LAN 接收溢出错误的数量 | ✓ |
http://miniserver/dev/lan/nob | 获取 LAN“无接收缓冲区”错误的数量 | ✓ |
http://miniserver/dev/bus/ 数据包发送 |
获取通过 Loxone 链接发送的包裹数量 | ✓ |
http://miniserver/dev/bus /packetsreceived |
在 Loxone 链路上获取接收的数据包数 | ✓ |
http://miniserver/dev/bus/ receiveerrors |
获取 Loxone 链接上的接收错误数 | ✓ |
http://miniserver/dev/bus/ frameerrors |
获取 Loxone 链接上的帧错误数 | ✓ |
http://miniserver/dev/bus/ 超限 |
获取 Loxone 链接上的溢出错误数 | ✓ |
http://miniserver/dev/bus/ parityerrors |
获取 Loxone 链接上的奇偶校验错误数 | ✓ |
http://miniserver/dev/sys/ numtasks |
获取任务数 | ✓ |
http://miniserver/dev/sys/cpu | 获取 CPU 负载 | ✓ |
http://miniserver/dev/sys /contextswitches |
获取任务之间的切换次数 | ✓ |
http://miniserver/dev/sys /contextswitchesi |
获取中断触发的任务之间的切换次数 | ✓ |
http://miniserver/dev/sys/heap | 获取存储大小 | X |
http://miniserver/dev/sys/ints | 获取系统中断数 | ✓ |
http://miniserver/dev/sys/comints | 获取通信中断数 | ✓ |
http://miniserver/dev/sys/lanints | 获取 LAN 中断数 | ✓ |
http://miniserver/dev/sys/watchdog | 获取看门狗位 | ✓ |
http://miniserver/dev/sys/date | 返回本地日期 | ✓ |
http://miniserver/dev/sys/time | 提供当地时间 | ✓ |
http://miniserver/dev/sys/ setdatetime |
设置系统日期和时间 格式:2010-04-20 14:35:00 或 2010/20/04 14:35:00 注意:发布日期之后只能设置一个日期。示例:无法设置 2012 年 12 月 20 日>日期 19.12.2012 的版本。 |
✓ |
http://miniserver/dev/sys/spscycle | 获取 PLC 周期数 | ✓ |
http://miniserver/dev/sys/ntp | 推送 NTP 请求 | ✓ |
http://miniserver/dev/task0/name | 任务 0 获取 名称 (0- http://nubuserver/dev/sys/numtasks – 1) |
✓ |
http://miniserver/dev/task0/priority | 获取任务 0 优先级 | ✓ |
http://miniserver/dev/task0/stack | 获取任务 0 堆栈 | ✓ |
http://miniserver/dev/task0 /contextswitches |
任务 0 获取交换机数量 | ✓ |
http://miniserver/dev/task0/ waittimeout |
获取任务 0 等待时间(毫秒) | ✓ |
http://miniserver/dev/task0/state | 获取任务 0 状态 | ✓ |
http://miniserver/dev/sys/reboot | 启动迷你服务器 | ✓ |
http://miniserver/dev/sys/check | 显示活动的 Loxone Config 连接 | X |
http://miniserver/dev/sys/logoff | 断开现有 Loxone Config 连接 | ✓ |
http://miniserver/dev/sys/sdtest | 测试 SD 卡 | ✓ |
http://miniserver/dev/sys/lastcpu | 显示 CPU 利用率的最后一个值和 PLC 周期数 | ✓ |
http://miniserver/dev/sys /searchdata |
列出搜索结果 | X |
http://miniserver/dev/fslist/ | 列出 SD 卡的根目录 | ✓ |
http://miniserver/dev/fslist/path/ | 列出 SD 卡上的目录 “path” | ✓ |
http://miniserver/dev/fsget/filepath | 检索文件(将 FilePath 替换为 filename) | ✓ |
http://miniserver/dev/fsdel/filepath | 删除文件(将 FilePath 替换为 filename) | ✓ |
http://miniserver/data/status | 显示迷你服务器和所有扩展的状态 | X |
http://miniserver/stats | 显示统计数据 | ✓ |
http://miniserver/data/weatheru.xml | 显示天气数据(仅适用于 Active Weather Service) | X |
http://miniserver/data/LoxAPP3.json | 用于可视化的结构文件 | X |
http://miniserver/dev/fsget/log/def.log | 获取日志 | ✓ |
http://miniserver/dev/sys/ ExtStatistics/05000001 |
获取1-Wire扩展的统计信息(05000001替换为扩展的序列号) | ✓ |
http://miniserver/dev/sys/ AirStatistics/0C000001/DeviceIndex |
获取 Air 设备的统计信息(将 0C000001 替换为分机的序列号) | ✓ |
设备命令
以下命令适用于特定的 Air 或 Tree 设备。
需要具有完全访问权限的用户的访问数据。
http://miniserver/dev/sys/wsdevice/serial/ForceUpdate | 强制更新设备的固件 |
http://miniserver/dev/sys/wsdevice/serial/Reboot | 重新启动设备 |
但是,Loxone Config 中的设备名称也可以在此处使用。
为此,它必须是唯一的,并且不能包含任何特殊字符。
在 iFrame 中使用 Web 界面
要在 iFrame 中使用迷你服务器的 Web 界面,必须使用以下 Web 服务激活它,因为出于安全原因,默认情况下不允许使用 iframe。
http://miniserver/dev/sys/allowhttpiframe/1