Skip to main content

 

Electronic Theatre Controls Inc

How to Setup a Stream Deck and Hog 4

 

 

Description

This guide will describe the steps to connect a Stream Deck to a Hog 4 Console or Hog 4 PC using the 3rd party companion software. 

The stream deck can be used to trigger OSC commands via companion software.These OSC Commands can be used to trigger physical buttons, and playback items on Hog 4. Companion software can be used with a PC or a Raspberry PI. The Stream Deck does not have any functionality if directly plugged into a console or Hog 4 PC. 

A Raspberry PI can be used to run Companion software. The RPI Is not required but recommended to use in lieu of a PC. Many users like the RPI because of the low cost, small size, and due to the fact it can be used as a dedicated computer to run the companion software.


Caution-Icon.png

DISCLAIMERS

  • This article was written by a High End Systems Support Specialist who uses the stream deck for external freelance work, this is not a feature or a directly supported piece of hardware to the Hog 4 system. The service team is not responsible nor qualified to support and troubleshoot 3rd party products. 

 

  • Normal Stream Deck software/USB input does not work with Hog 4 or Hog 4 PC, Companion software has to be used to send OSC commands. 
  • Several 3rd party software and hardware devices are needed for this to work, they can stop working at anytime. Use at your own risk. 

  • Some networking knowledge is required to set up the system.

  • Some OSC knowledge is helpful.

  • Some image creation and editing knowledge is helpful.


Hardware Requirements

  • Console or Hog 4 PC

  • Stream Deck (6, 15, or 32 key

  • Computer

  • Raspberry PI  (Optional) 

    • (Specific model used for creating this guide "CanaKit Raspberry Pi 4 4GB Starter PRO Kit - 4GB RAM")

    • (4GB Minimum to work with Companion software)

  • USB Keyboard (If using RPI)

  • HDMI Monitor (If using RPI)

  • Network cables

  • USB to Ethernet Adaptor (Optional)

    • Recommended to use as a dedicated network adaptor to HogNet

  • Network Switch (Optional)

Software Requirements


Companion Setup

Important-Icon.png

Elegato Stream Deck software needs to be completely closed in order to run Companion on a computer. This can be done either by Task Manager or Windows Task Bar (Closing the software with the "X" at the top will not completely shut down the program)

 

It Is recommended to disable Stream Deck software from startup programs, to prevent it from overiding Companion after a restart

Network Map

SD MAP 2.jpg

Startup
  1. Connect the Computer to a Hog 4 console (HogNet port) or Hog 4 PC (Any ethernet port) via an ethernet patch cable. 
  2. Connect the Stream Deck to the computer via USB

  3. Ensure Elegato Stream Deck software is not running in the background

  4. Launch Companion software

  5. Select the network interface you intend to use (Likely an "Ethernet" Adaptor)

    1. If running Hog 4 PC and Companion on the same computer select a loopback or local host adaptor (127.0.0.1)

  6. Launch the GUI, This will open the interface in your default browser

Scan for Connected Stream Decks
  1. Select the "Surfaces" tab 
  2. Select "Rescan USB"
  3. Your Stream Deck should show up as a surface
Setup Hog 4 Connection
  1. Select the connections tab

  2. Search for the "High End Hog4 Module" 

  3. Press "Add" 

  4. Press "Edit"

  5. Set the Target IP to the IP Address of the HogNet Adaptor on your console or Hog 4 PC

    1. Default IP of HogNet is 172.31.0.1 

    2. Default OSC port is 7001

  6. Change the IP address of the computer running Companion to be in the same range

    1. How to Change IP Address on Windows 10 for Use with ETC Networks

    2. How to Change IP Address on macOS for Use With ETC Networks

    3. How to give your Raspberry Pi a Static IP Address

    4. Recommended to set the computer running Companion to:

      1. IP: 172.31.0.11

      2. Netmask:255.255.0.0

      3. Gateway: 172.31.0.1

      4. (A restart of the software might be required after changes are made)

Create Layout
  1. Select the "Buttons" Tab in Companion
  2. Select Presets
  3. Select High End Systems: Hog 4 
  4. Select and drag keys from the preset panel to the desired buttons on the stream deck

Hog Setup:

  1. Ensure the HogNet port is in the same range of the computer running companion software
    1. [SETUP] (Control Panel) (HogNet) to configure these settings, Recommended to set the Console running Companion to:
      1. IP: 172.31.0.1
      2. Netmask:255.255.0.0
      3. Gateway: 172.31.0.1
  2. Configure OSC Input
    1. [SETUP] (NETWORK) 
    2. Right-click on "Console", press "Settings"
    3. Select the (Open Sound Control) tab
  3. Enable OSC Input
    1. Ensure the grayed out IP address is the output address in Companion
    2. Ensure the Port is 7001
  4. Enable OSC Output 
    1. Input the IP address of the device running Companion
    2. Ensure the Port is 7001
  5. Press "OK"
The Computer running Companion should now be able to send OSC commands to Hog

 


Raspberry Pi setup (Optional)

A Raspberry Pi can be used in lieu of a computer to run the companion software. The Raspberry Pi can be run "headless" (no monitor, keyboard, or mouse attached once configured)

Specific model used for creating this guide "CanaKit Raspberry Pi 4 4GB Starter PRO Kit - 4GB RAM"

Make sure to fully assemble the RPI before powering it on, follow any instructions found inside the box, including installing heat sinks and fans!

Network Map (Configuration)

RPI MAP.jpg

Network Map (Compact)

RPI Compact Map 2.jpg

Burn Companion to RPI SD card
  1. Download the RPI version of Companion
  2. Download Etcher
  3. Insert the SD card from the RPI into the computer
  4. Run the Etcher program
    1. Select Image: Choose the software Image from step 1
    2. Select the SD card
    3. Select Flash
  5. Remove SD card once the burn is complete
Setup Companion on RPI
  1. Insert the burned SD card to the SD slot on the RPI 
  2. Connect the RPI to an external monitor
  3. Connect a USB Keyboard to the RPI
  4. Connect an ethernet patch cable to a separate computer
  5. Turn on power to the RPI 
  6. Lots of text should run on screen wait until the text stops scrolling
    1. Note that the RPI will have an IP address shown as "My IP Address Is XXX.XXX.XXX.XXX" 
    2. This IP address will be used to configure the Companion application
  7. Open a web browser on the attached computer from step 4
  8. Enter in the IP address from step 6-A followed by ":8000" 
    1. Example "192.168.0.101:8000"
    2. This can take some time to load the browser interface 
  9. Follow the steps from Companion Setup earlier in this guide
    1. Ensure Target IP address and port is set to the HogNet IP of the console
    2. Ensure to scan for the Stream deck via USB
  10. It is highly recommended to set a static IP address in range with the hog 4 console you are using
    1. How to give your Raspberry Pi a Static IP Address
    2. Recommended to use IP address: 172.31.0.12

 

Note-Icon.png

A layout can be created on one computer and exported to the RPI running Companion. 

 

More detailed instructions can be found on the GitHub page for the RPI Companion program

A video guide can also be found below: