Skip to content

Latest commit

 

History

History
76 lines (52 loc) · 2.95 KB

README.md

File metadata and controls

76 lines (52 loc) · 2.95 KB
Raw

TouchOSC Accelerometer Data to p5js

Description

oscxyz is a simple OSC-to-WebSockets bridge that takes OSC messages from a client, like TouchOSC, and sends them to a WebSocket client, like a p5js sketch.

Note that this implementation is very basic and was created specifically to handle accelerometer data with an OSC type tag of ",fff" and an address pattern of "/accxyz" (although the address pattern can be changed with the --pattern flag).

See also my oscdump utility

Sequence Diagram

sequenceDiagram
TouchOSC-->>oscxyz: TCP connection 
p5.js-->>oscxyz: WebSockets connection 
loop 
  TouchOSC->>oscxyz: OSC /accxyz message
  oscxyz->>p5.js: x,y,z string
end
Loading

Installation

  1. Download the appropriate archive file from the Releases page.
  2. Place the oscxyz executable somewhere in your path
  3. Run it from a terminal window as described below. On MacOS, use the Terminal app. On Windows, you might need to download Windows Terminal from Microsoft.

Or, if you have go installed:

go install github.com/rahji/oscxyz@latest

Usage

On Your Computer

Open a terminal window and run the command using the following syntax:

Usage:
  oscxyz [flags]

Flags:
  -h, --help             help for oscxyz
      --oschost string   IP address to use when creating the OSC server (required)
      --oscport int      Port number to use when creating the OSC server (required)
      --pattern string   OSC message pattern to listen for (default "/accxyz")
  -q, --quiet            Don't show OSC messages on the console
  -v, --values           Only send the values of the OSC message
      --wsport int       Port number to use when creating the WebSockets server (required)

For example:

oscxyz -oschost=192.168.4.20 --oscport=8000 --wsport=8080 --values

On Your Phone

  1. Start TouchOSC
  2. In Settings, touch "OSC" and enter the host IP address and port (outgoing) using the values you typed in the terminal
  3. Also in Settings, touch "Options" and turn on "Accelerometer (/accxyz)"

You should start seeing the accelerometer OSC messages appear in the terminal window where oscxyz is running (unless you used the --quiet flag).

Examples

Look at this separate repo for some p5.js examples.

Issues

  • This currently only works with TouchOSC, I think. This is because it's the only phone app that I've seen that includes all three axes in one OSC message. I will update this tool to work with other apps (like MultiSense Osc), but I'm hesitant to go too far since I intend to make a more comprehensive OSC tool with many more options - probably this summer.
  • oscxyz doesn't handle OSC bundles - only messages.