@opalkelly/frontpanel-react-components 0.3.0 → 0.5.0

package/src/components/FrontPanelToggleSwitch/FrontPanelToggleSwitch.tsx

@@ -7,7 +7,7 @@
 
 import React from "react";
 
-import { IFrontPanel, WireValue } from "@opalkelly/frontpanel-alloy-core";
+import { IFPGADataPortClassic, WireValue } from "@opalkelly/frontpanel-platform-api";
 
 import { ToggleState } from "../../core";
 
@@ -51,14 +51,14 @@ const FrontPanelToggleSwitch = React.forwardRef<
 >((props, forwardedRef) => {
     const [state, setState] = React.useState<ToggleState>(ToggleState.Off);
 
-    const { device, workQueue } = React.useContext(FrontPanelContext);
+    const { fpgaDataPort, workQueue } = React.useContext(FrontPanelContext);
 
     const { fpEndpoint, disabled, ...buttonProps } = props;
 
     const targetWireBitMask = 1 << fpEndpoint.bitOffset;
 
     const onUpdateWireValue = React.useCallback(
-        (sender?: IFrontPanel): void => {
+        (sender?: IFPGADataPortClassic): void => {
             if ((sender != null) && (workQueue != null)) {
                 // Set the toggle state based on the value of the target bit of the Wire endpoint
                 const sourceWireValue = sender.getWireInValue(fpEndpoint.epAddress);
@@ -74,31 +74,31 @@ const FrontPanelToggleSwitch = React.forwardRef<
 
     const onToggleStateChanged = React.useCallback(
         async (state: ToggleState): Promise<void> => {
-            if ((device != null) && (workQueue != null)) {
+            if ((fpgaDataPort != null) && (workQueue != null)) {
                 await workQueue.post(async () => {
                     // Set the value of the target bit of the Wire endpoint based on the toggle state
                     const targetWireValue: WireValue = state === ToggleState.On ? 0xffffffff : 0;
 
-                    device.setWireInValue(fpEndpoint.epAddress, targetWireValue, targetWireBitMask);
+                    fpgaDataPort.setWireInValue(fpEndpoint.epAddress, targetWireValue, targetWireBitMask);
 
-                    await device.updateWireIns();
+                    await fpgaDataPort.updateWireIns();
                 });
             }
 
-            onUpdateWireValue(device);
+            onUpdateWireValue(fpgaDataPort);
         },
-        [device, workQueue, fpEndpoint, targetWireBitMask]
+        [fpgaDataPort, workQueue, fpEndpoint, targetWireBitMask]
     );
 
     React.useEffect(() => {
-        onUpdateWireValue(device);
-    }, [device, onUpdateWireValue]);
+        onUpdateWireValue(fpgaDataPort);
+    }, [fpgaDataPort, onUpdateWireValue]);
 
     return (
         <ToggleSwitch
             ref={forwardedRef}
             {...buttonProps}
-            disabled={disabled || (device == null)}
+            disabled={disabled || (fpgaDataPort == null)}
             state={state}
             onToggleStateChanged={onToggleStateChanged}
         />

package/src/components/FrontPanelTriggerButton/FrontPanelTriggerButton.tsx

@@ -47,23 +47,23 @@ const FrontPanelTriggerButton = React.forwardRef<
     FrontPanelTriggerButtonElement,
     FrontPanelTriggerButtonCombinedProps
 >((props, forwardedRef) => {
-    const { device, workQueue } = React.useContext(FrontPanelContext);
+    const { fpgaDataPort, workQueue } = React.useContext(FrontPanelContext);
 
     const { fpEndpoint, disabled, ...buttonProps } = props;
 
     const onButtonDown = React.useCallback(async (): Promise<void> => {
-        if ((device != null) && (workQueue != null)) {
+        if ((fpgaDataPort != null) && (workQueue != null)) {
             await workQueue.post(async () => {
-                await device.activateTriggerIn(fpEndpoint.epAddress, fpEndpoint.bitOffset);
+                await fpgaDataPort.activateTriggerIn(fpEndpoint.epAddress, fpEndpoint.bitOffset);
             });
         }
-    }, [device, workQueue, fpEndpoint]);
+    }, [fpgaDataPort, workQueue, fpEndpoint]);
 
     return (
         <Button
             {...buttonProps}
             ref={forwardedRef}
-            disabled={disabled || (device == null)}
+            disabled={disabled || (fpgaDataPort == null)}
             onButtonDown={onButtonDown}
         />
     );

package/src/components/types.ts

@@ -5,7 +5,7 @@
  * See the LICENSE file found in the root directory of this project.
  */
 
-import { BitCount } from "@opalkelly/frontpanel-alloy-core";
+import { BitCount } from "@opalkelly/frontpanel-platform-api";
 
 export interface EndpointAddressProps {
     epAddress: number;

package/src/contexts/FrontPanelContext.ts

@@ -8,15 +8,15 @@
 import React from "react";
 
 import {
-    IFrontPanel,
-    IFrontPanelEventSource,
+    IFPGADataPortClassic,
+    IFPGADataPortClassicEventSource,
     WorkQueue
-} from "@opalkelly/frontpanel-alloy-core";
+} from "@opalkelly/frontpanel-platform-api";
 
 export type FrontPanelContextValue = {
-    device?: IFrontPanel;
+    fpgaDataPort?: IFPGADataPortClassic;
     workQueue?: WorkQueue;
-    eventSource?: IFrontPanelEventSource;
+    eventSource?: IFPGADataPortClassicEventSource;
 };
 
 const FrontPanelContext = React.createContext<FrontPanelContextValue>({});

package/src/stories/decorators/FrontPanel.decorator.tsx

@@ -11,26 +11,28 @@ import type { Decorator } from "@storybook/react";
 
 import { FrontPanel } from "../../components";
 
-import { MockFrontPanel, ByteCount } from "@opalkelly/frontpanel-alloy-core";
+import { MockFrontPanel, ByteCount, WorkQueue } from "@opalkelly/frontpanel-platform-api";
 
-const mockDevice: MockFrontPanel = new MockFrontPanel(32, 32);
+const mockFPGADataPort: MockFrontPanel = new MockFrontPanel(32, 32);
+
+const deviceWorkQueue: WorkQueue = new WorkQueue();
 
 const InitializeMockDevice = () => {
     // Initialize the WireOuts with unique values.
-    const wireOutBlock = mockDevice.WireOutBlock;
+    const wireOutBlock = mockFPGADataPort.WireOutBlock;
 
     let byteId: ByteCount = 0;
 
-    for (let elementIndex = 0; elementIndex < wireOutBlock.Count; elementIndex++) {
+    for (let elementIndex = 0; elementIndex < wireOutBlock.count; elementIndex++) {
         let elementValue: number = byteId++;
         for (let byteIndex = 1; byteIndex < 4; byteIndex++) {
             elementValue |= byteId++ << (8 * byteIndex);
         }
 
-        wireOutBlock.SetValue(
-            wireOutBlock.BaseAddress + elementIndex,
+        wireOutBlock.setValue(
+            wireOutBlock.baseAddress + elementIndex,
             elementValue,
-            wireOutBlock.Mask
+            wireOutBlock.mask
         );
     }
 };
@@ -38,7 +40,7 @@ const InitializeMockDevice = () => {
 const withFrontPanel: Decorator = (Story) => {
     InitializeMockDevice();
     return (
-        <FrontPanel device={mockDevice}>
+        <FrontPanel fpgaDataPort={mockFPGADataPort} workQueue={deviceWorkQueue}>
             <Story />
         </FrontPanel>
     );