跳转至主要内容

设置参考

本文档列出了该端点的所有设置 /settings/ 返回,带有她的 Schlüssel, 她的 Typ (摘自 type_hint) 以及她们的 限制 (摘自 metadata.constraint.range + locked(如适用)。

Eine locked-设置是 运行时仅可读. 可以通过配置文件或通过的设置页面进行设置 Haply Hub 可以进行修改,但是 要使更改生效,必须完全重启该服务. 这些设置在下表中以 启动 标记为。

配置​

用于在服务启动时覆盖设置的配置文件位于此处:

平台存储位置
WindowsC:\ProgramData\Haply\Inverse\haply-inverse-service-config.json
macOS/Library/Application Support/Haply/Inverse/haply-inverse-service-config.json
Linux/etc/haply-inverse-service/haply-inverse-service-config.json

该配置文件是一个 扁平化的 JSON 对象,该函数将设置键映射到覆盖值。键必须是有效的设置键,且由 /settings/ 应返回 HTTP-Route(参见 API 参考). 未指定的键将使用该服务的默认值。

例如,覆盖网络配置:

{
"communication/http/port": 8400,
"communication/websocket/port": 8500,
"communication/events/port": 9000,
"communication/bind_all_interfaces": true
}

类型映射​

API 返回的类型信息对应以下 JSON 类型:

  • STRING → string
  • BOOL → bool
  • INT → int
  • FLOAT → float
  • ARR_STRING → string[]
  • VEC3 → vec3 (对象带有 {x, y, z})
  • GENERIC → json (任意结构化值)

communication/…​

HTTP、WebSocket 和事件流服务器的网络端口和绑定地址。大多数配置项仅在启动时(boot)生效。

SchlüsselTyp限制描述
communication/serial/enabledbool—启用或禁用串行设备通信。
communication/bind_addressstring启动HTTP 和 WebSocket 服务器所绑定的 IP 地址。
communication/bind_all_interfacesbool启动服务器 an 0.0.0.0 而不是绑定到 localhost。
communication/http/portint启动HTTP-REST-API 的端口(标准: 10000).
communication/websocket/portint启动WebSocket v3.1 的主端口(标准: 10001).
communication/websocket/legacy_portint启动WebSocket v3.0 的兼容端口(标准: 10000).
communication/events/portint启动WebSocket 事件流的端口(默认: 10020).

devices/…​

devices/detection/…​

串行端口扫描指南。所有选项均为高级设置。

SchlüsselTyp限制描述
devices/detection/scan_period_msint范围 100–10000;启动串行端口的扫描间隔(毫秒)。
devices/detection/handshake_timeout_sint第1–15区每个端口的握手超时时间(秒)。
devices/detection/max_retriesint范围 1–10每个端口的握手重试最大次数。
devices/detection/failure_log_delay_sint范围 1–60在再次记录识别错误之前所需的延迟时间(s)。
devices/detection/block_looping_portsbool—当检测到循环端口时,阻止设备就绪。
devices/detection/excluded_portsjson—在检测过程中被跳过的串行端口路径。
devices/detection/additional_portsstring[]—始终会被扫描的串行端口附加路径。
devices/detection/allowed_vendor_id_filterstring[]—在端口枚举中允许使用的 USB 供应商 ID。
devices/detection/port_name_substring_filterstring[]—用于过滤的、特定于平台的端口名称子字符串。
devices/detection/wireless_verse_grip_description_filterstring[]—用于识别 Wireless-VerseGrip 的端口描述子字符串。
devices/detection/inverse3x_description_filterstring[]—用于识别 Inverse3x 的端口描述子字符串。
devices/detection/extra_ports (过时)string[]—相反 devices/detection/additional_ports 使用。读写操作将透明地转发至规范键。

devices/inverse*/…​

适用于Inverse3 系列所有设备的全局默认值。会话级别的覆盖设置具有优先级。

SchlüsselTyp限制描述
devices/inverse*/filters/force_scale/gainfloat范围 0.0–2.0适用于所有设备的全球功率输出乘数。
devices/inverse*/filters/force_gate/gainfloat范围 0.0–1.0新会话中Kraft-Gate的标准增益。
devices/inverse*/control_timeout_msint范围 50–10000解除设备控制锁定的超时时间(毫秒)。
devices/inverse*/query_orientation_on_idlebool—通过固件查询设备在空闲状态下的机身朝向。

devices/presets​

SchlüsselTyp限制描述
devices/presetsjson—按设备类型划分的标准设备配置(安装转换、基础配置等,用于 inverse_arm_front_*, inverse_led_front_*, minverse_*, verse_grip_default, wireless_verse_grip_default, custom_verse_grip_default).

devices/wireless_verse_grip/…​

SchlüsselTyp限制描述
devices/wireless_verse_grip/battery/low_thresholdint—电池电量百分比阈值,当电量低于该阈值时,将触发低电量警告。
devices/wireless_verse_grip/battery/critical_thresholdint—电池电量百分比阈值,当电量低于该阈值时,将触发电池电量临界警报。
devices/wireless_verse_grip/battery/reset_marginint—在电池警告被重置之前的滞后余量。
devices/wireless_verse_grip/filters/orientation_filterjson启动配置“一欧元滤镜”以调整 Wireless-VerseGrip 的方向。

features/…​

features/calibration/…​

SchlüsselTyp限制描述
features/calibration/hall_thresholdint范围 1–32霍尔传感器电平,当校准时,当电平达到该值时,即视为插头已插入。

features/grip_hook/…​

“抓钩”的自动行为——只要保持抓钩竖直,光标就会被锁定。

SchlüsselTyp限制描述
features/grip_hook/enabledbool—当握柄保持竖直时,激活Grip-Hook的自动锁定功能。
features/grip_hook/use_hallbool—在手势识别中,使用霍尔传感器的阈值代替方向信息。
features/grip_hook/hallint范围 1–32霍尔传感器阈值,该阈值会触发手柄锁定。
features/grip_hook/hold_durationint范围 10–1000锁定状态在触发后保持的时间(毫秒)。

features/navigation/bubble/…​

气泡导航模块的默认值——一旦出现……,就会被传递给会话。 bubble-该行为首次被激活时。

SchlüsselTyp限制描述
features/navigation/bubble/centervec3—气泡中心的标准位置。
features/navigation/bubble/max_velocityfloat—该限速区域内的最高行驶速度(米/秒)。
features/navigation/bubble/velocity_zone_widthfloat—气泡表面以外的速度区域的宽度(米)。
features/navigation/bubble/reset_velocity_on_entrybool—当光标进入气泡时,将速度重置为零。
features/navigation/bubble/spring_innerfloat—气泡中心的费米系数(N/m)。
features/navigation/bubble/spring_surfacefloat—气泡表面的费米系数(N/m)。
features/navigation/bubble/spring_outerfloat—外边界处的费德尔系数(N/m)。
features/navigation/bubble/damping_innerfloat—气泡中心处的阻尼系数(Ns/m)。
features/navigation/bubble/damping_surfacefloat—气泡表面的阻尼系数(Ns/m)。
features/navigation/bubble/damping_outerfloat—外边界处的阻尼系数(Ns/m)。
features/navigation/bubble/wall_stiffnessfloat—外边界处硬壁的刚度(N/m)。
features/navigation/bubble/bump_widthfloat—气泡表面触觉凸起的宽度(米)。
features/navigation/bubble/bump_stiffnessfloat—气泡表面凸起处的刚度(N/m)。

features/safe_trajectory/…​

末端执行器运动的速度限制器。

SchlüsselTyp限制描述
features/safe_trajectory/enabledbool—启用速度限制器以确保行驶轨迹安全。
features/safe_trajectory/max_velfloat范围 0.01–2.0末端执行器的最大允许速度(m/s)。

features/screensaver/…​

在Inverse3 设备上,当没有会话进行控制时,空闲状态下播放的动画。

SchlüsselTyp限制描述
features/screensaver/enabledbool—在Inverse3 设备上启用空闲状态屏保动画。
features/screensaver/speedfloat范围 0.001–0.2屏保动画的速度。
features/screensaver/distracted_speedfloat范围 0.001–0.2当用户位于附近但未进行交互时,动画的速度。

features/sdf/…​

基于有符号距离场(SDF HFX)的触觉效果模块。

SchlüsselTyp限制描述
features/sdf/enabledbool—启用或禁用 SDF 触觉效果模块。
features/sdf/state_outputbool—默认将 SDF 状态包含在设备的输出有效载荷中。
features/sdf/max_countint范围 0–128SDF 效果的最大数量(0 = 无限制)。
features/sdf/events/createdbool—在创建新的 SDF 效果时触发一个事件。
features/sdf/events/deletedbool—当删除一个 SDF 效果时,会触发一个事件。
features/sdf/events/updatedbool—当 SDF 效果被更新时,会触发一个事件。
features/sdf/probe_on_zero_force/enabledbool—当施加的力接近零时,自动查询SDF场。
features/sdf/probe_on_zero_force/delayfloat范围 0.001–60.0力降至零后,自动检测前的延迟(s)。

features/verse_grip_pairing/…​

记录Inverse3 与Verse Grip(有线或无线)之间的连接和断开状态。基于Haply Hub的配对界面。

SchlüsselTyp限制描述
features/verse_grip_pairing/enabledbool—启用连接或断开操作的记录功能。
features/verse_grip_pairing/hall_threshold_vgint范围 1–32霍尔电平——达到该电平时,有线VerseGrip即被视为已连接。
features/verse_grip_pairing/hall_threshold_wvgint范围 1–32霍尔电平——达到该电平时,无线VerseGrip即被视为已连接。
features/verse_grip_pairing/detach_debounce_msint范围 0–1000在断开连接被确认之前的时间窗口(毫秒)。
features/verse_grip_pairing/heartbeat_msint范围 100–10000强制重新通知之间的间隔(毫秒)。
features/verse_grip_pairing/force_attachedbool—强制将状态永久设为“已连接”(true) 并绕过霍尔传感器(硬件故障时的解决方法)。

serialization/…​

转换输出的格式设置——涉及 WebSocket 和 HTTP JSON 的有效载荷。

SchlüsselTyp限制描述
serialization/explicit_fieldsbool—将符合其身份默认值的转换字段包含在序列化输出中(例如: position: {0,0,0}, rotation: {w:1,…}). 当您的客户端要求所有字段都必须明确存在时,此功能非常有用。默认值: false.
serialization/force_complete_transformsbool—每次转换输出中总是包含 position, rotation und scale 此外,对于仅能检测方向的设备(Verse Grip、Wireless Verse Grip)也是如此,除此之外仅 rotation 支出。包括 serialization/explicit_fields. 标准: false.

session/…​

会话调度程序和命令管道的限制值。

SchlüsselTyp限制描述
session/min_simulation_rate_hzint范围 20–500设备的最低可接受模拟频率(赫兹);若低于该值,将触发警告。
session/commands/zoh_window_msint—零阶保持窗口——抑制在此窗口内收到的查询(毫秒)。
session/commands/drop_warning_thresholdint—在该时间窗口内被丢弃的命令数量,达到该数量时将触发警告。
session/commands/drop_warning_window_msint—用于统计被丢弃命令的滑动窗口大小(毫秒)。
session/commands/tick_on_empty_batchbool—种一棵 main_loop-即使整个 WebSocket 批次被丢弃,也请勾选此选项。