Eos OSC Conventions
All OSC messages sent to Eos must use /eos/ to start the command string.
All OSC traffic from or to an Eos multi-console session must be handled by the device acting as the session Host.
Parameter and Key Names
Eos parameter and key names in OSC messages use the following conventions:
- Name capitalization is ignored.
- Any combination of upper and lower case can be used.
- Full or abbreviated names can be used.
| Action | Address Pattern | Arguments | Examples | Notes |
|---|---|---|---|---|
| Set a channel's intensity. | /eos/chan/<number>/intens | Intensity level (0-100). | /eos/chan/1/intens=10 | These are all valid OSC messages to set channel 1 to 10%. |
| /eos/channel/<number>/intensity | /eos/channel/1/intensity=10 | |||
| /EOS/Channel/<number>/intens | /EOS/Channel/1/intens=10 |
- Names that contain spaces can be written with spaces or underscores.
- Names that contain forward slashes (/) should be written with backwards slashes (\).
| Action | Address Pattern | Arguments | Examples | Notes |
|---|---|---|---|---|
| Set a channel's gobo index speed. | /eos/chan/<number>/param/gobo_index\speed | Parameter level (0-100). | /eos/chan/1/param/gobo_index\speed=10 | These are all valid OSC messages to set channel 1's gobo index/speed to 10%. |
| /eos/chan/<number>/param/gobo index\speed | /eos/chan/#/param/gobo index\speed=10 | |||
| /eos/chan/<number>/param/gobo ind\spd | /eos/chan/1/param/gobo ind\spd=10 |
Button Edge
Button edge is an argument that specifies when an action happens during a button push, using the following values:
- 1.0 - down, or when the button is pushed.
- 0.0 - up, or when the button is released.
Like many arguments, including a button edge value is optional. If no value is specified, the action defaults to happening when the button is pushed.
OSC Numbers and Ranges
OSC arguments that contains numbers or number ranges will be sent as follows:
- Eos target numbers will be sent as 32-bit integers when possible.
- If a target number contains a decimal, it will be sent as a string.
- When a range contains 2 or more consecutive whole numbers, they will be represented as strings in <number> - <number> format.
User IDs and OSC
If a user ID is not specified, the command defaults to the current Eos user. You can use /eos/user/-1 to revert from a virtual OSC user back to the default.
The shaded rows in the OSC Dictionary > OSC Inputs table indicate which address patterns are compatible with the /user syntax.
Use this command to set the OSC user ID (which is not the console user ID). User 0 represents the background user (used in Background macros and elsewhere). User -1 represents the current user on the console receiving OSC commands.
| OSC Method | Arguments | Examples/Comments |
|---|---|---|
| /eos/user | number for OSC user ID | /eos/user=1(set OSC user ID to 1) /eos/user=-1(set OSC user to match con- sole) /eos/user=0(set OSC user as background user) |
| Current User ID Output – see | ||
| /eos/out/user | number for current OSC user ID | /eos/out/user=1 |
OSC Local
OSC commands entered from an Eos Family device (such as via a Magic Sheet object's Command field) can be prefaced with local: to loop them back into the device.
- local:/eos/chan/1=50 - when executed, the console will send itself the OSC command to set channel 1 to 50%.
Fire and Go
OSC Cue and OSC Cue Lists allow the use of both /fire/ and /go/ to activate a cue. /go/ is specific to cues and cue lists, and advances in sequence in the same way as the physical [Go] button.
/fire/ activates the specified cue or cue list regardless of sequencing, and can also be used to activate other targets, such as OSC Macro or OSC Preset.
OSC Gel
Gels will be represented as strings in the following format:
<Gel Manufacturer Abbreviation><Gel Number>
- AP1150 - Apollo 1150.
- L2 - Lee 2.
- T12 - TokyoBS Poly Color 12.