Skip to content

Commit

Permalink
Merge pull request #147 from istnv/feat/selected
Browse files Browse the repository at this point in the history
Document recovery from passcode failure
  • Loading branch information
istnv authored Nov 13, 2024
2 parents fc62b20 + dceba9a commit b6fb2ac
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 2 deletions.
7 changes: 6 additions & 1 deletion companion/HELP.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,12 +10,13 @@ Due to the nature and volume of information feedback and variables are only avai
This may cause a noticible increase in network traffic.

This is being updated and maintained for QLab5.
QLab 4.7 compatibility is checked will be continued when possible.
QLab 4.7 compatibility is checked and will be continued when possible.
While QLab3 is detected, some features may not work.

## **Notice!**

QLab versions 5.2 and onward will require version `2.1.0` or newer of this module!
See below for OSC passcode warnings.

---

Expand Down Expand Up @@ -161,6 +162,10 @@ From QLab preferences OSC controls tab make sure you have the "Use OSC controls"
QLab 5 configuration is under the **Network / OSC Access** page on the Workspace Settings window.
![QLab5](images/QLab5.jpg?raw=true 'QLab5')

### **Note**

QLab 5 creates new workspaces with a random OSC passcode which changes the module startup procedure. As a security measure, QLab will ignore any commands if an incorrect passcode is sent too many times in a row. This module has been designed to be robust and automatically recover from most network errors. To prevent QLab from locking out, this restart/retry function will stop when detecting an incorrect passcode. You will need to enter and save the correct passcode to restart the module.

### Running cue examples

QLab can run many cues at the same time while Stream Deck has a limited number of buttons visible at once. So which _one_ cue is the most useful to show on a button? This module looks for the most recently run (GO) cue and favors _run all at once_ Group cues over other types of cues.
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "figure53-qlab-advance",
"version": "2.9.0",
"version": "2.9.1",
"main": "qlabfb.js",
"type": "module",
"scripts": {
Expand Down

0 comments on commit b6fb2ac

Please sign in to comment.