Skip to content

Commit faa47cb

Browse files
committed
Add run/launch instructions
1 parent a5b9b30 commit faa47cb

File tree

1 file changed

+17
-0
lines changed

1 file changed

+17
-0
lines changed

README.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -228,3 +228,20 @@ cd ..
228228
rosdep install --from-paths src --ignore-src -r -y
229229
colcon build
230230
```
231+
232+
## Running `open_sound_control_bridge`
233+
234+
The `open_sound_control_bridge` package can be run either directly with `ros2 run`:
235+
```bash
236+
ros2 run open_sound_control_bridge osc_bridge_node --port UDP_PORT --config /path/to/bridge_config.yaml
237+
```
238+
or via the provided launch file:
239+
```bash
240+
ros2 launch open_sound_control_bridge osc_bridge.launch.py port:=UDP_PORT osc_config:=/path/to_bridge_config.yaml
241+
```
242+
243+
The `osc_bridge_node` will listen for OSC packets from any source on the specified UDP port, republishing them
244+
as ROS topics.
245+
246+
Outbound OSC packets are send to the specified host on the UDP ports defined in the
247+
[bridge configuration file](#bridge-configuration).

0 commit comments

Comments
 (0)