Settings Reference
This document lists all settings returned by the /settings/ endpoint with their key, type (from type_hint), and **constraints
** (from metadata.constraint.range + locked where applicable).
A locked setting is read-only at runtime. It can be changed via the config file or through
the Haply Hub settings page, but a full service restart is required for changes to take
effect.
Configuration
The configuration file to override the settings during service startup is located here:
| Platform | Location |
|---|---|
| Windows | C:\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 |
The config file is a flat JSON object mapping setting keys to override values. Keys must be valid settings keys returned by the
/settings/ HTTP route.
Any key not specified uses the service default.
For example, here is a random networking configuration override:
{
"networking/http/port": 8400,
"networking/simulation/port": 8500,
"networking/events/port": 9000,
"networking/expose_servers_on_network": true
}
Type mapping
Type hint clarifications:
ARR_STRING→string[]VEC3→vec3(object with{x,y,z})GENERIC→json(arbitrary structured value)
TODO: Finish + descriptions
devices/…
| Key | Type | Constraints |
|---|---|---|
devices/detection/advanced/allowed_vendor_id_filter | string[] | — |
devices/detection/advanced/inverse3x_description_filter | string[] | — |
devices/detection/advanced/port_name_substring_filter | string[] | — |
devices/detection/advanced/wvg_description_filter | string[] | — |
devices/detection/blacklisted_ports | json | — |
devices/detection/block_on_loop | bool | — |
devices/detection/detection_failure_log_delay | int | range 1–60 |
devices/detection/max_number_retry | int | range 1–10 |
devices/detection/period | int | range 100–10000; locked |
devices/detection/timeout | int | range 1–15 |
devices/force_scale | float | range 0–2 |
devices/inverse/body_orientation_query_on_idle | bool | — |
devices/verse_grip/advanced/euro_one_filter | json | locked |
devices/verse_grip/battery/critical_threshold | int | — |
devices/verse_grip/battery/low_threshold | int | — |
devices/verse_grip/battery/reset_margin | int | — |
devices/workspace/defaults | json | — |
features/…
| Key | Type | Constraints |
|---|---|---|
features/HFX/sdf | bool | — |
features/HFX/sdf/created_events | bool | — |
features/HFX/sdf/delete_events | bool | — |
features/HFX/sdf/probe_on_zero_force | bool | — |
features/HFX/sdf/probe_on_zero_force_delay | float | range 0.001–60 |
features/HFX/sdf/update_events | bool | — |
features/grip_hook/enabled | bool | — |
features/grip_hook/hall | int | range 1–32 |
features/grip_hook/hold_duration | int | range 10–1000 |
features/grip_hook/use_hall | bool | — |
features/navigation/bubble/avatar_boundaries_max | vec3 | — |
features/navigation/bubble/avatar_boundaries_min | vec3 | — |
features/navigation/bubble/bubble_center | vec3 | — |
features/navigation/bubble/damping_coef_at_center | float | — |
features/navigation/bubble/damping_coef_at_inner_radius | float | — |
features/navigation/bubble/damping_coef_at_outer_radius | float | — |
features/navigation/bubble/reset_velocity_on_entry | bool | — |
features/navigation/bubble/spring_coef_at_center | float | — |
features/navigation/bubble/spring_coef_at_inner_radius | float | — |
features/navigation/bubble/spring_coef_at_outer_radius | float | — |
features/navigation/bubble/velocity_zone_bump_region_width | float | — |
features/navigation/bubble/velocity_zone_bump_stiffness | float | — |
features/navigation/bubble/velocity_zone_inner_radius | float | — |
features/navigation/bubble/velocity_zone_max_velocity | float | — |
features/navigation/bubble/velocity_zone_outer_radius | float | — |
features/navigation/bubble/wall_spring_stiffness | float | — |
features/safe_trajectory/enabled | bool | — |
features/safe_trajectory/max_vel | float | range 0.01–2 |
features/screensaver/distracted_speed | float | range 0.001–0.2 |
features/screensaver/enabled | bool | — |
features/screensaver/speed | float | range 0.001–0.2 |
features/synth/enabled | bool | — |
features/synth/oscillator1/amplitude | float | range 0–10 |
features/synth/oscillator1/frequency | float | range 5–20000 |
features/synth/oscillator1/shape | json | range 0–1 |
features/synth/oscillator2/amplitude | float | range 0–10 |
features/synth/oscillator2/frequency | float | range 5–20000 |
features/synth/oscillator2/shape | json | range 0–1 |
networking/…
| Key | Type | Constraints |
|---|---|---|
networking/events/port | int | locked |
networking/expose_servers_on_network | bool | locked |
networking/http/port | int | locked |
networking/legacy/port | int | locked |
networking/simulation/port | int | locked |
session/…
| Key | Type | Constraints |
|---|---|---|
session/safeties/device_drive_timeout | int | range 50–10000, step 10 |
session/safeties/slowest_sim_rate | int | range 20–500 |
system/…
| Key | Type | Constraints |
|---|---|---|
system/serial_enable | bool | — |