Bitfocus Companion v3.0.0 - RC1

Companion v3.0.0 RC1 - Release Notes

📦 Downloads available at

• https://user.bitfocus.io/download

💵 Donate to the project at

• https://donorbox.org/bitfocus-opensource
• or via open collective https://opencollective.com/companion

BREAKING CHANGES

• Windows 7, 8 and 8.1 are no longer supported. This is due to Chromium ending support for these versions.
• Modules are required to be written in a new format. Some modules may be broken or missing if they have not been updated before the release.
• Companion now runs on node 18. This should have no impact to users, only module developers.
• Large parts of the internals of Companion have been overhauled or rewritten.
• Format of streamdeck and other surfaces ids have changed. They may become unlinked in some places
• Some modules have made some breaking changes due to new requirements from Companion. Make sure to check everything over before your first show.

📣 CORE FEATURES AND IMPROVEMENTS

• Updated logo
• Modernisation and large restructuring of codebase
• Modules run in child processes. This ensures that module crashes cannot crash the whole of Companion
• buttons can have multiple steps (replaces latching) (#1630) (#2187)
• buttons can execute different actions for long presses (#2171)
• Use hidraw usb backend on linux, this will improve usb performance on linux or companion-pi
• Split launcher and Companion main process, allow for better recovery if companion crashes
• Support module development against release builds of Companion
• Rework ui data flow, to reduce amount of data sent to the ui
• Support multiple emulators with new styling
• Overhaul tablet/web views and remove old tablet/web-buttons pages
• Watch for usb devices being connected
• Show inactive surfaces in the ui
• Various usability improvements to editing buttons (#2127)
• Action recorder (#2125)
• Show button preview on internal actions & feedbacks (#2102)
• Enable/disable any action or feedback on a button or trigger
• Connections list is now manually sortable
• Triggers list is now manually sortable
• Custom variables list is now manually sortable
• Overhaul triggers editor to be like the button editor
• Support multiple event sources per trigger, and a separate condition
• Trigger on sunrise/sunset
• Image buffers returned from feedbacks will now be properly composited
• Launcher option to run at login
• Improved search function in add connections list
• Support rotary events from elgato streamdeck plugin
• Support the new Razer Stream Controller X
• Improved expression syntax with support for functions and strings
• UI style improvements
• New import/export system, allowing for more fine-grained control
• New variables of page names
• Rework internal actions to have less duplication
• Improve handling of pin locking
• Log file gets rotated with a limited size
• Surfaces can be set to never follow pin lock

🐞 BUG FIXES

• Ensure variable ids are valid
• Ensure custom variable ids are valid
• Ensure connection labels are valid
• Color picker indicates the currently selected swatch

🧩 NEW MODULES

• marshall-ipcamera
• riedel-mediornet
• panasonic-p2
• obsidiancontrol-onyx-osc
• apc-ups
• hdtv-wolfpackgreen
• camstreamer-camstreamer
• roland-p20hd
• restream-api
• gnuralnet-livetoair
• shure-mxcw
• microsoft-vscode
• android-tv
• cablematters-hdmimatrix
• simedia-yesapi
• rgblink-vsp628pro
• soundtrack-remote
• colorlight-processor
• eaton-epdu
• roland-vr120hd
• netgeat-avline
• atlasied-atmosphere
• ezcoo-matrix
• openrgb-sdk
• cyberpower-pdu

Full Changelog: v2.4.2...v3.0.0-rc1

Bitfocus Companion v2.4.2

Companion v2.4.2 - Release Notes

📦 Downloads available at

• https://user.bitfocus.io/download

💵 Donate to the project at

• https://donorbox.org/bitfocus-opensource
• or via open collective https://opencollective.com/companion

🐞 BUG FIXES

• UI crash after saving a trigger
• UI crash if module status is not a string
• Missing libasound2 in docker image

🐞 MODULE FIXES

• bitfocus-companion
• equipson-lightshark
• generic-artnet
• generic-sacn
• haivision-connectdvr
• zoom-osc-iso

Full Changelog: v2.4.1...v2.4.2

Bitfocus Companion v2.4.1

Companion v2.4.1 - Release Notes

📦 Downloads available at

• https://bitfocus.io/user/download

💵 Donate to the project at

• https://donorbox.org/bitfocus-opensource
• or via open collective https://opencollective.com/companion

🐞 BUG FIXES

• X-keys LEDs always show colors from page 1
• Fixes for Loupedeck support
• Dropdowns using allowCustom reject values if not using regex
• Export page broken (#2210)
• Colorpicker in modals broken (#2203)

🐞 MODULE FIXES

• analogway-awj
• bmd-atem
• esphome-api
• figure53-qlab-advance
• middleman-adit
• roland-v60hd
• zoom-osc-iso

Full Changelog: v2.4.0...v2.4.1

Bitfocus Companion v2.4.0

Companion v2.4.0 - Release Notes

📦 Downloads available at

• https://bitfocus.io/user/download

💵 Donate to the project at

• https://donorbox.org/bitfocus-opensource
• or via open collective https://opencollective.com/companion

📣 CORE FEATURES AND IMPROVEMENTS

• Option to enable react-dnd-touch-backend 'experiment'
• Filter in variables table (#1899)
• Additional custom variable internal actions
• Option to persist custom variable
• Support for new Stream Deck XL revision
• Loupedeck Live support (#2110)
• Loupedeck Live S support
• Stream Deck + support

🐞 BUG FIXES

• Increase yarn timeout to avoid failed builds
• Fix multi-dropdown maxSelection property
• Dropdown not enforcing regex when adding custom values
• Satellite bitmap rotation
• Add action/feedback modal fails to display error
• Missing method on X-keys
• Colors for bottom row of X-keys buttons not showing
• Docker: use correct directory when local modules are added (#2163)
• Select input dropdowns being clipped inside scroll regions
• Color picker posititioning
• Restore custom variable values when importing config (#2191)

🧩 NEW MODULES

• analogway-awj
• arri-tally
• audac-mtx
• birddog-central
• blustream-hdmimatrix
• cleartouch-ippctrl
• discord-api
• djsoft-radioboss
• ecamm-live
• eiki-wspprojector
• generic-filereader
• generic-ping
• google-sheets
• middleman-adit
• neumannmueller-stageflow
• nortek-bluebolt
• pnh-soundr
• rationalacoustics-smaart4
• rgblink-mini
• rgblink-x3
• roland-v160hd
• televic-dcerno
• tplink-kasasmartstrip
• tslproducts-umdlistener
• utahscientific-bpspanel
• vdwall-lvp615
• vislink-ulrx-ld
• vizrt-tcp-engine-trio

👍🏻 MODULE IMPROVEMENTS

• aja-helo
• arkaos-mediamaster
• barco-eventmaster
• behringer-x32
• behringer-xair
• birddog-ptz
• bitfocus-companion
• bmd-atem
• bmd-hyperdeck
• bmd-webpresenterhd
• denon-receiver
• figure53-qlab-advance
• generic-pjlink
• generic-tcp-serial
• generic-tcp-udp
• getontime-ontime
• h2r-graphics
• imimot-mitti
• ipl-ocp
• kramer-matrix
• liminalet-zoomosc
• ltn-schedule
• magewell-proconvert-decoder
• magewell-ultrastream
• malighting-grandma2
• motu-avb
• newtek-tricaster
• obs-studio
• panasonic-kairos
• panasonic-ptz
• pixap-pixtimerpro
• pnh-opencountdown
• presentationtools-aps
• presentationtools-cuetimer
• rationalacoustics-smaart3
• renewedvision-propresenter
• roland-v60hd
• rossvideo-videoserver
• seervision-suite
• softron-movierecorder
• sony-visca
• studiocoast-vmix
• techministry-spotifycontroller
• tesmart-hdmimatrix
• timemachines-clock
• tslproducts-umd
• vdo-ninja
• videolan-vlc
• vizio-smartcast
• yamaha-rcp
• zoom-osc-iso

Full Changelog: v2.3.1...v2.4.0

Bitfocus Companion v2.3.1

Companion v2.3.1 - Release Notes

📦 Downloads available at

• https://bitfocus.io/user/downloads

💵 Donate to the project at

• https://donorbox.org/bitfocus-opensource
• or via open collective https://opencollective.com/companion

🐞 BUG FIXES

• Presets panel sometimes erroring after adding an instance
• Dockerfile install iputils-ping (#2084)
• Detect satellite sockets going stale and close them
• Calls to child.send for disconnected usb devices fail
• Clone cached actions/feedbacks/presets so that UI can reliably get changes
• "Failed to build list of modules" due to module keyword issues (#2111)
• Unable to enable/disable triggers via action (#2082)

🐞 MODULE FIXES

• bitfocus-companion
• bmd-atem
• bytehive-playoutbee
• evertz-quartz
• generic-tcp-serial
• haivision-connectdvr
• homeassistant-server
• planningcenter-serviceslive
• pnh-opencountdown
• sony-cled
• techministry-spotifycontroller
• tslproducts-umd
• vicreo-hotkey
• vystem-api
• zoom-osc-iso

Full Changelog: v2.3.0...v2.3.1

Bitfocus Companion v2.3.0

Companion v2.3.0 - Release Notes

📦 Downloads available at

• https://bitfocus.io/user/downloads

💵 Donate to the project at

• https://donorbox.org/bitfocus-opensource
• or via open collective https://opencollective.com/companion

📣 CORE FEATURES AND IMPROVEMENTS

• Set custom variables with the remote protocols (HTTP, UDP, TCP & OSC)
• Support the new revision of the Streamdeck Mini
• Optimise data sending to the browser, to make usage smoother over a VPN
• Add 'learn' button for actions and feedbacks to populate with the current values (not implemented in many modules)
• Modules can handle some http requests, allowing for simpler workflows

🐞 BUG FIXES

• Better error handling in the UI
• Improve UI performance
• Sanitise filename of exports for unusual characters
• Add connection filter box crash with certain strings
• Time interval triggers could get into an infinite loop

🧩 NEW MODULES

• biamp-tesira
• devantech-ds
• epson-businesspj
• equipson-lightshark
• evertz-quartz
• getontime-ontime
• notion-timestamp
• pnh-opencountdown
• sony-cled
• techministry-spotifycontroller
• teradek-prismflex
• videocom-zoom-bridge
• zoom-osc-iso

👍🏻 MODULE IMPROVEMENTS

• aja-kumo
• audiostrom-liveprofessor
• birddog-ptz
• bitfocus-companion
• bitfocus-snapshot
• bmd-atem
• bmd-hyperdeck
• bmd-videohub
• bmd-webpresenterhd
• dataton-watchout
• draco-tera
• figure53-qlab-advance
• fora-hvs
• generic-pjlink
• haivision-kbencoder
• ipl-ocp
• kramer-vp727
• lgtv-display
• newbluefx-titler
• newtek-ndistudiomonitor
• panasonic-kairos
• phillips-hue
• sennheiser-evolutionwireless
• studiocoast-vmix
• teradek-vidiu
• theatrixx-xpresscue
• timemachines-clock
• toggl-track
• tow-mixeffect
• vicreo-hotkey
• videolan-vlc

Full Changelog: v2.2.3...v2.3.0

Bitfocus Companion v2.2.3

Companion v2.2.3 - Release Notes

v2.2.3 is a stable release with bug fixes for the core application and 6 modules.

📦 Downloads available at

• https://bitfocus.io/user/downloads

💵 Donate to the project at

• https://donorbox.org/bitfocus-opensource
• or via open collective https://opencollective.com/companion

🐞 BUG FIXES

• Fixed surface picker id property
• Mitigated corrupt db fatal crashes
• Minor UI fixes for action/feedback options

🐞 MODULE FIXES

• birddog-ptz
• bitfocus-companion
• figure53-qlab-advance
• generic-pjlink
• ubiquiti-unifi
• visualproductions-bstation2

Full Changelog: v2.2.2...v2.2.3

Bitfocus Companion v2.2.2

Companion v2.2.2 - Release Notes

v2.2.2 is a stable release with bug fixes for 7 modules.

📦 Downloads available at

• https://bitfocus.io/user/downloads

💵 Donate to the project at

• https://donorbox.org/bitfocus-opensource
• or via open collective https://opencollective.com/companion

🐞 MODULE FIXES

• etc-eos
• generic-pjlink
• groupme-webhooks
• lgtv-display
• panasonic-projector
• roland-v600uhd
• studiocoast-vmix

Full Changelog: v2.2.1...v2.2.2

Bitfocus Companion v2.2.1

Companion v2.2.1 - Release Notes

📦 Downloads available at

• https://bitfocus.io/user/downloads

💵 Donate to the project at

• https://donorbox.org/bitfocus-opensource
• or via open collective https://opencollective.com/companion

📣 CORE FEATURES AND IMPROVEMENTS

• Support for the new Elgato Pedal
• Better support for custom modules when using Docker
• Action & Feedback browser
• Option to remove the top-bar per button
• Performance improvements of the admin UI
• Improvements to the Satellite API

🐞 BUG FIXES

• Fix support for Windows 7
• Some fixes when importing pages/exports
• Better XKeys support
• Some crash fixes

🧩 NEW MODULES

• adder-xdip
• allenheath-avantis
• birddog-ptz
• cvmeventi-countdown
• disguise-smc
• esphome-api
• groupme-webhooks
• kiloview-encoder
• lea-amplifier
• lgtv-display
• mvr-helios
• orei-matrix
• panasonic-kairos
• reddotlogics-hdmimatrix
• samsung-display
• sennheiser-evolutionwireless
• theatrixx-xpresscue
• tplink-taposmartplug
• ventuz-director
• workflownetwork-livetime

👍🏻 MODULE IMPROVEMENTS

• aja-helo
• aja-kumo
• barco-eventmaster
• birddog-ptz
• bitfocus-companion
• bmd-atem
• bmd-hyperdeck
• bmd-teranex
• bmd-videohub
• bmd-webpresenterhd
• canon-ptz
• christie-projector
• danielnoethen-butt
• digitalloggers-powercontroller
• draco-tera
• generic-artnet
• generic-http
• generic-osc
• generic-pjlink
• generic-swp08
• generic-websocket
• globalcache-itac-sl
• grassvalley-amp
• haivision-connectdvr
• homeassistant-server
• iiyama-prolite
• imagine-lrc
• imimot-mitti
• ltn-schedule
• magewell-proconvert-decoder
• makeprox-glue
• middlethings-middlecontrol
• newtek-tricaster
• noismada-octopuslistener
• novastar-controller
• obs-studio
• pixap-pixtimerpro
• roland-v600uhd
• roland-xs84h
• showcuesystems-scs
• skaarhoj-rawpanel
• snapav-wattbox
• softron-ontheairvideo
• spotify-remote
• studiocoast-vmix
• techministry-midirelay
• tow-mixeffect
• vicreo-hotkey
• vystem-api
• yamaha-rcp

Bitfocus Companion v2.2.0

Companion v2.2.0 - Release Notes

📦 Downloads available at

• https://bitfocus.io/user/downloads

💵 Donate to the project at

• https://donorbox.org/bitfocus-opensource
• or via open collective https://opencollective.com/companion

📣 CORE FEATURES AND IMPROVEMENTS

• New UI: Written in React, designed to be much faster and more responsive
• New Configuration Wizard for new installs and upgrades
• MacOS builds are now signed and notarized, and Windows builds are signed
• Native builds for MacOS M1 processors (arm64)
• "Getting Started" Documentation Updated and Revised
• Scheduler/Trigger Management: Now you can schedule button presses based on variable values or time of day. Automate anything with Companion!
• Custom variables: Create your own variables independent of modules/connections. You can then pass these into actions or triggers.
• Re-added Ember+ server
• Additional draw functions in Image
• Option to remove the top bar on all buttons
• Context menu added to tray icon for quick access to core functions, like rescanning for USB devices
• Instances are now called Connections
• Support for X-Keys surfaces/devices (disabled by default on upgrades)
• Ability to clear the png image used on a button
• Modules no longer loaded at launch to reduce startup time
• Streamdecks can be positioned inside the 8x4 grid, not always the top left corner
• Streamdecks can now be named in the UI for easier identification
• Serve the webui over https. Note: This does not mean it should be exposed to the internet, and is intended to allow - for embedding in iframes within other applications
• USB rescan can now be triggered over the remote API protocols
• New Satellite API implementation. Simpler to implement on clients, and won't have breaking changes in future releases.
• TCP/HTTP/OSC/UDP APIs are now all opt-in (automatically enabled for existing installations), and can be run on custom ports
• Path of Companion config directory can now be specified with the COMPANION_CONFIG_BASEDIR environment variable

BREAKING CHANGES

• The Elgato plugin (to allow you to use both Companion and the Elgato Stream Deck software at the same time) is now opt-in within Companion and disabled by default, in order to avoid conflicts between both sets of software. It must be enabled in Companion before it can be used.

🐞 BUG FIXES

• MacOS: UI breaking after companion has been running for many days
• Added try-catch blocking for some instance calls
• Allow PWA (Progressive Web App) for all pages
• Add some additional characters to the 7px text font
• Variable parsing can no longer get stuck in infinite loops
• MacOS: Allow binding the webui to vlan/vpn interfaces
• Various other fixes and improvements

🧩 NEW MODULES

• Arkaos Mediamaster
• Allen & Heath AHM
• Allen & Heath Avantis
• Axis PTZ
• Barco Clickshare
• Biamp Audia
• Bitfocus Snapshot
• Blackmagic Audio Monitor
• Blackmagic WebPresenter HD
• Blackbird HDMI Matrix
• Blackbox Boxilla
• Boinx Mimolive
• Boreal Systems Director
• Brompton Tessera
• ByteHive PlayoutBee
• Canon PTZ
• Canon XF
• Cisco WebEx (Websocket)
• ClassX Liveboard
• Connect Webcaster
• Ctpsystems dio8008r
• Cyp HDMI Matrix
• Daniel Nöthen butt - broadcast using this tool
• Dataprobe iBoot PDU
• Dcc Ex Command Station
• Digital Loggers Power Controller
• Extron XTP 3200
• Generic Websocket
• Generic SWP08
• Haivision KBencoder
• Hermann StageTimerIO
• Ifelseware avkey
• Iiyama Prolite
• Intelix INT-HDX
• ioversal Vertex
• IPL OCP
• Imagine LRC
• Jozee Media J-Counter
• Kiloview NDI
• LeadLED Clockotron
• Leafcoders Titler
• Linkbox Remote
• Livemind Recorder
• Ltn Schedule
• Lumens Media processor
• Magic Home Blub
• Makepro-x Glue
• Middlethings Middlecontrol
• Muxlab KVM
• Nexo NXAMP
• Nobe Omniscope
• Novastar H-Series
• Olzzon NDI Controller
• Panasonic Lumix
• Phillips Hue
• Rocosoft PtzJoy
• RossVideo Video Server
• Seervision Suite
• Shure MXA910
• Shure MXN5
• Shure P300
• Shure SCM820
• Skaarhoj Raw Panel
• SnapAV WattBox
• Softouch EasyWorship
• Softron MovieRecorder
• Sony Broadcast Monitor
• Spotify Remote
• SPX GC
• Symetrix DSP
• Tally-MA Wireless Tally
• Teradek VidiU X
• Tesmart HDMI Matrix
• Time Machines Corp Clock
• Toggl Track
• TPLink Kasa Smart Blub
• TPLink Kasa Smart Dimmer
• TPLink Kasa Smart Plug
• TVOne Corio
• Tow MixEffect
• Visual Productions Cuety
• VDO Ninja
• Vimeo Livestream Studio 6
• Vistream Online
• vystem Platform

👍🏻 MODULE IMPROVEMENTS

Many of our modules have had various new features and bugfixes since our last public release of Companion.

• Allean & Heath QU
• Allean & Heath SQ
• AJA Ki Pro
• AJA Kumo
• Analog Way Aquilon Line
• Audivero Unity Intercom Client
• Avolites Titan
• Barco Eventmaster
• Barco Pulse
• Behringer X32/M32
• Behringer XAir
• Behringer Wing
• Birddog Studio
• Birddog VISCA
• Bitfocus Companion
• Blackmagic ATEM
• Blackmagic Hyperdeck
• Blackmagic Multivew 4
• CasparCG Server
• Chamsys MagicQ OSC
• Christie Projector
• Cisco CMS
• Dataton Watchout
• Depili Clock-8001
• Dolby Cinema Processor
• Elgato Keylight
• Epiphan Pearl
• ETC EOS
• Extron SMP351
• Figure53 Go Button
• Figure53 QLab Advanced
• Generic Artnet
• Generic EmberPlus
• Generic HTTP
• Generic TCP/UDP
• Generic MQTT
• Generic OSC
• Haivision Connect DVR
• Haivision KB Encoder
• H2R Graphics
• Homeassistant
• Ifelseware avplayback
• Imimot Mitti
• JVC PTZ
• Liminalet ZoomOSC
• Lumens VISCA
• Magewell Proconvert Decoder
• Matrox Monarch
• Motu AVB
• Neodarque StageTimer2
• Newbluefx titler
• Newtek Tricaster
• OBS Studio
• OpenLP HTTP
• Panasonic AVHS
• Panasonic Camera Controller
• Panasonic Projector
• Panasonic PTZ
• Presentation tools APS
• Presentation tools Cuetimer
• Prsi iPower
• Resolume Arena
• Renewed Vision ProPresenter
• Renewed Vision PVP
• Roku TV
• Roland M5000
• Roland V60HD
• Roland V1200HD
• Rossvideo Xpression
• Shure PSM1000
• Shure Wireless
• Singular Live Studio
• Soundcraft UI
• Studiocoast vMix
• Tech Ministry Tally Arbiter
• Teradek Vidiu
• ThingM Blink(1)
• TSL Products UMD
• Twitch API
• Ubiquiti Unifi
• Vicreo Hotkey
• Vicreo Variable Listener
• Videolan VLC
• Vizio smartcast
• Yamaha RCP
• Youtube Live

Full Changelog: v2.1.4...v2.2.0