merge main

Author: tannermpeterson

CHANGELOG.rst

@@ -8,9 +8,10 @@ Changelog for Stingray Controller
 Added:
 ^^^^^^
 - Handling for new firmware error reporting
+- Stim waiting state to add spinner to stim start/stop button
 
 
-0.3.0 (unreleased)
+0.3.0 (2023-07-11)
 ------------------
 
 Added:
@@ -26,8 +27,8 @@ Fixed:
 ^^^^^^
 - Error message for when:
 
-    - The instrument's firmware is incompatible with the software
-    - An error occurs during software install
+  - The instrument's firmware is incompatible with the software
+  - An error occurs during software install
 
 
 0.2.0 (2023-06-05)

controller/poetry.lock

@@ -15,10 +15,11 @@ httpx = "0.24.1"
 aioserial = "1.3.1"
 Cython = "0.29.34"
 immutabledict = "2.2.3"
+jsonschema = "4.17.3"  # Tanner (7/7/23): pinning this to avoid issues with pyinstaller. Can probably remove this dependency entirely once labware-domain-models is removed
 labware-domain-models = "0.3.1"
 numpy = "1.23.5"  # pinned for pulse3d
 # psutil = "5.9.4"
-pulse3d = "0.33.5"
+pulse3d = "0.33.10"
 pyserial = "3.5"
 semver = "2.13.0"
 stdlib-utils = "0.5.2"
@@ -33,7 +34,7 @@ aioconsole = "0.6.0"
 freezegun = "1.2.2"
 # pefile = "2023.2.7" # Tanner (2/24/23): this must be explicitly specified so that it will be included in a Windows build environment
 pre-commit = "3.1.1"
-pyinstaller = "5.8.0"
+pyinstaller = "5.13.0"
 pytest = "7.2.1"
 pytest-asyncio = "0.20.3"
 pytest-cov = "4.0.0"
@@ -42,7 +43,6 @@ pytest-profiling = "1.7.0"
 pytest-randomly = "3.12.0"
 pytest-timeout = "2.1.0"
 # pywin32-ctypes = "0.2.0" # Tanner (2/24/23): this must be explicitly specified so that it will be included in a Windows build environment
-requests = "2.28.2"
 
 [build-system]
 requires = ["poetry-core", "setuptools", "Cython", "numpy"]

controller/pyproject.toml

@@ -260,7 +260,11 @@ export default {
     },
     stimStatus: function (newStatus) {
       // only let stim messages through if system is in idle ready state
-      if (this.statusUuid === SYSTEM_STATUS.IDLE_READY) this.setStimSpecificStatus(newStatus);
+      if (this.statusUuid === SYSTEM_STATUS.IDLE_READY) {
+        if (newStatus === STIM_STATUS.WAITING) newStatus = this.stimPlayState ? "Stopping..." : "Starting...";
+
+        this.setStimSpecificStatus(newStatus);
+      }
     },
     confirmationRequest: async function () {
       const stimOpsInProgress =

ui/components/status/StatusBar.vue

@@ -25,19 +25,19 @@
           </svg>
           <span :class="svg__StimulationStudioControlsPlayStopButton__dynamicClass" @click="handlePlayStop">
             <div
-              v-if="!playState"
-              id="start-stim-button"
-              v-b-popover.hover.top="startStimLabel"
-              title="Start Stimulation"
+              v-b-popover.hover.bottom="playState ? stopStimLabel : startStimLabel"
+              :title="playState ? 'Stop Stimulation' : 'Start Stimulation'"
             >
-              <!-- this is here for testing the popover message -->
-              <span id="start-popover-msg" style="display: none">{{ startStimLabel }}</span>
-              <FontAwesomeIcon class="fontawesome-icon-class" :icon="['fa', 'play-circle']" />
-            </div>
-            <div v-if="playState" v-b-popover.hover.bottom="stopStimLabel" title="Stop Stimulation">
-              <!-- this is here for testing the popover message -->
-              <span id="stop-popover-msg" style="display: none">{{ stopStimLabel }}</span>
-              <FontAwesomeIcon class="fontawesome-icon-class" :icon="['fa', 'stop-circle']" />
+              <span :id="playState ? 'stop-popover-msg' : 'start-popover-msg'" style="display: none">{{
+                playState ? stopStimLabel : startStimLabel
+              }}</span>
+              <FontAwesomeIcon
+                class="fontawesome-icon-class"
+                :icon="playState ? ['fa', 'stop-circle'] : ['fa', 'play-circle']"
+              />
+              <span v-show="isStimInWaiting" class="span__start-stop-spinner">
+                <FontAwesomeIcon :style="'fill: #ececed;'" :icon="['fa', 'spinner']" pulse />
+              </span>
             </div>
           </span>
         </div>
@@ -96,7 +96,7 @@
             <line class="svg__inner-line" x1="34.8" y1="17.28" x2="21.16" y2="30.91" />
             <line class="svg__inner-line" x1="58.73" y1="30.87" x2="50.48" y2="30.87" />
           </svg>
-          <span v-show="configCheckInProgress" class="span__spinner">
+          <span v-show="configCheckInProgress" class="span__config-check-spinner">
             <FontAwesomeIcon :style="'fill: #ececed;'" :icon="['fa', 'spinner']" pulse />
           </span>
         </div>
@@ -274,7 +274,12 @@ export default {
         opacity: this.disabled ? 0.5 : 1,
       };
     },
+    isStimInWaiting: function () {
+      return this.stimStatus === STIM_STATUS.WAITING;
+    },
     isStartStopButtonEnabled: function () {
+      if (this.isStimInWaiting) return false;
+
       if (!this.playState) {
         // if starting stim make sure initial magnetometer calibration has been completed and
         // no additional calibrations are running, stim checks have completed, there are no short or
@@ -396,6 +401,8 @@ export default {
     async handlePlayStop(e) {
       e.preventDefault();
       if (this.isStartStopButtonEnabled) {
+        this.$store.commit("stimulation/setStimStatus", STIM_STATUS.WAITING);
+
         if (this.playState) {
           this.$store.dispatch(`stimulation/stopStimulation`);
           clearTimeout(this.stim24hrTimer); // clear 24 hour timer for next stimulation
@@ -490,7 +497,7 @@ body {
   grid-template-columns: repeat(25%, 4);
   align-items: center;
   justify-items: center;
-  padding: 5px;
+  padding: 2px;
 }
 
 .span__stimulation-controls-play-stop-button--disabled {
@@ -571,11 +578,11 @@ body {
   width: 20px;
 }
 
-.span__spinner {
+.span__config-check-spinner {
   position: absolute;
   font-size: 34px;
-  right: 17.5px;
-  bottom: 15px;
+  left: 5px;
+  top: 0px;
   width: 45px;
   color: #fff;
   padding-left: 5px;
@@ -640,6 +647,17 @@ body {
   fill: none;
 }
 
+.span__start-stop-spinner {
+  position: absolute;
+  font-size: 20px;
+  right: 2px;
+  bottom: 3px;
+  color: #fff;
+  padding-left: 5px;
+  background-color: #000;
+  opacity: 0.75;
+}
+
 #user-input-prompt-message,
 #open-circuit-warning,
 #stim-24hr-warning,

ui/components/stimulation/StimulationStudioControls.vue

@@ -80,10 +80,13 @@ export default {
     };
   },
   computed: {
-    ...mapState("stimulation", ["protocolList", "editMode"]),
+    ...mapState("stimulation", ["protocolList", "editMode", "selectedWells"]),
     editModeStatus: function () {
       return this.editMode.status;
     },
+    noWellsSelected: function () {
+      return this.selectedWells.length === 0;
+    },
   },
   watch: {
     protocolList: function (newList, oldList) {
@@ -113,7 +116,11 @@ export default {
       this.$emit("handle-selection-change", selectedProtocol);
     },
     disableSelectionBtn(idx) {
-      return this.disableEdits || (this.selectedProtocolIdx === 0 && idx === 0);
+      return (
+        this.disableEdits ||
+        (this.selectedProtocolIdx === 0 && idx === 0) ||
+        (this.noWellsSelected && idx === 0)
+      );
     },
     handleClick(idx) {
       if (this.disableSelectionBtn(idx)) {

ui/components/stimulation/StimulationStudioCreateAndEdit.vue

@@ -9,6 +9,8 @@ export const STIM_STATUS = {
   READY: "Ready",
   // stim play states
   STIM_ACTIVE: "Stimulating...",
+  // used to show spinner in stim controls over play/stop button
+  WAITING: "",
 
   // error
   SHORT_CIRCUIT_ERROR: "Short Circuit Error",