bug fixes, feature release v2023.4

.gitignore

@@ -2,6 +2,7 @@ __pycache__
 .DS_Store
 env
 dist
+dist-2
 build
 icon.svg
 icon(big).icns

app/csv_parser.py

@@ -117,7 +117,9 @@ def send_csv(ip, document, qlab_version, passcode):
 
         # File Target
         if cue.get("filetarget"):
-            bundle.add_content(cue_fileTarget(f"{cue['filetarget']}"))
+            bundle.add_content(cue_fileTarget(f"{cue['filetarget']}").build())
+
+
 
         # Color
         if cue.get("color"):
@@ -126,6 +128,19 @@ def send_csv(ip, document, qlab_version, passcode):
         if cue.get("text"):
             bundle.add_content(text_text(cue['text']).build())
 
+        # fade cues
+        if check_cue_type(cue["type"]) == "fade":
+            # Stop Target When Done
+            if cue.get("stoptargetwhendone"):
+                bundle.add_content(fade_stopTargetWhenDone(bool(cue['stoptargetwhendone'])).build())
+
+        # Video Cues
+        if check_cue_type(cue["type"]) == "video":
+            # Set video stage
+            if cue.get("stagenumber"):
+                bundle.add_content(vid_stageNumber(cue["stagenumber"]).build())
+
+
         # Midi Cues
         if check_cue_type(cue["type"]) == "midi":
             if cue.get("midimessagetype"):

app/qlab_osc_dictionary.py

@@ -240,6 +240,18 @@ def cue_fadeAndStopOthersTime(number):
     msg.add_arg(int(number))
     return msg
 
+def fade_stopTargetWhenDone(boolean):
+    """
+    Read: If no argument is given, return the state of the Stop target when done checkbox of the specified cue.
+
+    Write: Set the state of the Stop target when done checkbox of the specified cue.
+    See details on booleans at the beginning of this section.
+    """
+
+    msg = osc_message_builder.OscMessageBuilder(address="/cue/selected/stopTargetWhenDone")
+    msg.add_arg(boolean)
+    return msg
+
 
 def cue_fileTarget(string):
     """
@@ -599,4 +611,22 @@ def text_text(string):
         address="/cue/selected/text"
     )
     msg.add_arg(string)
+    return msg
+
+
+def vid_stageNumber(number):
+    """
+    Read: If no argument is given, return the index of the video stage currently in use by the specified cue.
+    Index 0 means that the cue is un-patched, index 1 means the first stage in the video stage list in
+    Workspace Settings, 2 means the second stage, and so on.
+
+    Write: If number is given, set the video stage of the specified cue to that stage.
+    If number is 0, un-patch the specified cue. If number is greater than the number of
+    video stages in the workspace, this message has no effect. number must be a whole number.
+    """
+
+    msg = osc_message_builder.OscMessageBuilder(
+        address="/cue/selected/stageNumber"
+    )
+    msg.add_arg(int(number))
     return msg

app/static/example_file/csv_test_doc.csv

@@ -1,36 +1,36 @@
-Type,Number,Name,Notes,continueMode,Target,File Target,Color,MIDI Message Type,Midi Command Format,Midi Command,Midi Device ID,Midi Control Number,Midi Control Value,Midi Patch Name,Midi Patch Number,Midi Q List,Midi Q Number,Network Patch Number,Custom String
-audio,1,Test 1,,1,,,red,,,,,,,,,,,,
-mic,5,Test 2,,2,,,orange,,,,,,,,,,,,
-video,9,Test 3,,3,,,green,,,,,,,,,,,,
-camera,13,Test 4,,1,,,blue,,,,,,,,,,,,
-text,17,Test 5,,2,,,purple,,,,,,,,,,,,
-light,21,Test 6,,3,,,red,,,,,,,,,,,,
-fade,25,Test 7,,2,,,orange,,,,,,,,,,,,
-network,29,Test 8,,3,,,green,,,,,,,,,,,,
-midi,33,Test 9,,1,,,blue,,,,,,,,,,,,
-midi file,37,Test 10,,2,,,purple,,,,,,,,,,,,
-timecode,41,Test 11,,3,,,red,,,,,,,,,,,,
-group,45,Test 12,,2,,,orange,,,,,,,,,,,,
-start,49,Test 13,,3,5,,green,,,,,,,,,,,,
-stop,53,Test 14,,1,5,,blue,,,,,,,,,,,,
-pause,57,Test 15,,2,5,,purple,,,,,,,,,,,,
-load,61,Test 16,,3,5,,red,,,,,,,,,,,,
-reset,65,Test 17,,2,5,,orange,,,,,,,,,,,,
-devamp,69,Test 18,,3,9,,green,,,,,,,,,,,,
-goto,73,Test 19,,1,5,,blue,,,,,,,,,,,,
-target,77,Test 20,,2,57,,purple,,,,,,,,,,,,
-arm,81,Test 21,,3,5,,red,,,,,,,,,,,,
-disarm,85,Test 22,,2,5,,orange,,,,,,,,,,,,
-wait,89,Test 23,,3,,,green,,,,,,,,,,,,
-memo,93,Test 24,,0,,,blue,,,,,,,,,,,,
-script,97,Test 25,,0,,,purple,,,,,,,,,,,,
-list,101,Test 26,,,,,red,,,,,,,,,,,,
-cuelist,105,Test 27,,,,,orange,,,,,,,,,,,,
-cue list,109,Test 28,,,,,green,,,,,,,,,,,,
-cart,113,Test 29,,,,,blue,,,,,,,,,,,,
-cue cart,117,Test 30,,,,,purple,,,,,,,,,,,,
-cue cart,121,Test 31,,,,,red,,,,,,,,,,,,
-midi,MT 1,Midi Test 1,Midi Test 1,,,,orange,2,1,1,12,,,,,50,50,,
-midi,MT 2,Midi Test 2,Midi Test 2,,,,green,2,16,2,10,10,10,,,25,20,,
-network,NW 1,Network Test 1,,,,,purple,,,,,,,,,,,1,/go
-network,NW 2,Network Test 2,,,,,purple,,,,,,,,,,,1,/go
+Type,Number,Name,Notes,continueMode,Target,File Target,Color,MIDI Message Type,Midi Command Format,Midi Command,Midi Device ID,Midi Control Number,Midi Control Value,Midi Patch Name,Midi Patch Number,Midi Q List,Midi Q Number,Network Patch Number,Custom String,Stop Target When Done,Stage Number
+audio,1,Test 1,,1,,,red,,,,,,,,,,,,,,
+mic,5,Test 2,,2,,,orange,,,,,,,,,,,,,,
+video,9,Test 3,,3,,app/static/example_file/broken_heart.png,green,,,,,,,,,,,,,,1
+camera,13,Test 4,,1,,,blue,,,,,,,,,,,,,,
+text,17,Test 5,,2,,,purple,,,,,,,,,,,,,,
+light,21,Test 6,,3,,,red,,,,,,,,,,,,,,
+fade,25,Test 7,,2,,,orange,,,,,,,,,,,,,true,
+network,29,Test 8,,3,,,green,,,,,,,,,,,,,,
+midi,33,Test 9,,1,,,blue,,,,,,,,,,,,,,
+midi file,37,Test 10,,2,,,purple,,,,,,,,,,,,,,
+timecode,41,Test 11,,3,,,red,,,,,,,,,,,,,,
+group,45,Test 12,,2,,,orange,,,,,,,,,,,,,,
+start,49,Test 13,,3,5,,green,,,,,,,,,,,,,,
+stop,53,Test 14,,1,5,,blue,,,,,,,,,,,,,,
+pause,57,Test 15,,2,5,,purple,,,,,,,,,,,,,,
+load,61,Test 16,,3,5,,red,,,,,,,,,,,,,,
+reset,65,Test 17,,2,5,,orange,,,,,,,,,,,,,,
+devamp,69,Test 18,,3,9,,green,,,,,,,,,,,,,,
+goto,73,Test 19,,1,5,,blue,,,,,,,,,,,,,,
+target,77,Test 20,,2,57,,purple,,,,,,,,,,,,,,
+arm,81,Test 21,,3,5,,red,,,,,,,,,,,,,,
+disarm,85,Test 22,,2,5,,orange,,,,,,,,,,,,,,
+wait,89,Test 23,,3,,,green,,,,,,,,,,,,,,
+memo,93,Test 24,,0,,,blue,,,,,,,,,,,,,,
+script,97,Test 25,,0,,,purple,,,,,,,,,,,,,,
+list,101,Test 26,,,,,red,,,,,,,,,,,,,,
+cuelist,105,Test 27,,,,,orange,,,,,,,,,,,,,,
+cue list,109,Test 28,,,,,green,,,,,,,,,,,,,,
+cart,113,Test 29,,,,,blue,,,,,,,,,,,,,,
+cue cart,117,Test 30,,,,,purple,,,,,,,,,,,,,,
+cue cart,121,Test 31,,,,,red,,,,,,,,,,,,,,
+midi,MT 1,Midi Test 1,Midi Test 1,,,,orange,2,1,1,12,,,,,50,50,,,,
+midi,MT 2,Midi Test 2,Midi Test 2,,,,green,2,16,2,10,10,10,,,25,20,,,,
+network,NW 1,Network Test 1,,,,,purple,,,,,,,,,,,1,/go,,
+network,NW 2,Network Test 2,,,,,purple,,,,,,,,,,,1,/go,,

app/templates/errors.html

@@ -53,7 +53,7 @@
         Need help? <a style="color: #f276a0;" href="https://csv-to-qlab.finlayross.me/" target="_blank">Documentation
           and Tutorials Page</a>
       </p>
-      <p class="text-muted">Version: 2023.2</p>
+      <p class="text-muted">Version: 2023.4</p>
     </div>
   </footer>
 </body>

app/templates/index.html

@@ -86,7 +86,7 @@
         Need help? <a style="color: #f276a0;" href="https://csv-to-qlab.finlayross.me/" target="_blank">Documentation
           and Tutorials Page</a>
       </p>
-      <p class="text-muted">Version: 2023.3</p>
+      <p class="text-muted">Version: 2023.4</p>
     </div>
   </footer>
 </body>

app/templates/success.html

@@ -60,7 +60,7 @@ <h4 class="alert alert-success" role="alert">You had <strong>{{ successfull_comm
         Need help? <a style="color: #f276a0;" href="https://csv-to-qlab.finlayross.me/" target="_blank">Documentation
           and Tutorials Page</a>
       </p>
-      <p class="text-muted">Version: 2023.2</p>
+      <p class="text-muted">Version: 2023.4</p>
     </div>
   </footer>
 </body>

website/docs/advanced/install-from-source.md

@@ -42,7 +42,7 @@ Navigate to the csv_to_qlab directory.
 cd csv_to_qlab
 ```
 
-Create the virtual environment.
+Create a virtual environment.
 ```bash
 python3 -m venv env
 ```
@@ -70,8 +70,12 @@ python3 -m pip install --upgrade pip
 python3 -m pip install -r requirements.txt
 ```
 
+## Step 5: Navigate to the application directory
+```bash
+cd app
+```
 
-## Step 5: Start the application
+## Step 6: Start the application
 ```bash
 python3 application.py
 ```

website/docs/tutorial-basics/prepare-csv-file.md

@@ -20,6 +20,7 @@ Some of these headers changed with version [2023.2](/releases/2023/2)! Please ch
 | 12 | start | Cue 12 GO |
 
 ## Optional Columns
+
 <ul>
     <li>Notes</li>
     <li>Follow</li>
@@ -35,6 +36,21 @@ Some of these headers changed with version [2023.2](/releases/2023/2)! Please ch
     <ul>
         <li>Text</li>
     </ul>
+    <li>Columns availible for "fade" cue type:</li>
+    <ul>
+        <li>Stop Target When Done (true or false)</li>
+    </ul>
+    <li>Columns availible for "video" cue type:</li>
+    <ul>
+        <li>Stage Number (In order of list in video outputs setting)</li>
+    </ul>
+</ul>
+
+:::note
+Stages are in QLab 5 only.
+:::
+
+<ul>
     <li>Columns available for "midi" cue type:</li>
     <ul>
         <li>MIDI Q Number</li>

website/releases/2023-12-18-v2023.4.mdx

@@ -0,0 +1,30 @@
+---
+slug: 2023/4
+title: Version 2023.4
+tags: ["2023", "4"]
+---
+
+import Link from '@docusaurus/Link';
+import useBaseUrl from '@docusaurus/useBaseUrl';
+import styles from '@site/src/pages/index.module.css';
+
+
+Bug Fixes:
+- Fixed an error with setting "File Path" header.
+
+New Features:
+- "Stop Target When Done" for fade cues. Either true or false.
+- "Video Stage" number.
+    - If number is given, set the video stage of the specified cue to that stage. If number is 0, un-patch the specified cue. If number is greater than the number of video stages in the workspace, this message has no effect. number must be a whole number.
+
+Known Issues:
+- Non-standard colors appear to not be accpeted by qlab as of this latest release. This seems to be an issue with QLab not with csv-to-qlab.
+
+
+<div className={styles.buttons}>
+    <Link
+    className="button button--primary button--lg"
+    to="https://github.com/fross123/csv_to_qlab/releases/download/v2023.4/CSV-To-QLab.dmg">
+    Download Release v2023.4
+    </Link>
+</div>