Technical Writing

Web Help User Manual

Sample content from a page I created using Adobe RoboHelp that was part of a web help system I worked on for a software company. The formatting and functionality here is somewhat different from the actual document shown in the image below.

5.14 Controlling Hippotizer with External Protocols

5.14.3 OSC

What is OSC?

OSC stands for Open Sound Control. It is a protocol that was originally developed by sound engineers for controlling signals with various devices and works much like MIDI. It allows for flexibility and a high level of communication between applications. Messages are sent over wifi using the UDP protocol.

How can OSC be used with the Hippotizer?

Using OSC technology, mobile devices like iPhones, Androids, and iPads can be used to control the Hippotizer remotely over wifi. All it takes is installing an app on your device and configuring the Hippotizer. You can specify which functions you want to control and assign them to the touch controls on your device. Green Hippo has created a custom control layout template designed specifically for controlling Hippotizer with TouchOSC on your ios and Android devices. To get started, you will need the following items:

What will I need?

  • A Mobile Device -- iPhone, iPad, or Android device.
  • TouchOSC -- download to your iPhone or Android from the appropriate app store.
  • TouchOSC Editor -- download to your computer. Free download from
  • Hippo OSC layout template -- download to your computer. Free download from Green Hippo
  • A Wireless Network Configuration

After downloading and installing the above items, follow these instructions to begin the configuration process.

Step 1

Adding the HippoOSC Component

Once the OSC component has been added (See 5.1.1 Adding Components), it can be opened by double clicking on it in the HippoNet Overview window.

Make sure that your computer and mobile device are both connected to your wireless network.

  1. From the HippoNet Overview console, select More > Host Settings > Network Settings, and under Machine Network Settings ensure that DHCP is enabled and you are showing an IP address.

    • Note: After changing the IP address, the engine will need to be restarted.

Step 2

Adding Control Functions

  1. From the HippoOSC component window select Add Control Functions.
  2. From the Select Pins popup window expand the tree by clicking on the “+” next to your computer’s name so that you are viewing the contents of Engine > Output1.

  3. Expand Master > Output1 and tick the box next to Level by clicking on it.
  4. Collapse the tree next to Master by clicking on the “-“ next to it.
  5. Expand Layer1 > Colour and tick the box next to ColourRGB.
  6. Expand Geometry and tick the box next to Position and Zoom.
  7. Expand Mixer and tick the box next to Level.


  8. Collapse the tree next to Layer1 by clicking the “-“ next to it.
  9. Select the same control functions for Layer2, Layer3 and Layer4. Refer to steps 5, 6, and 7.
  10. Click OK.
  11. On the left side of the HippoOSC component window highlight HippoNetwork by clicking on it.
  12. In the lower right corner of the HippoOsc component window in the Pin Feedback area click Enable Selected.
  13. Fully expand the network tree in the HippoOSC component window. RGB, XY, Zoom, and Level should appear for each layer, and Level should appear under Master. All items should appear green to signify that they have been enabled.

Step 3

Mapping Aliases

  1. Run the TouchOSC Editor and load the HippoOSC 4Layer Base layout template by clicking Open and browsing to the file.
  2. In the network tree of the HippoOSC component window select Level under Layer1. Copy the address that appears at the bottom of the window.
  3. In the TouchOSC Editor select the Layer 1 graphical fader from the Overview screen by clicking on it. In the text box to the left under the OSC tab Paste the address that you copied, replacing any existing text.

  4. Select the Layer 1 graphical tab to view the Layer 1 screen and select the Layer 1 Level graphical fader. Paste the same address into its corresponding text box as well.


  5. Copy and Paste the RGB, XY, and Zoom addresses for Layer1 from the HippoOSC component window to their corresponding faders in the TouchOSC Editor.
  6. Repeat this process for Layer2, Layer3, Layer4, and Master until all faders in the HippoOSC 4Layer Base template have been assigned an address.

    • Now that you have setup your HippoOSC 4 Layer Base layout, you might want to save a backup copy of it to your computer.

Step 4

Syncing the 4Layer Base Layout to TouchOSC

  1. In the TouchOSC Editor click Sync.
  2. In TouchOSC on your mobile device open the settings menu by touching the “i” in the upper right corner.
  3. Select Layout > Add.

  4. Select your computer’s name when it shows up in TouchOSC. The layer will be imported into the list.
  5. In the TouchOSC Editor select Stop Sync.
  6. Go back to Layouts in TouchOSC and select the layout you just added.

Step 5

Configuring TouchOSC to Communicate with Hippotizer

  1. In TouchOSC on your mobile device under Connections select OSC.
  2. Select Enabled On.
  3. Select Host and enter the Hippotizer IP address showing under the Network Settings tab of the Host Management window in ZooKeeper.
  4. Set Port (outgoing) to 4000
  5. Set Port (incoming) to 4001

  6. The Local IP address of your mobile device will be showing. Enter it into the OSC Transmit Target IP box under OSC Settings in the HippoOSC component window.
  7. Enter 4001 in the Transmit Port box.
  8. Enter 4000 in the Receive Port box.
  9. Click Set.
You should now be able to control the specified faders from your mobile device. Exporting a HippoOSC Configuration

If you delete the HippoOSC component your settings will be lost. It is advisable to export a backup file of your HippoOSC configuration settings that can be easily imported if necessary. See Exporting a Component Configuration. Importing a Saved V3s File into HippoOSC

If you have deleted or reset the HippoOSC component you may wish to import a saved configuration. See Importing a Saved Component Configuration. Troubleshooting

If you are having trouble with the network tree while adding control functions or viewing aliases, reset the HippoOSC component and carefully follow the instructions in order from the beginning.
  1. To reset the HippoOSC component first close the HippoOSC component window.
  2. From the HippoNet Overview window right click HippoOSC and select Reset.