Merge pull request #74 from DiamondLightSource/72-update-blueapi

Update UI to use newer blueapi and update PVs

Author: adaudon

src/blueapi/BlueapiComponents.tsx

@@ -5,10 +5,11 @@ import {
   Button,
   Snackbar,
   SnackbarCloseReason,
-  styled,
   Tooltip,
   Typography,
 } from "@mui/material";
+import { forceString, ReadPvRawValue } from "../pv/util";
+import { RawValue } from "../pv/types";
 
 type SeverityLevel = "success" | "info" | "warning" | "error";
 type VariantChoice = "outlined" | "contained";
@@ -36,27 +37,77 @@ type RunPlanButtonProps = {
 // This will be another PR
 // See https://github.com/DiamondLightSource/mx-daq-ui/issues/71
 
+/**
+ * Read the full visit path from the visit PV set by the beamline staff.
+ * @returns {string} the full visit pV /dls/i24/data/{year}/{visit}
+ */
+function readVisitFromPv(): string {
+  const fullVisitPath: RawValue = ReadPvRawValue({
+    label: "visit",
+    pv: "ca://BL24I-MO-IOC-13:GP100",
+  });
+  const visitString: string = forceString(fullVisitPath);
+  return visitString;
+}
+
+/**
+ * Parse the full visit path and return only the instrument session.
+ * An error will be raised if the instrument session value is undefined or
+ * if the PV is not connected.
+ * @param {string} visit The full visit path
+ * @returns {string} Only the instrument session part of the visit path
+ */
+function parseInstrumentSession(visit: string): string {
+  let instrumentSession: string | undefined;
+  if (visit === "not connected" || visit === "undefined") {
+    const msg =
+      "Unable to run plan as instrument session not set. Please check visit PV.";
+    throw new Error(msg);
+  } else {
+    instrumentSession = visit.split("/").filter(Boolean).at(-1);
+    if (!instrumentSession) {
+      throw new Error(
+        "Unable to run plan as something appears to be wrong with visit path"
+      );
+    }
+  }
+  return instrumentSession;
+}
+
 export function RunPlanButton(props: RunPlanButtonProps) {
   const [openSnackbar, setOpenSnackbar] = React.useState<boolean>(false);
   const [msg, setMsg] = React.useState<string>("Running plan...");
   const [severity, setSeverity] = React.useState<SeverityLevel>("info");
 
+  const fullVisit = readVisitFromPv();
+  let instrumentSession: string;
+
   const params = props.planParams ? props.planParams : {};
   const variant = props.btnVariant ? props.btnVariant : "outlined";
   const size = props.btnSize ? props.btnSize : "medium";
 
   const handleClick = () => {
     setOpenSnackbar(true);
-    submitAndRunPlanImmediately({
-      planName: props.planName,
-      planParams: params,
-    }).catch((error) => {
+    try {
+      instrumentSession = parseInstrumentSession(fullVisit);
+      submitAndRunPlanImmediately({
+        planName: props.planName,
+        planParams: params,
+        instrumentSession: instrumentSession,
+      }).catch((error) => {
+        setSeverity("error");
+        setMsg(
+          `Failed to run plan ${props.planName}, see console and logs for full error`
+        );
+        console.log(`${msg}. Reason: ${error}`);
+      });
+    } catch (error) {
       setSeverity("error");
       setMsg(
-        `Failed to run plan ${props.planName}, see console and logs for full error`
+        `Failed to run plan ${props.planName}, please check visit PV is set.`
       );
-      console.log(`${msg}. Reason: ${error}`);
-    });
+      console.log(`An error occurred ${error}`);
+    }
   };
 
   const handleSnackbarClose = (

src/blueapi/blueapi.ts

@@ -5,7 +5,7 @@ const BLUEAPI_SOCKET: string = import.meta.env.VITE_BLUEAPI_SOCKET;
 type BlueApiRequestBody = {
   planName: string;
   planParams: object;
-  // instrumentSession: string;
+  instrumentSession: string;
 };
 // Update to latest blueapi (> 1.0.0), See https://github.com/DiamondLightSource/mx-daq-ui/issues/72
 // @todo check if blueapi request still works if planParams optional (since some times there's none)

src/pv/util.ts

@@ -59,7 +59,7 @@ export function pvIntArrayToString(value: RawValue): string {
   }
 }
 
-function ReadPvRawValue(props: PvDescription): RawValue {
+export function ReadPvRawValue(props: PvDescription): RawValue {
   const [_effectivePvName, connected, _readonly, latestValue] = useConnection(
     props.label,
     props.pv

src/screens/BeamlineStats.tsx

@@ -85,12 +85,12 @@ function ScanStatus(props: Omit<StateBoxProps, "children">) {
     >
       <PvComponent
         label="Scan Status"
-        pv="ca://BL24I-MO-STEP-14:signal:P2401"
+        pv="ca://BL24I-MO-STEP-14:pmac:read:P2401"
         transformValue={forceString}
       />
       <PvComponent
         label="Frames Counter"
-        pv="ca://BL24I-MO-STEP-14:signal:P2402"
+        pv="ca://BL24I-MO-STEP-14:pmac:read:P2402"
         transformValue={forceString}
       />
     </StateCard>

src/screens/CollectionPanel.tsx

@@ -24,12 +24,12 @@ function FixedInputs() {
     <Grid2 size={12}>
       <PvComponent
         label="Visit"
-        pv="ca://ME14E-MO-IOC-01:GP100"
+        pv="ca://BL24I-MO-IOC-13:GP100"
         transformValue={forceString}
       />
       <PvComponent
         label="Detector in use"
-        pv="ca://ME14E-MO-IOC-01:GP101"
+        pv="ca://BL24I-MO-IOC-13:GP101"
         transformValue={forceString}
       />
     </Grid2>

src/screens/DetectorMotion.tsx

@@ -18,7 +18,7 @@ export function DetectorMotionTabPanel() {
   return (
     <Box>
       <Stack spacing={2} alignItems={"center"}>
-        <RoPvBox label="Selected detector" pv="ca://ME14E-MO-IOC-01:GP101" />
+        <RoPvBox label="Selected detector" pv="ca://BL24I-MO-IOC-13:GP101" />
         <RoPvBox
           label="Detector stage y position"
           pv="ca://BL24I-EA-DET-01:Y"