Docs
Download Spikemark
  • Creative Conners Docs
  • Technical Support
    • Tech Tips
      • Revolver V1 Position Issues
      • Setting Up a New Comptuer for Spikemark
  • Spikemark 6
    • Navigating Spikemark
      • Show Modes
      • Workspaces
        • Jog Workspace
        • Cues Workspace
        • Preset Workspace
        • Customize Your Workspace
      • Selection and Input
      • Tags
      • Filters
      • Search
      • Keyboard Shortcuts
    • Cues
      • Cue Structure
      • Cue Creation
        • Add Movements
        • Add Triggers
        • Add Actions
      • Editing Cue Properties
      • Cue Deletion
    • Movements
      • Motor Movements
      • Locked Group Movements
      • Unlocked Group Movements
      • FX Movements
      • OSC Movements
        • Custom OSC Command Library
      • UDP Movements
      • Modbus Movements
    • Triggers
      • Playback Go Trigger
      • Delay Trigger
      • Completion Trigger
      • Position Trigger
      • FX Input Trigger
      • Stacking Triggers
    • Actions
      • Motor Property Action
      • Motor Method Action
      • Playback Property Action
    • Running Cues
      • Playbacks
        • Playback Editing
        • Playback Control Speed
        • Playback Stacking
      • Cue Controls
      • Consolette
      • Restore Cue
    • Spikes
      • Simple Spikes
      • Dynamic Spikes
        • Incremental Spikes
        • Nearest Forward Multiple Spikes
        • Nearest Reverse Multiple Spikes
        • Nearest Multiple Spikes
      • Locked Group Spikes
    • Presets
      • Presets Overview
      • Creating, Editing, and Deleting Presets
      • Running Presets
    • User Authentication and Authorization
      • Overview
      • Users
      • Roles
      • Permissions
    • Show Control
      • Open Sound Control (OSC)
        • Send OSC Messages
        • OSC Position Output
        • OSC Input Trigger
          • OSC Input Messages
          • Cue Messages
          • Playback Messages
          • Sequence Step Messages
          • Motor Movement Messages
          • Motor Messages
        • Troubleshooting OSC
          • OSC Response Window
          • Medialon Manager Configuration
      • UDP
        • Send UDP Messages
        • UDP Position Output
      • Watchout Position Output
      • PosiStageNet (PSN)
  • Spikemark 5
    • How to Open Spikemark
    • Spikemark Installation
      • User Authorization
      • Windows Settings
    • Quick Start Tutorial
      • Step 1: Adding Motors
        • 1.1 Simulator Mode
        • 1.2 Add Motors from the Machine Library
        • 1.3 Rename Motors
        • 1.4 Add A Group
      • Step 2: Saving
      • Step 3: Jogging
        • 3.1 Single Axis Jogging
        • 3.2 Jogging Multiple Machines (Multi-Jog)
        • 3.3 Move To Position
      • Step 4: Writing Your First Cues
        • 4.1 Cues Workspace
        • 4.2 Add A Movement
        • 4.3 Duplicate A Cue
        • 4.4 Delete A Movement From A Cue
        • 4.5 Edit Movement - Changing Position, Speed, and Time
        • 4.6 Copy to Group
        • 4.7 Cue Total Time
        • 4.8 Load and Run your Cue
        • 4.9 Spikes
        • 4.10 Cue Links
        • 4.11 Restore Cue
        • 4.12 Delete A Cue
      • Step 5: Going Live
        • 5.1 Set Your IP Address
        • 5.2 Test Manual Movement
        • 5.3 Resetting Position
        • 5.4 Program Your Show
      • Sharpen Your Programming Skills
    • Steps to a Successful Load-In
    • Show Modes
    • Locking Changes
    • Workspaces
      • Customize Your Workspace
    • Selection and Input
    • IP Address and Network Connection
      • Setting Computer IP Address
      • Setting Stagehand IP Address
      • Setting Showstopper Consolette IP Address
      • Setting Pendant IP Address
      • Setting Showstopper IP Address
      • Setting Showstopper Node ID
      • Connecting To A Stagehand
      • Connecting To A Showstopper Consolette
      • Connecting To A Pendant
    • Adding Motors or Machines
      • Adding Motors or Machines From The Machine Library
      • Adding Custom Motors or Machines To Spikemark
      • Importing Motors or Machines
      • Exporting Motors or Machines
    • Stage Model Viewer
      • Changing Your Viewer
      • Adjusting the Stage Size
      • Changing the Type of Scenery
      • Adjusting Model Dimensions
      • Adjusting Model Rotation
      • Adjusting Location On Stage
      • Making Models
        • Modeling A Winch
        • Modeling A Lift
        • Modeling A Hoist
        • Modeling A Vertical Curtain
        • Modeling A Split Curtain
        • Modeling A Turntable or Periaktos
    • Tags
    • Editing Direction Labels
    • Filters
    • Search
    • Position
      • Reset Position
      • Units
      • Position Scale
        • Position Scale Wizard
        • Manually Calculate Position Scale
      • Limits
        • Setting Hard Limits
        • Setting Soft Limits
      • Target Tolerance
      • Strict Timing Mode
      • Position Fault and Max Position Error
      • Motor Tuning Overview
        • Motor Tuning - The Practical Approach
    • Load Cell
      • Load Cell Readout
      • Load Cell Configuration
      • Load Cells and Groups
    • Speed
    • Spikes
      • Adding A Spike
      • Removing A Spike
      • Spike Input Fields
      • Simple Spike
      • Incremental Spike
      • Nearest Forward Multiple Spike
      • Nearest Reverse Multiple Spike
      • Nearest Multiple Spike
    • Editing Cues
      • Adding and Deleting Cues
      • Adding and Deleting Movements
      • Edit Movement
      • Edit Cue Options
    • Cue Controls
    • Cue Status
    • Cue Links
      • Completion Link
      • Time Link
      • Position Link
      • Input Link
      • Deleting A Cue Link
    • Presets
    • Motor Groups
    • Showstopper Node Editor
    • Show Control
      • Open Sound Control (OSC)
        • OSC Position Output
        • OSC Messenger
          • Expanding The Command Library
        • OSC Response Window
        • OSC Input Trigger
          • Input Messages
          • Cue Commands
          • Motor Commands
          • My OSC Input Trigger Isn't Working, Is there another way?
      • UDP
        • UDP Position Output
        • UDP Messenger
      • Watchout Position Output
      • Modbus Effect
      • PosiStageNet (PSN)
    • Drive Communication
      • Drive Information
      • Configuring The Drive
      • Analyzing Movements
      • Drive Communication: Compatibility
      • Drive Communication: Setting VFD Parameters
      • RS-485 Upgrade
        • Upgrading an A800
        • Upgrading an A700
        • Drive Communication Troubleshooting
      • VFD Fault Codes
    • Motor Status Icons
    • Keyboard Shortcuts
    • Advanced Cue Techniques
  • Showstopper
    • Showstopper 4 Base
      • Installation
      • Operation
      • Troubleshooting
      • Specifications
    • Spikemark Console
      • Making-The-Connections
      • Using-the-Console
      • Console-Firmware
      • Troubleshooting
      • Specifications
    • Spikemark Pendant V2
      • Getting Started
      • Setup
      • Operation
      • Troubleshooting
      • Specifications
      • Drawings
    • Showstopper 4 E-Stop Hub
      • Getting Started
      • Installation
      • Operation
      • Troubleshooting
      • Specifications
    • Showstopper 4 Accessory Hub
      • Getting Started
      • Installation
      • Operation
      • Troubleshooting
      • Specifications
    • Showstopper Remote E-Stop
      • Installation
      • Making The Connections
      • Operation
      • Troubleshooting
      • Specifications
    • Control Connection
      • Installation
      • Making The connections
      • Operation
      • Troubleshooting
      • Specifications
    • Drive Connection
      • Installation
      • Making The connections
      • Operation
      • Troubleshooting
      • Specifications
    • Showstopper E-Stop Patch Panel
    • Showstopper Accessory Patch Panel
    • 🦺Safety Interlock
      • Safety Interlock Classic
      • Safety Interlock Pro
      • Safety Interlock Pro 4
      • 4-Axis Safety Interlock
    • Legacy
      • Showstopper 3 Base
      • Showstopper 3 Remote
      • Showstopper 3 E-Stop Patch Panel
      • Stage Manager
        • Getting Started
        • Installation
        • Making the Connections
        • Operation
        • Troubleshooting
        • Specifications
      • Showstopper 4 Consolette
        • Features
        • Making the Connections
          • Accessory Cable Connection
          • Ethernet Connection
          • Multiple Consolettes
        • On-Board Settings
        • Operation & Spikemark Integration
        • Connecting the Consolette to Spikemark
        • Jogging Motors
        • Running Cues
        • Emergency Stop
        • Updating Consolette Firmware
        • Troubleshooting
        • Physical Specifications
        • Drawings
  • Stagehand
    • Stagehand Firmware
      • Manually Updating a Stagehand Unipolar V6 Card via SD Card
      • Manually Updating a Stagehand Unipolar V6 Card via USB
    • Stagehand Parameters
      • Stagehand Pro 2 Parameters
      • Stagehand Pro 3/Pro 4 Parameters
      • Stagehand Pro 3e Parameters
      • Stagehand Pro 5 Parameters
      • Stagehand Apprentice 2 Parameters
      • Stagehand Apprentice
      • Stagehand AC - AKA: The Classic
      • Classic+ Parameters
      • Pro+ Parameters
      • Setting the C3 Value
      • Setting the C4 Value
      • All Clear/Parameter Clear
      • How to Use the Mitsubishi VFD Keypad
      • USB Parameter Sets
      • Parameter Library in Spikemark
    • Stagehand Apprentice
      • Getting Started
      • Installing the Stagehand
      • Making the Connections
      • Hooking up a motorized effect
      • Using the Stagehand
      • Troubleshooting
      • Technical Support
      • Specifications
    • Stagehand Apprentice DC
    • Stagehand Apprentice 2
      • Stagehand Apprentice 2: Features
      • Stagehand Apprentice 2: Installation
      • Stagehand Apprentice 2: Making The Connections
        • Stagehand Apprentice 2: Power Input
        • Stagehand Apprentice 2: Motor and Brake Output
        • Stagehand Apprentice 2: Sensor Input
        • Stagehand Apprentice 2: Interlock Inputs
        • Stagehand Apprentice 2: Ethernet Input
        • Stagehand Apprentice 2: Showstopper Emergency Stop Input
      • Stagehand Apprentice 2: Operation
      • Stagehand Apprentice 2: Troubleshooting
      • Stagehand Apprentice 2 Specifications
      • Stagehand Apprentice 2: Drawings
    • Stagehand FX
      • Getting Started
      • Making the Connections
      • Connecting an Effect
      • Operation
      • Troubleshooting
      • Specifications
    • Stagehand Hydraulic
      • Getting Started
      • Features
      • Installation
      • Operation
      • Troubleshooting
      • Technical Support
      • Specifications
      • Drawings
    • Stagehand Pro 3
    • Stagehand Pro 3E
    • Stagehand Pro 4
      • Stagehand Pro 4: Unpacking
      • Stagehand Pro 4: Installation
      • Stagehand Pro 4: Making The Connections
        • Stagehand Pro 4: Power Input
        • Stagehand Pro 4: Motor and Brake Output
        • Stagehand Pro 4: Sensor Input
        • Stagehand Pro 4: Interlock Inputs
        • Stagehand Pro 4: Ethernet Input
        • Stagehand Pro 4: Showstopper Emergency Stop Input
      • Stagehand Pro 4: Operation
        • Stagehand Pro 4: Powering Up
        • Stagehand 4: Machine Configuration
        • Stagehand Pro 4: Manual Operation (Jogging)
        • Stagehand Pro 4: Brake Test
        • Stagehand Pro 4: Connecting to Spikemark
        • Stagehand Pro 4: Status Displays
      • Stagehand Pro 4: Troubleshooting
        • Stagehand Pro 4: Recovering From Faults
        • Stagehand Pro 4: Monitoring Behavior
      • Stagehand Pro 4: Specifications
      • Stagehand Pro 4: Drawings
    • Stagehand Pro 5
      • Stagehand Pro 5: Features
      • Stagehand Pro 5: Installation
      • Stagehand Pro 5: Making The Connections
        • Stagehand Pro 5: Power Input
        • Stagehand Pro 5: Motor and Brake Output
        • Stagehand Pro 5: Sensor Input
        • Stagehand Pro 5: Interlock Inputs
        • Stagehand Pro 5: Ethernet Input
        • Stagehand Pro 5: Showstopper Emergency Stop Input
      • Stagehand Pro 5: Operation
      • Stagehand Pro 5: Troubleshooting
      • Stagehand Pro 5 Specifications
      • Stagehand Pro 5: Drawings
      • Stagehand Pro 5: Replace Control Card
    • Deck Chief 2
      • Getting Started
      • Features
      • Making the Connections
      • Using the Deck Chief
      • Troubleshooting
      • Specifications
    • Stagehand Classic+
    • Stagehand Pro+
    • Legacy Manuals
      • Deck Chief
        • Getting Started
        • Installation
        • Making the Connections
        • Using the Deck Chief
        • Troubleshooting
        • Specifications
        • Deck Chief Legacy Connections
      • Stagehand Mini^2
      • Stagehand Pro AC (Pro 2)
      • Stagehand AC
      • Stagehand Mini
      • Stagehand DC & DC Max
    • X-Groove Override
  • Machinery
    • Smart Chain Hoist
      • Getting Started
      • Installation
      • Making the Connections
      • Under The Hood
      • Troubleshooting
      • Specifications
    • Floorpocket
      • GettingStarted
      • Installation
      • Making the Connections
      • Prepping the Machine for Operation
      • VFD Settings
      • Troubleshooting
      • Specifications
    • Floorpocket v2
      • Get Started
        • Unpack
        • Installation Tools
      • Assembly
        • Base
        • Column Extension
        • Limit Cables
        • Roller Chain
      • Get Moving
        • Power Up
        • Platform
        • Stay Safe
        • Write Cues
      • Maintain the Machine
      • Troubleshooting
      • Floorpocket v2: Specifications
    • Pivot
      • Getting Started
      • Installation
      • Troubleshooting
      • Specifications
    • Pushstick
      • Getting Started
      • Installation
      • Making the Connections
      • Rigging the Pushstick
        • Rigging a Pushstick v2
      • Setting the Limits
      • Troubleshooting
      • Specifications
    • Pushstick Mini
      • Getting Started
      • Installation
      • Making the Connections
      • Rigging the Pushstick Mini
      • Troubleshooting
      • Technical Support
      • Specifications
    • Revolver
      • Installation
      • Making the Connections
      • Making It Move
        • Friction Wheel Tension Guide
      • Position Scaling
        • Encoder Finessing
      • Troubleshooting
      • Specifications
        • Drawing
      • Multi-Motor Configuration
      • Revolver v1 Manual
    • Rotator
      • Getting Started
      • Installation
      • Making the Connections
      • Troubleshooting
      • Technical Support
      • Specifications
    • Spotline
      • Getting Started
      • Installation
      • Rigging the Spotline
      • Operation
      • Troubleshooting
      • Specifications
    • Spotline V2
      • Spotline V2: Setup Process
      • Spotline V2: Installation
      • Spotline V2: Rigging the Spotline
      • Spotline V2: Operation
      • Spotline V2: Troubleshooting
      • Spotline V2 Accessories
      • Spotline V2: Maintenance
      • Spotline V2: Specifications
    • Spotline Mini v2
    • Spotline Practical
      • Practical v2
        • Getting Started
        • Installation
        • Rigging the Machine
        • Setting the Limits
        • Troubleshooting
        • Specifications
      • Practical v1
        • Getting Started
        • Installation
        • Operation
        • Troubleshooting
        • Specifications
    • Turntable Template
      • Overview
      • Bill Of Materials
      • Fabrication
      • Turntable Assembly and Installation
      • Turntable Assembly Guide
      • Tech Support
      • 20' Turntable Specs
      • Turtable Research Notes for Nerds
    • Retired
      • Curtain Call
      • Trickline
        • TricklineProductManualv1.0
        • Getting Started
        • Installation
        • Making the Connections
        • Troubleshooting
        • Specifications
      • Spotline Mini
        • Getting Started
        • Installation
        • Making the Connections
        • Rigging the Spotline Mini
        • Troubleshooting
        • Specifications
      • Pushstick Manual
    • Stromag Limits
  • Broadweigh Load Cells
Powered by GitBook
On this page

Was this helpful?

  1. Spikemark 5
  2. Show Control
  3. Open Sound Control (OSC)
  4. OSC Messenger

Expanding The Command Library

PreviousOSC MessengerNextOSC Response Window

Last updated 3 years ago

Was this helpful?

The nice thing about the command library is that each library is written in a simple XML format, allowing each library to be easily edited and created. When Spikemark was installed on your computer, a new folder was added at “C:\Users{user}\Documents\Spikemark\OSC Libraries” and some starter libraries were added. These starter libraries can be expanded or new custom libraries can be added. Currently, Spikemark only has two preloaded OSC libraries. One OSC Library is Figure 53’s QLab and the other is ETC’s EOS family of lighting consoles. If you are looking to build a library of commands for a different control platform with spikemark, you will need to build your new OSC library in the XML format defined below. Let’s go over everything that you can have control of when you build your new OSC command library.

  1. OSC Library Name

  2. OSC Library Description

  3. OSC Library Version Number

  4. OSC Command Name

  5. OSC Command Address

  6. Address’s Parameters and Arguments

  7. Input Field for the value of the Parameters and Arguments

  8. Descriptions of Parameters and Arguments

  9. Data Type of Parameters and Arguments.

Command Library Format

A command library has the following basic structure:

<osc>
        <libraryName>Custom Lib</libraryName>
        <libraryDescription>A collection of amazing OSC commands</libraryDescription>
        <libraryVersion>1</libraryVersion>
        <command>
                <name>Cue Volume</name>
                <address>/cue/{cueNum}/volume[level]</address>
                <parameter>
                        <name>cueNum</name>
                        <description>The cue that will have its volume adjusted.</description>
                        <dataType>float</dataType>
                        <default>1</default>                
                </parameter>
                <argument>
                        <name>level</name>
                        <description>The new volume level for the cue.</description>
                        <dataType>integer</dataType>
                        <dataType>string</dataType>
                        <default>1</default>        
                        <optional>True</optional>                
                </argument>
        </command>
</osc>

This structure may seem complex, but let us demystify it for you. Even though the Qlab and EOS Libraries are already built, let’s go through the process of adding a new OSC library into Spikemark. Spikemark needs to be told where to place information when you are building a new OSC Library. Let’s start a new library that we will call “Brand New Library”. Open up your favorite Text Editor that will let you save as an XML file with a file extension of .xml. Keep following along to import your first command into your new OSC Library.

Start with the two lines below.

<osc></osc> - This is the root tag that contains all of the other tags.

<osc>

</osc>

Next we will input the descriptors that are displayed in the OSC Library in Spikemark.

  • <libraryName>Brand New Library</libraryName>

  • <libraryDescription>A collection of amazing OSC commands</libraryDescription>

  • <libraryVersion>1</libraryVersion>

The white text below you can change to anything you like.

<osc>
	<libraryName>Brand New Library</libraryName>
	<libraryDescription>A collection of amazing OSC commands</libraryDescription>
	<libraryVersion>1</libraryVersion>
</osc>

Now let’s add our first command block. You will repeat this step for each command you want to send to a software capable of being controlled by an OSC Command. Let’s make our first command to control the X Scale Factor of a video cue. The Command Address is what will be sent to the software you are trying to control. The Command Address can be found from the manufacturers website of the software that will be controlled from Spikemark. The Command Address consists of two parts: Parameters and Arguments. We indicate Parameters with { } and Arguments with [ ]. For our example, the Command Address for controlling the X Scale of a video cue will be noted as: /cue{cueNum}/scaleX[scaleFactor]. The cueNum is the parameter and the scaleFactor is the attribute for this Command Address.

  • <command></command> - This tag can be repeated an infinite number of times inside the <osc></osc> tag, each one representing a different OSC Command.

    • A Command will contain:

      • <name>Cue X Scale Factor</name> This tag holds the name of your command.

      • <address>/cue{cueNum}/scaleX[scaleFactor]</address> tag. This tag contains what will be sent over OSC. Each OSC Address uses the same structure /method/{parameter}/method/[argument]. In this example, we are using the “Cue” method with the parameter “{cueNum}” and the method “scaleX” with the argument “[scaleFactor]”.

      • <parameter>cueNum</parameter> You can have multiple parameter tags, but there needs to be the same number of parameters that exist in the <address></address> tag

      • <argument>scaleFactor</argument> You can have multiple argument tags, but there needs to be the same number of arguments that exist in the <address></address> tag.

<osc>
	<libraryName>Custom QLab Library</libraryName>
	<libraryDescription>A collection of amazing OSC commands</libraryDescription>
	<libraryVersion>1</libraryVersion>
	<command>
		<name>Cue X Scale Factor</name>
		<address>/cue/{cueNum}/scaleX[scaleFactor]</address>
		<parameter>
			
		</parameter>
		<argument>
			
		</argument>
	</command>
</osc>

In each Parameter and Argument tag, there will be 4 additional tags to give information for:

  • <name></name> - This tag must match what is entered for the Parameter or Argument in the <address></address> tag

  • <description></description> - This is the description that will be displayed next to each Parameter and Argument

  • <dataTypes></dataTypes> - This tag describes the type of data that is allowed. The valid values for this tag are float, integer, or string

  • <default></default> - This tag is required for both Parameters and Arguments. This will be the default value for the Parameter and the Argument

  • <optional><optional> - If an argument is required, this tag can be omitted. If an argument is not required, a tag with the value of True can be added

<osc>
	<libraryName>Custom QLab Library</libraryName>
	<libraryDescription>A collection of amazing OSC commands</libraryDescription>
	<libraryVersion>1</libraryVersion>
	<command>
		<name>Load Cue At</name>
		<address>/cue/{cueNum}/LoadAt[sec]</address>
		<parameter>
			<name>cueNum</name>
			<description>The cue that will be loaded.</description>
			<dataType>float</dataType>
			<default>1</default>		
		</parameter>
		<argument>
			<name>sec</name>
			<description>The amount of time it will take to load</description>
			<dataType>float</dataType>
			<default>1</default>		
		</argument>
	</command>
</osc>

Congratulations! You just added your first command in a new OSC Library. Repeat for each command you want to add into your OSC Library. Once you have added all the commands for this library, save your new library as an XML file with the file extension .xml and save it in “C:\Users{user}\Documents\Spikemark\OSC Libraries” to have it saved where the other OSC Libraries are saved for Spikemark.

Once you have saved your new OSC Library, you can recall it by Clicking on the “+” button on an OSC movement

Then, Click “Browse”.

Select your newly created .xml file and use your new commands.