Merge pull request #108 from ISISComputingGroup/beam_current_wall_display

Add beam current to wall display

Author: rerpha

app/components/InstrumentsDisplay.tsx

@@ -4,6 +4,7 @@ import {
   IfcInstrumentStatus,
   IfcPVWSMessage,
   IfcPVWSRequest,
+  PVWSRequestType,
   targetStation,
 } from "@/app/types";
 import useWebSocket from "react-use-websocket";
@@ -12,6 +13,7 @@ import { instListFromBytes } from "@/app/components/dehex_and_decompress";
 import {
   updateInstrumentRunstate,
   updateInstrumentRunstatePV,
+  updateTargetStationBeamCurrent,
 } from "@/app/wall/utils";
 import TargetStation from "@/app/components/TargetStation";
 import ScienceGroup from "@/app/components/ScienceGroup";
@@ -49,9 +51,13 @@ export default function InstrumentsDisplay({
 }) {
   const runstatePV = "DAE:RUNSTATE_STR";
 
+  const ts1BeamCurrentPv = "AC:TS1:BEAM:CURR";
+  const ts2BeamCurrentPv = "AC:TS2:BEAM:CURR";
+
   const [data, setData] = useState<Array<targetStation>>([
     {
       targetStation: "Target Station 1",
+      beamCurrentPv: ts1BeamCurrentPv,
       instruments: [
         { name: "ALF" },
         { name: "ARGUS" },
@@ -86,6 +92,7 @@ export default function InstrumentsDisplay({
     },
     {
       targetStation: "Target Station 2",
+      beamCurrentPv: ts2BeamCurrentPv,
       instruments: [
         { name: "CHIPIR" },
         { name: "IMAT" },
@@ -149,6 +156,10 @@ export default function InstrumentsDisplay({
   useEffect(() => {
     // On page load, subscribe to the instrument list as it's required to get each instrument's PV prefix.
     sendJsonMessage(instListSubscription);
+    sendJsonMessage({
+      type: PVWSRequestType.subscribe,
+      pvs: [ts1BeamCurrentPv, ts2BeamCurrentPv],
+    });
   }, [sendJsonMessage]);
 
   useEffect(() => {
@@ -161,6 +172,7 @@ export default function InstrumentsDisplay({
     const updatedPVName: string = updatedPV.pv;
     const updatedPVbytes: string | null | undefined = updatedPV.b64byt;
     let updatedPVvalue: string | null | undefined = updatedPV.text;
+    let updatedPVnum: number | null | undefined = updatedPV.value;
 
     if (updatedPVName == instListPV && updatedPVbytes != null) {
       const instListDict = instListFromBytes(updatedPVbytes);
@@ -174,6 +186,17 @@ export default function InstrumentsDisplay({
           );
         });
       }
+    } else if (
+      updatedPVName == ts1BeamCurrentPv ||
+      updatedPVName == ts2BeamCurrentPv
+    ) {
+      setData((prev) => {
+        return updateTargetStationBeamCurrent(
+          prev,
+          updatedPVName,
+          updatedPVnum,
+        );
+      });
     } else if (updatedPVvalue) {
       setData((prev) => {
         return updateInstrumentRunstate(prev, updatedPVName, updatedPVvalue);
@@ -198,6 +221,7 @@ export default function InstrumentsDisplay({
               key={targetStation.targetStation}
               name={targetStation.targetStation}
               instruments={targetStation.instruments}
+              beamCurrent={targetStation.beamCurrent}
             />
           );
         })}

app/components/JenkinsJobs.tsx

@@ -41,7 +41,6 @@ export default function JenkinsJobs() {
       const jobs: Array<IfcWallDisplayJob> = resData["jobs"].filter(
         (job) => job["color"] != "disabled",
       );
-      console.log(jobs);
       setData(jobs);
     }
     fetchPosts();

app/components/TargetStation.test.tsx

@@ -5,6 +5,7 @@ it("renders targetstation unchanged", () => {
   const { container } = render(
     <TargetStation
       name={"TS5"}
+      beamCurrent={1234.5678}
       instruments={[
         { name: "Instrument", runstate: "RESUMING" },
         {

app/components/TargetStation.tsx

@@ -5,14 +5,19 @@ import { IfcInstrumentStatus } from "@/app/types";
 export default function TargetStation({
   name,
   instruments,
+  beamCurrent,
 }: {
   name: string;
   instruments: Array<IfcInstrumentStatus>;
+  beamCurrent: number | null | undefined;
 }) {
   return (
     <div className="flex flex-col justify-center items-start w-full">
       <h1 className="w-full text-left text-gray-600 dark:text-gray-200 font-semibold text-md mt-2 py-2 ">
-        {name}
+        {name}{" "}
+        {beamCurrent !== undefined && beamCurrent !== null
+          ? "- " + beamCurrent.toFixed(2) + " μA"
+          : ""}
       </h1>
       <div className="flex flex-wrap gap-1">
         {instruments.map((instrument) => (

app/components/__snapshots__/TargetStation.test.tsx.snap

@@ -9,6 +9,8 @@ exports[`renders targetstation unchanged 1`] = `
       class="w-full text-left text-gray-600 dark:text-gray-200 font-semibold text-md mt-2 py-2 "
     >
       TS5
+       
+      - 1234.57 μA
     </h1>
     <div
       class="flex flex-wrap gap-1"

app/types.ts

@@ -149,6 +149,8 @@ export interface ConfigOutputIocMacro {
 
 export interface targetStation {
   targetStation: string;
+  beamCurrentPv?: string;
+  beamCurrent?: number | null;
   instruments: Array<IfcInstrumentStatus>;
 }
 

app/wall/utils.test.ts

@@ -1,6 +1,7 @@
 import {
   updateInstrumentRunstate,
   updateInstrumentRunstatePV,
+  updateTargetStationBeamCurrent,
 } from "@/app/wall/utils";
 import { IfcInstrumentStatus, instListEntry, targetStation } from "@/app/types";
 
@@ -21,6 +22,22 @@ test("updateInstrumentRunstate returns new array with runstate of instrument cha
       .instruments[0].runstate,
   ).toBe(expectedValue);
 });
+
+test("updateTargetStationBeamCurrent returns new array with beam current of target station changed", () => {
+  const beamCurrPv = "AC:TS123:BEAM:CURR";
+  const original: targetStation = {
+    targetStation: "Target station 123",
+    beamCurrentPv: beamCurrPv,
+    beamCurrent: 0.0,
+    instruments: [],
+  };
+  const expectedValue = 3.14159265358979;
+  expect(
+    updateTargetStationBeamCurrent([original], beamCurrPv, expectedValue)[0]
+      .beamCurrent,
+  ).toBe(expectedValue);
+});
+
 test("updateInstrumentRunstate returns untouched array if runstate PV is not found", () => {
   const runStatePV = "AN:INST:DAE:RUNSTATE";
   const instrument: IfcInstrumentStatus = {

app/wall/utils.ts

@@ -26,6 +26,26 @@ export function updateInstrumentRunstate(
   return newData;
 }
 
+/**
+ * Copy the original array, update the given target stations' beam current value, then return the copied array.
+ * @param prev the previous array of target stations, containing instruments.
+ * @param updatedPVName the runstate PV address
+ * @param updatedPVvalue the runstate
+ */
+export function updateTargetStationBeamCurrent(
+  prev: Array<targetStation>,
+  updatedPVName: string,
+  updatedPVvalue: number | null | undefined,
+) {
+  const newData: Array<targetStation> = [...prev];
+
+  const foundTs = newData.find((ts) => ts.beamCurrentPv === updatedPVName);
+  if (foundTs) {
+    foundTs.beamCurrent = updatedPVvalue;
+  }
+  return newData;
+}
+
 /**
  * Copy an original array then update an instrument's runstate PV, then subscribe to it. return the copied array.
  * @param prev the original array of target stations containing instrument runstate information