Bitfocus Companion v3.3.0

📦 Downloads available at

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

💵 Donate to the project at

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

Companion v3.3.0 - Release Notes

📣 CORE FEATURES AND IMPROVEMENTS

• Improvements to code flow and performance of webui

• Add swap button to UI #2740

• Support 'local' variables in all internal actions, feedbacks and button text

• Support 'local' variables from modules (Note: modules need to opt into this)

• Shared udp listener #2399 (#2754)

• Extend expression syntax:

  • support for creating and decomposing objects and arrays
  • jsonpath function
  • split to array expressions function #2559
  • array join function (#2782)
  • encode and decode functions (#2842)

• add 'startup' page option in surface actions and feedbacks

• replace variable picker dropdown #2344 (#2787)

• Support custom names for Step Tabs (#2783)

• Preset text sub-headings (#2846)

• Support for Streamdeck Neo

• Support for older Loupedeck CT models

• Support for coordinates in Elgato software plugin (requires 3.0.0 of the plugin)

🐞 BUG FIXES

• support the new location system in companion cloud
• preset text not allowing expressions
• http api routes precedence #2820
• improve custom variable naming consistency in the ui #2812
• fix importing a config with an unknown module fails
• ensure variables in presets button text get replaced correctly #2837
• typo causing a crash in loupedeck-ct integration #2744
• correct order of presets

🧩 NEW & UPDATED MODULES

• adder-infinity100xseries
• adder-xdip
• aimedia-lexilive
• aja-helo
• aja-kipro
• aja-kumo
• allenheath-ahm
• arkaos-mediamaster
• aten-matrix
• audiotechnica-discussionsystem
• aver-ptz
• avstumpfl-pixera
• aws-elementallive
• axeltechnology-cgplus
• axeltechnology-vjpro
• barco-clickshare
• barco-pulse
• behringer-xair
• binwiederhier-ntfy
• birddog-cloud
• birddog-ptz
• bitfocus-cloud
• bmd-atem
• bmd-hyperdeck
• bmd-smartview
• bmd-teranex
• bmd-webpresenter
• broadlink-remote
• bss-soundweb
• canon-ptz
• canon-xf
• chamsys-quickq
• christie-spyder
• churchapps-freeshow
• colorlight-grandshow
• combitech-vidblasterx
• dan-dugan-automixer
• dashare-multiplay3
• dataton-watchout-json
• denon-recorder
• digitalprojection-projectors
• discord-api
• dolby-cinemaprocessor
• elgato-keylight
• emotimo-st4
• etc-eos
• figure53-go-button
• figure53-qlab-advance
• fora-mfr
• generic-blink
• generic-emberplus
• generic-midi
• generic-onvif
• generic-pjlink
• generic-ssh
• generic-stopwatch
• generic-swp02
• generic-tcp-serial
• generic-tcp-udp
• getontime-ontime
• glensound-minferno
• google-sheets
• h2r-graphics
• hdtv-wolfpackgreen
• hologfx-holographics
• homeassistant-server
• imimot-mitti
• interspace-mastercuev7
• justmacros-lua
• jvc-ptz
• lightware-lw3
• limagiran-holyrics
• malighting-grandma2
• malighting-grandma3
• malighting-msc
• microsoft-teams
• microsoft-vscode
• middleman-adit
• middleman-breaktime
• middlethings-middlecontrol
• mrmoco-mhc
• mvr-helios
• nec-display
• netgear-avline
• netio-powerbox
• neumannmueller-stageflow
• newblue-captivate
• notion-timestamp
• novastar-controller
• ntp-technology-dot
• obs-studio
• openweather-rest
• panasonic-avhs
• panasonic-kairos
• peavy-ratc
• pixelhue-switcher
• planningcenter-serviceslive
• polecam-autopod
• presentationtools-aps
• ptzoptics-superjoy
• ptzoptics-visca
• qsys-remote-control
• raspberry-gpio
• resolume-arena
• restream-api
• riedel-mediornet
• rogueamoeba-farrago
• roku-tv
• roland-v160hd
• roland-v60hd
• rundown-studio
• sgl-dct
• showcuesystems-scs
• shure-mxa910
• shure-p300
• shure-wireless
• simedia-yesapi
• singularlive-studio
• slack-webhooks
• smartavi-ipmatrix
• smodetech-smodelive
• softron-ontheairvideo
• sony-serialtally
• soundcraft-ui
• stagetec-xci
• studiocoast-vmix
• tascam-cd
• tascam-cd400u
• tascam-da-6400
• techministry-midirelay
• techministry-spotifycontroller
• telestream-prism
• tellyo-streamstudio
• tow-mixeffect
• tplink-kasasmartbulb
• tplink-kasasmartplug
• tplink-taposmartplug
• tslproducts-usp3
• vdo-ninja
• vicreo-hotkey
• videolan-vlc
• vitec-avediaplayer9300-series
• vivitek-projector
• voicemod-api
• yamaha-rcp
• zenvideo-ndirouter
• zerodensity-realityhub
• zinc-oscpoint
• zoom-osc-iso

Full Changelog: v3.2.2...v3.3.0

Bitfocus Companion v3.2.2

📦 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

Companion v3.2.2 - Release Notes

🐞 BUG FIXES

• Launcher window growing horizontally infinitely
• Ensure application exits properly with the launcher
• Fix logging of rosstalk connections #2758 #2747
• Show button previews in actions/feedbacks while editing triggers
• Grid header layout issues in firefox
• Incomplete documentation for expression syntax #2743
• Restarting modules during development being too agressive #2741

🧩 UPDATED MODULES

• allenheath-ahm
• bmd-hyperdeck
• bmd-webpresenter
• colorlight-grandshow
• figure53-qlab-advance
• generic-ssh
• justmacros-lua
• studiocoast-vmix

Full Changelog: v3.2.1...v3.2.2

Bitfocus Companion v3.2.1

📦 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

Companion v3.2.1 - Release Notes

🐞 BUG FIXES

• Disable emoji font, as it causes consume to consume all available memory on some windows machines #2714
• Ensure font paths are loaded relative to the application, not working directory #2716
• Buttons incorrectly scale up small images #2718
• Ignore disabled actions when checking connection status on a button
• Changing connection label fails if actions/feedbacks/events reference invalid variables #2719
• Connection list crashing #2735
• Ensure long page names don't cause page picker to split into multiple lines
• Occasional crash when disconnecting usb device #2735
• Increase launcher stable check timeout
• Imported emulators not being setup until restart
• Typo in tcp/udp documentation #2717

🧩 UPDATED MODULES

• birddog-ptz
• bmd-atem
• figure53-qlab-advance
• malighting-grandma3
• middlethings-middlecontrol
• netgear-avline
• pixelhue-switcher
• restream-api
• roku-tv
• roland-v60hd
• smodetech-smodelive
• softron-ontheairvideo
• studiocoast-vmix
• techministry-midirelay

Full Changelog: v3.2.0...v3.2.1

Bitfocus Companion v3.2.0

📦 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

Companion v3.2.0 - Release Notes

📣 CORE FEATURES AND IMPROVEMENTS

• Button grid can be resized to be smaller or larger than the default 8x4

• Rework button image drawing, to be higher resolution. This changes some font sizes slightly.

• Improved surface rotation, which rotates the whole surface not just the drawing of each button

• Change surface image scaling library to reduce install size and improve performance

• Use async HID library, removing spawning of child processes to handle HID devices

• Add fontsize and image scaling to satellite api

• Surfaces can be grouped, so that they follow page changes with each other

• Elgato Plugin performance improvements

• Export and import compressed configs

• Add support for Loupedeck CT

• Add support for Videohub Panel as a surface

• Send compressed button renders to webui

• Emulators can have their grid size changed

• Tablet page performance improvements

• Bonjour discovery broker to assist modules in discovering possible devices to control

• Indicate variables support on text input fields

• Internal action to set or create custom variable

• Slow down connection initiaisation at startup, to avoid crashes on lower power machines

• Change webui build tooling to be more modern

• Rework backend code to be loosely typed

• Rework various api implementations, to support customisable grid size and avoid 'bank' terminology

• Learn timeout can be configured by modules

• Add variables about surfaces and surface groups

• Add variables for connection statuses

• Add seperate press/release if condition actions

🐞 BUG FIXES

• Streamdeck Plus LCD strip image positioning
• Preserve sort order when importing connections
• Restore app_exit action
• Connections sometimes getting stuck and unable to start

🧩 NEW & UPDATED MODULES

• agf-characterworks
• audiostrom-liveprofessor
• avmediatools-protimer
• avocet-landscape
• avstumpfl-pixera
• aximmetry-composer
• barco-clickshare
• barco-eventmaster
• behringer-x32
• birddog-central
• birddog-cloud
• birddog-ptz
• bmd-atem
• bmd-hyperdeck
• bmd-ultimatte
• bmd-videohub
• bmd-webpresenter
• canon-ptz
• christie-spyder
• colorlight-grandshow
• colorlight-processor
• dan-dugan-automixer
• dataton-watchout
• denon-recorder
• depili-clock-8001
• emotimo-st4
• etc-eos
• etc-paradigm
• etcaudiovisuel-onlyview
• extron-smp351
• figure53-go-button
• figure53-qlab-advance
• gdsys-muxkvmswitch
• generic-bridge
• generic-dataentry
• generic-mqtt
• generic-pjlink
• generic-speedtest
• generic-stopwatch
• generic-swp02
• generic-tcp-serial
• getontime-ontime
• glensound-minferno
• globalcache-itac-cc
• google-sheets
• grassvalley-amp
• h2r-graphics
• iccms-sib
• iiyama-prolite
• imimot-mitti
• ipl-ocp
• kenku-fm
• leolabs-ableset
• lofas-ndistudioclock
• logos-proclaim
• luminex-gigacore
• luminex-luminode
• magewell-director
• malighting-grandma2
• malighting-grandma3
• malighting-msc
• massimo-callegari-qlcplus
• microsoft-vscode
• middlethings-middlecontrol
• mixtech-theatremix
• modulopi-moduloplayer
• mt-viki-matrix
• mvr-helios
• newtek-tricaster
• novastar-controller
• novastar-mediaserver
• novastar-switcher
• ntp-technology-dot
• obs-studio
• openweather-rest
• panasonic-kairos
• panasonic-projector
• panasonic-ptz
• pixelhue-mediaserver
• pixelhue-switcher
• planningcenter-serviceslive
• presentationtools-aps
• ptzoptics-visca
• qsys-remote-control
• riedel-mediornet
• rogueamoeba-farrago
• roku-tv
• roland-v60hd
• shelly-ws
• shure-mxcw
• shure-scm820
• shure-wireless
• simedia-yesapi
• singularlive-studio
• smodetech-smodelive
• snapav-wattbox
• softron-movierecorder
• softron-multicamlogger
• sonos-speakers
• soundcraft-ui
• spx-graphics-controller
• stagetimerio-api
• studiocoast-vmix
• tascam-cd
• tascam-cd400u
• tascam-da-6400
• techministry-midirelay
• tellyo-streamstudio
• teradek-prism
• theatrixx-xpresscue
• timemachines-clock
• tow-mixeffect
• ubiquiti-unifi
• vbaudio-voicemeeter
• vdo-ninja
• videolan-vlc
• vistream-online
• voicemod-api
• wled-websocket
• yamaha-rcp
• youtube-live
• zenvideo-ndirouter
• zinc-oscpoint

Full Changelog: v3.1.2...v3.2.0

Bitfocus Companion v3.1.2

📦 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

Companion v3.1.2 - Release Notes

🐞 BUG FIXES

• Fixed xkeys unable to show colours
• Fixed https binding to wrong port at startup (#2610)
• Fixed switching between version branches failing on windows
• Fixed crash with fresh config (#2557, #2615)
• Added default for lastUpgradeIndex (#2627)
• Updated some vulnerable dependencies
• Ensured timed triggers dont trigger when enabled unexpectedly (#2626)
• Fixed handle missing property in import (#2627)

🐞 MODULE FIXES

• dataton-watchout
• etc-eos
• generic-mqtt
• globalcache-itac-cc
• grassvalley-amp
• presentationtools-aps
• ptzoptics-visca
• qsys-remote-control
• shelly-ws
• softron-movierecorder
• videolan-vlc
• vistream-online

Full Changelog: v3.1.1...v3.1.2

Bitfocus Companion v3.1.1

📦 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

Companion v3.1.1 - Release Notes

🐞 BUG FIXES

• Fix Companion importing confir from 2.4 instead of 3.0 at first start of 3.1
• Companion cloud buttons missing some status fields
• Update pngjs to improve draw performance

Full Changelog: v3.1.0...v3.1.1

Bitfocus Companion v3.1.0

📦 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

Companion v3.1.0 - Release Notes

📣 CORE FEATURES AND IMPROVEMENTS

• Highlight trigger/connection being edited #2385 #2541
• More expression functions #2515 #2528
• Expose additional fields over ember+ #2435
• Export connection debug logs as csv #2529
• Ensure csv log export is encoded safely
• Add more connection status count variables #2507
• Use variable for step in internal: Button: Set current step #2294
• Set button step over tcp/udp #1520
• Add 12 hour internal time variables #2209
• Support for Contour Shuttle (#2436)
• Better time picker for trigger event #2544
• Reimplement infinitton surface support (untested)
• Allow inverting all boolean feedbacks #2547 (#2549)
• Support the razer stream controller
• Support Companion cloud
• Add Actions: Abort delayed actions on a trigger internal action
• Add events for computer becoming locked/unlocked #907

🐞 BUG FIXES

• Fix artnet listener
• Handle presets where feedbacks options are undefined
• Validate config path to import before importing
• Fix sunrise/sunset triggers causing crash
• Parsing variables containing $ would result in incorrect output

🧩 NEW & UPDATED MODULES

• agf-characterworks
• aja-helo
• allenheath-ahm
• analogway-midra
• aws-elementallive
• barco-eventmaster
• birddog-ptz
• bmd-atem
• bmd-teranex
• bmd-videohub
• bmd-webpresenter
• bytehive-playoutbee
• canon-ptz
• christie-spyder
• dashare-multiplay
• figure53-qlab-advance
• generic-http
• generic-pjlink
• generic-sacn
• generic-tcp-serial
• generic-timezone
• getontime-ontime
• glensound-divine
• globalcache-itac-ir
• globalcache-itac-sl
• iccms-sib
• jozeemedia-jcounter
• lea-amplifier
• leolabs-ableset
• leonreucher-vstopowerpoint
• magnimage-mig-ec
• microsoft-teams
• monospace-lightkey
• netgear-avline
• netio-powerbox
• newtek-tricaster
• novastar-coex
• novastar-controller
• novastar-d12
• openweather-rest
• panasonic-kairos
• panasonic-panapod
• panasonic-ptz
• pixelhue-fseries
• pnh-opencountdown
• presentationtools-aps
• presentationtools-cuetimer
• shelly-http
• shelly-ws
• shure-mxw
• skaarhoj-rawpanel
• sonos-speakers
• squared-powerlink
• telegram-bot
• tellyo-streamstudio
• tesla-smart
• tesmart-hdmimatrix
• tslproducts-umd
• utahscientific-bpspanel
• videolan-vlc
• visualproductions-timecore
• wled-websocket
• youtube-live
• zenvideo-ndirouter
• zoom-osc-iso

Full Changelog: v3.0.1...v3.1.0

Bitfocus Companion v3.0.1

📦 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

Companion v3.0.1 - Release Notes

If you are coming from v2, make sure to check the changes in v3.0.0-RC1, v3.0.0-RC2 and v3.0.0, in particular the BREAKING CHANGES.

🐞 BUG FIXES

• Local building of docker image #2542
• Missing node/yarn binaries in docker image
• Allow modules to expose .companionconfig files in help pages
• Time of day trigger value validation #2544
• Trigger editor references conditions instead of feedbacks
• Allow multiselect fields in legacy modules
• Page buttons not showing in new installations
• Warn about invalid port number being selected in the launcher
• Trigger incorrectly firing when all the conditions are invalid #2397
• Don't crash on presets missing feedback options

🧩 MODULES WITH BUG FIXES

• barco-eventmaster
• barco-pds
• behringer-xair
• bmd-atem
• bmd-smartview
• figure53-qlab-advance
• generic-filereader
• generic-pjlink
• google-sheets
• hdtv-wolfpackgreen
• imimot-mitti
• newtek-tricaster
• panasonic-projector
• planningcenter-serviceslive
• presentationtools-aps
• presentationtools-cuetimer
• renewedvision-propresenter
• resolume-arena
• teradek-prism
• tplink-kasasmartdimmer
• tslproducts-umdlistener
• videolan-vlc
• vistream-online
• vizio-smartcast

Bitfocus Companion v3.0.0

Companion v3.0.0 - 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

Changes are relative to v3.0.0-RC2

If you are coming from an older version, make sure to check the changes in v3.0.0-RC1 and v3.0.0-RC2, in particular the BREAKING CHANGES.

📣 CORE FEATURES AND IMPROVEMENTS

• Additional string functions in expressions

🐞 BUG FIXES

• Unable to start headless in new installations
• Emberplus server failing to handle incoming updates
• Crash when prompting about a version conflict
• Missing line ending in log files
• Make version number in header more durable
• Headless --admin-interface parameter
• Improve performance when a large number of variables are changed

🧩 NEW & UPDATED MODULES

• agf-characterworks
• aja-kumo
• analogway-awj
• analogway-livecore
• analogway-livepremier
• anomes-millumin
• arri-tally
• audiotechnica-ceilingarray
• audiotechnica-digitalmixer
• aver-ptz
• barco-eventmaster
• bbc-raven
• behringer-xair
• betr-support
• bmd-hyperdeck
• bmd-smartview
• bytehive-playoutbee
• canon-ptz
• canon-xf
• chamsys-quickq
• dataton-watchout
• discord-api
• elgato-keylight
• epson-businesspj
• extron-smp351
• figure53-go-button
• generic-http
• generic-pjlink
• generic-smtp
• generic-ssh
• google-sheets
• govee-lights
• irisdown-remoteshowcontrol
• kiloview-encoder
• lightware-lw3
• middlethings-middlecontrol
• netio-powerbox
• notion-timestamp
• panasonic-projector
• panasonic-ptz
• pharos-designer
• ptzoptics-visca
• qsys-remote-control
• renewedvision-pvp
• resolume-arena
• roland-v600uhd
• roland-v60hd
• sony-bravia
• stagetimerio-api
• studiocoast-vmix
• techministry-spotifycontroller
• toggl-track
• tow-mixeffect
• tplink-kasasmartbulb
• tplink-kasasmartplug
• tslproducts-umdlistener
• twitch-api
• videolan-vlc
• vistream-online
• zoom-osc-iso

Bitfocus Companion v3.0.0 - RC2

Companion v3.0.0 RC2 - 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

• macOS must be at least 10.15 to run Companion. This is due to nodejs dropping support for older versions.

📣 CORE FEATURES AND IMPROVEMENTS

• Documentation is updated for 3.0
• Port numbers are shown for all protocols in the Settings page, even those which cannot be changed
• Config directories have been rearranged to be more logical and futureproof
• New trigger event, 'on condition becoming false'

🐞 BUG FIXES

• Pagenumber buttons not drawing correctly #2468
• Update sharp to fix macOS 10.15 support
• Include logs in support bundle #2287
• Tablet page not supporting delayed press groups #2475
• Multiple decrement/increment page for a surface on a button dont combine as expected #2328
• Crash on windows if powershell.exe is unavailable #2474
• Set serialnumber to page "Back" can stop working #2484
• show_topbar button style not importing from 2.4 correctly
• Streamdeck Mini with latest firmware not working on Windows

🧩 NEW & UPDATED MODULES

• anomes-millumin
• atlasied-atmosphere
• audiovero-unityintercom-client
• barco-pulse
• betr-support
• bitfocus-cloud
• bmd-atem
• bmd-smartview
• bmd-videohub
• canon-ptz
• christie-projector
• cisco-roomos
• cvmeventi-countdown
• discord-api
• emotimo-st4
• etc-eos
• etc-paradigm
• generic-osc
• generic-pjlink
• generic-tcp-serial
• getontime-ontime
• govee-lights
• greengo-intercom
• h2r-graphics
• imimot-mitti
• interactivetechnololgies-cueserver
• interspace-mastercuev7
• kiloview-encoder
• leolabs-ableset
• lightware-lw3
• malighting-msc
• marshall-ipcamera
• middleman-adit
• netron-en
• newtek-tricaster
• pharos-designer
• pixap-pixtimerpro
• renewedvision-propresenter
• shure-psm1000
• shure-scm820
• softron-movierecorder
• softron-ontheairvideo
• studiocoast-vmix
• tascam-bdmp1
• techministry-timekeeper
• teradek-prism
• tow-mixeffect
• tplink-kasasmartplug
• vbaudio-voicemeeter
• yamaha-rcp
• zoom-osc-iso

Full Changelog: v3.0.0-rc1...v3.0.0-rc2