1. Description

The main window is divided into 3 parts:

at the top: a toolbar with the input (incoming) port number, the Parameters button and the Wiimote Drawer button. You can customize this arrangement ;
in the middle: a table showing the list of OSC messages that have been received so far, and their respective events. They appear in the list as soon as they are received ;
at the bottom: connection status to OSC represented by a blue light when the connection is successful. Kyma and Wiimote statuses are displayed with a logo when the device is up and running.

1.1 New document

A new OSCulator document named 'Untitled' does not contain any OSC message and listens to the default OSC input port (defined in the Preferences, or 8000 as factory default).

In order to populate this table, you will need to send OSC messages to OSCulator, or connect a Wiimote or a SpaceNavigator. This has two benefits: test wether the connection is working correctly, and automatically learn the OSC addresses.

1.2 Multiple documents

It is possible to work on multiple documents, that is, multiple windows at once. This is useful when you want to separate functionality accross several files. For example, you could put specific Lemur configurations in a file and Wiimote configuration in another. Though you can mix both configurations in the same file, it is easier to manage things this way.

However several limitations must be observed:

Two windows can not share the same OSC input port. If two windows have the same port, then one of the two windows will be not able to start the OSC engine. In this case, an error message is displayed, and the status LED turns to red.
It is not possible to connect the same Wiimote to several OSCulator windows. For this, only the first opened (or created) OSCulator document will be able to connect with a Wiimote. However, you can use multiple Wiimotes in one or many OSCulator documents at once.

1.3 Keeping the main window on top of all others

Sometimes it is useful when you work with another software to keep OSCulator's window on top of all others, like a floating tool. It is possible to put the window on top, by choosing the "Windows->Keep window on top" menu item (⌘T).

2. Events

An OSC message is made of two main parts: The OSC address, and the arguments. The address is the name of the OSC message (eg. "/TouchScreen"), and the arguments is the list of values supplied with this message (eg. the coordinates of a touch screen would be two arguments for X and Y).

For example, the JazzMutant's Lemur Multiball control output two OSC methods each having as much arguments as there are ball in the control, hence with 2 balls:

   /Multi/x ,ff  0.20 0.87
   /Multi/y ,ff  0.51 0.13

will be displayed in OSCulator as 2 OSC messages, each one having 2 events:

   /Multi/x
      [0]
      [1]
   /Multi/y
      [0]
      [1]

Each of these events can be mapped to different events: MIDI control change, Keyboard stroke, Kyma Event (aka Kyma CC), etc.

3. Operations on Events

3.1 Edit Menu

Copy (⌘C) / Paste (⌘V) / Cut (⌘X): Use the Copy and Paste functions to copy and paste events between different presets or windows.
Delete: You can delete one or more events by selecting them in the list and pressing the Backspace key. If an OSC message has multiple arguments, the selected arguments and their higher level counterparts will be deleted.
Select All (⌘A): Selects all messages in the window.
Duplicate (⌘D): Perform duplicate when you want to peform two events on one OSC message. A duplicated message is colored in blue.
Split (⇧⌘D): "Split" an incoming message in two parts. Works with float OSC arguments between 0 and 1.
This function create two virtual messages, one for the low values of the incoming message (between 0 and 0.5, excluded) and the other one for high values of the incoming message (between 0.5 and 1). The outputs are scaled to 0 1. This is very useful when you have the input from the axis of a controller and want to assign a different event for each sides of the axis. For example, with the joystick of the Wiimote's Nunchuk, you can assign a different event when the joystick is on the left, and another for the right.
Demux (⌃D): Demux or demultiplex the input based on its value. This function create a new virtual message for each different values it receives. This is useful when working with the TUIO protocol or the Iannix software.
When called, the existing events will be removed, waiting for the next incoming input. The message marked for demultiplexing is colored in purple.

3.2 Routing Menu

Solo (⌘R): On first call, enables only the selected events, and disables all the other ones. On subsequent calls, toggles between the previous state and the Solo state. This is useful when you want to filter the output only for a specific event. For exemple, when using the MIDI learn function in Ableton Live or Logic, you may want to send only one MIDI message at a time. For this, select the line you want to solo, hit ⌘R, and activate MIDI learn in the other software. When you're done learning the MIDI event, go back to OSCulator and hit ⌘R again to restore the previous working state.
Enable (⇧⌘R): Enables the selected events.
Disable (⌥⌘R): Disables the selected events.
Collapse / Expand (⇧⌘E): Collapses or expands the selected lines.
Lock Input (⌘L): Locks the input so no new messages can be received. This function will prevent from altering the state of the running document. This is useful when you using a document for example on a live show and want to keep it from being modified incidentally.

<< | UsersManual | Anatomy of an event >>