k y m a • t w e a k y — the kyma collective || view the current website || February 2015 Archive

Search

Learn Section

All Sections

Symbolic Sound

TWiki Links

For software developers

One of the advantages of OSC is that it is an open standard that invites you to write your own applications or translators for communicating between computers, devices, and applications and Kyma. This document contains the information you will need for writing your own OSC application, translator, or device that can communicate bi-directionally with Kyma.

Finding the Paca(rana)

The Paca(rana) advertises its IP address and port via Bonjour (Zeroconf). The Paca(rana) OSC service is advertised as

_osc._udp

Program your device or application to send OSC messages to:

beslime-serial_nbr.local

where serial_nbr is the serial number of your Paca or Pacarana (note that some applications do not display the .local part of the name)

OSC Messages

The Paca(rana) responds to messages having from 1 to 256 arguments.

An OSC message should take the form:

address, argument type list, argument values

Address

The address of the message can be any string, but controllers typically send the name of widget that changed. The Paca(rana) responds automatically to a few, predefined addresses (for example, the names of the widgets in the currently active VCS in Kyma). Any other addresses can be arbitrarily re-mapped to event values in Kyma

Argument type list

The type list must be floats: ‘,f’, ‘,ff’, ‘,fff’, etc.

Arguments

Each argument must be a float in the range of 0 to 1

Multi-argument messages

Messages with 2 or more arguments are split within Kyma. Kyma associates each individual component with one control widget. For example:

/4/xy,ff

becomes

/4/xy//1,f

and

/4/xy//2,f

Miscellaneous random tidbits...

Kyma ignores the timetag of bundle messages.

Kyma performs case-insensitive address comparisons.

There is no pattern matching at this time.

Connecting OSC messages to Kyma Event Values

In Kyma, you can associate incoming OSC messages with Kyma Event Values in several ways (see the main document for details on how to use the OSC messages within Kyma):

• Use OSC Event Values in parameter fields of Sound

• Program OSC device to send specific Event Value messages to Paca(rana) that are automatically recognized

• Remap individual VCS widgets to respond to specific OSC messages

Sending MIDI Streams Over OSC

Please see Sending MIDI Streams Over OSC

Kyma OSC Standard Protocol

You can write software that communicates bi-directionally with Kyma using OSC, including MIDI note events and graphics, by following the Kyma OSC Standard Protocol for communicating with Kyma via OSC