Skip to content

Commit

Permalink
Update default YML file
Browse files Browse the repository at this point in the history
  • Loading branch information
giggletech committed May 28, 2024
1 parent 74db07f commit 62a0206
Showing 1 changed file with 17 additions and 39 deletions.
56 changes: 17 additions & 39 deletions config.yml
Original file line number Diff line number Diff line change
@@ -1,96 +1,74 @@
# Giggle Tech OSC Router Configuration

# This configuration file defines the setup for the OSC router and the specific parameters
# for each connected haptic device. The setup section includes global default settings,
# while the devices section specifies individual settings for each device.

setup:
# Port listening for OSC (Default: 9001)
port_rx: 9001

# Minimum Speed of Haptic Motor (5-100)
default_min_speed: 2
default_min_speed: 5

# Maximum Speed of Haptic Motor (Recommended: 5-25)
default_max_speed: 25

# Maximum Speed Parameter
default_max_speed_parameter: max_speed

# Maximum Speed Scalar (10-100)
default_speed_scale: 100

# OSC Timeout (seconds)
timeout: 500
timeout: 5

# Velocity Control Mode (True = Velocity / False = Proximity)
# Note: This mode is not tested for multiple devices. Refer to Discord for more information.
default_use_velocity_control: false

# Velocity Control Parameters
# Adjust these parameters to achieve the desired effect.
default_outer_proximity: 0
default_inner_proximity: 0.7
default_velocity_scalar: 20

devices:
# IP Address of Headpat Device
# Device 1
- ip: 192.168.1.69
# Unity Proximity Parameter
# Specify the Unity proximity parameter
proximity_parameter: proximity_01
# IP Address of Headpat Device


# Device 2
- ip: 192.168.1.70
# Unity Proximity Parameter
# Specify the Unity proximity parameter
proximity_parameter: proximity_02
# Minimum Speed of Haptic Motor (5-100)
min_speed: 5
# Maximum Speed of Haptic Motor (Recommended: 5-25)
max_speed: 40
# Maximum Speed Scalar (10-100)
speed_scale: 90
# Maximum Speed Parameter
max_speed_parameter: max_speed_02
# Velocity Control Mode (True = Velocity / False = Proximity)
# Note: This mode is not tested for multiple devices. Refer to Discord for more information.
use_velocity_control: true
# Velocity Control Parameters
# Adjust these parameters to achieve the desired effect.
outer_proximity: 0.1
inner_proximity: 0.6
velocity_scalar: 25

# Device 3
- ip: 192.168.1.71
# Unity Proximity Parameter
# Specify the Unity proximity parameter
proximity_parameter: proximity_03
# Minimum Speed of Haptic Motor (5-100)
min_speed: 7
# Maximum Speed of Haptic Motor (Recommended: 5-25)
max_speed: 60
# Maximum Speed Scalar (10-100)
speed_scale: 100
# Maximum Speed Parameter
max_speed_parameter: max_speed_03
# Velocity Control Mode (True = Velocity / False = Proximity)
# Note: This mode is not tested for multiple devices. Refer to Discord for more information.
use_velocity_control: false
# Velocity Control Parameters
# Adjust these parameters to achieve the desired effect.
outer_proximity: 0.1
inner_proximity: 0.6
velocity_scalar: 25

# Device 4
- ip: 192.168.1.73
# Unity Proximity Parameter
# Specify the Unity proximity parameter
proximity_parameter: proximity_04
# Minimum Speed of Haptic Motor (5-100)
min_speed: 5
# Maximum Speed of Haptic Motor (Recommended: 5-25)
max_speed: 100
# Maximum Speed Scalar (10-100)
speed_scale: 100
# Maximum Speed Parameter
max_speed_parameter: max_speed_04
# Velocity Control Mode (True = Velocity / False = Proximity)
# Note: This mode is not tested for multiple devices. Refer to Discord for more information.
use_velocity_control: true
# Velocity Control Parameters
# Adjust these parameters to achieve the desired effect.
outer_proximity: 0.1
inner_proximity: 0.6
velocity_scalar: 25

0 comments on commit 62a0206

Please sign in to comment.