Bitfocus AS
logo
logo
Bitfocus AS
logo
logo
Sign upSign in

Loading...

Bitfocus

Subscribe to our newsletter

The latest news, articles, and resources, sent to your inbox.

FacebookInstagramGitHubYouTubeLinkedIn

Products

  • Buttons
  • Companion

Integrations

  • Supported Devices
  • Developer Community
  • Connection Development

Support

  • Support Overview
  • Documentation
  • Video Tutorials
  • Community Forum

Sales

  • Resellers & Integrators
  • Buttons Pricing

Updates

  • Case Studies
  • Events & Trade Shows
  • Press Releases
  • Product Updates
  • Webinars

Legal

  • Legal Overview
  • Privacy Policy
  • Buttons EULA
  • Terms & Cookie Policy

Company

  • About us
  • Press kit
  • Careers

© 2026 Bitfocus AS. All rights reserved.

  1. Connections
  2. Bitfocus Companion - Satellite API
Bitfocus Companion

Bitfocus Companion

Satellite API

Communityv1.1.0Updated 3 months ago
DocumentationReport an issueView on GitHub

Documentation

Companion Satellite Module

This module allows you to connect one Companion instance to another using the Companion Satellite API. The connected Companion instance will appear as a satellite device.

Configuration

  • Target IP: The IP address of the Companion instance to connect to
  • Target Port: The port number for the satellite API (default is 16622)
  • Number of Columns: The number of columns to display (default is 8)
  • Number of Rows: The number of rows to display (default is 4)

Actions

  • Button Event: Send button events to the remote Companion
    • Choose row and column to target
    • Event types: Press, Release, Rotate Left, Rotate Right

Feedbacks

  • Button Image: Displays the image from the remote Companion button
    • Configure row and column to display

Presets

Presets are automatically created for each button in the grid. Each preset:

  • Displays the button image from the remote Companion
  • Sends appropriate press/release actions

Variables

  • $(companion-satellite:connection_state): Current connection state (Connected or Disconnected)
  • $(companion-satellite:companion_version): Version of the connected Companion instance
  • $(companion-satellite:companion_api_version): API version of the connected Companion instance
  • $(companion-satellite:target_address): Address of the target Companion instance

Usage

  1. Configure the module with the IP address and port of the target Companion instance
  2. The module will automatically connect and establish itself as a satellite device
  3. Add presets to your buttons to mirror and control the remote Companion instance
  4. Use actions to send specific button events to the remote Companion

Details

Manufacturer
Bitfocus Companion
Product
Satellite API
Latest Version
v1.1.0
Author
Julian Waller
Contributor
Julusian(18)

Open Issues and Requests

smokey-live#33 Fix remote button image letterboxingsmokey-live#32 [BUG]Satellite API "letterboxing" buttons on remote companion instanceSNRSE#29 Fix Issue with Companion 5 and the new GFX system by adding PNG bitmap negotiation and rendering using PNGsjordan-tanner#28 [Feature]:MikeDFWM#5 Button event: Press and release?

To file a new issue, you need to sign up for a user on GitHub.

Go to GitHub issues →

In other news

Buttons v1.8 Main with text

Buttons v1.8

October 2, 2026

Buttons v1.8 IBC award win

Bitfocus wins IBC2026 Best of Show Award for latest Buttons enhancements

September 21, 2026

Buttons v1.8 grey background

Biggest functionality boost yet makes Buttons the perfect platform for broadcast and media management

September 10, 2026

Vivid Buttons on screen

Bitfocus Buttons makes complex OB production feel simple

August 10, 2026

View all news →