@wandelbots/wandelbots-js-react-components 2.54.5 → 3.0.0

package/src/lib/MotionStreamConnection.ts

@@ -0,0 +1,186 @@
+import { AutoReconnectingWebsocket, tryParseJson } from "@wandelbots/nova-js"
+import type {
+  MotionGroupDescription,
+  MotionGroupState,
+  NovaClient,
+  RobotControllerState,
+} from "@wandelbots/nova-js/v2"
+import { makeAutoObservable, runInAction } from "mobx"
+import type { Vector3Simple } from "./JoggerConnection"
+import {
+  jointValuesEqual,
+  tcpMotionEqual,
+  unwrapRotationVector,
+} from "./motionStateUpdate"
+
+const MOTION_DELTA_THRESHOLD = 0.0001
+
+/**
+ * Store representing the current state of a connected motion group.
+ */
+export class MotionStreamConnection {
+  static async open(nova: NovaClient, motionGroupId: string) {
+    const [_motionGroupIndex, controllerId] = motionGroupId.split("@") as [
+      string,
+      string,
+    ]
+
+    const controller =
+      await nova.api.controller.getCurrentRobotControllerState(controllerId)
+    const motionGroup = controller?.motion_groups.find(
+      (mg) => mg.motion_group === motionGroupId,
+    )
+    if (!controller || !motionGroup) {
+      throw new Error(
+        `Controller ${controllerId} or motion group ${motionGroupId} not found`,
+      )
+    }
+
+    const motionStateSocket = nova.openReconnectingWebsocket(
+      `/controllers/${controllerId}/motion-groups/${motionGroupId}/state-stream`,
+    )
+
+    // Wait for the first message to get the initial state
+    const firstMessage = await motionStateSocket.firstMessage()
+    const initialMotionState = tryParseJson(firstMessage.data)
+      ?.result as MotionGroupState
+
+    if (!initialMotionState) {
+      throw new Error(
+        `Unable to parse initial motion state message ${firstMessage.data}`,
+      )
+    }
+
+    console.log(
+      `Connected motion state websocket to motion group ${motionGroup.motion_group}. Initial state:\n  `,
+      initialMotionState,
+    )
+
+    // Get the motion group description for later usage in jogging
+    const description = await nova.api.motionGroup.getMotionGroupDescription(
+      controllerId,
+      motionGroup.motion_group,
+    )
+
+    return new MotionStreamConnection(
+      nova,
+      controller,
+      motionGroup,
+      description,
+      initialMotionState,
+      motionStateSocket,
+    )
+  }
+
+  // Not mobx-observable as this changes very fast; should be observed
+  // using animation frames
+  rapidlyChangingMotionState: MotionGroupState
+
+  constructor(
+    readonly nova: NovaClient,
+    readonly controller: RobotControllerState,
+    readonly motionGroup: MotionGroupState,
+    readonly description: MotionGroupDescription,
+    readonly initialMotionState: MotionGroupState,
+    readonly motionStateSocket: AutoReconnectingWebsocket,
+  ) {
+    this.rapidlyChangingMotionState = initialMotionState
+
+    motionStateSocket.addEventListener("message", (event) => {
+      const latestMotionState = tryParseJson(event.data)?.result as
+        | MotionGroupState
+        | undefined
+
+      if (!latestMotionState) {
+        throw new Error(
+          `Failed to get motion state for ${this.motionGroupId}: ${event.data}`,
+        )
+      }
+
+      // handle joint position changes
+      if (
+        !jointValuesEqual(
+          this.rapidlyChangingMotionState.joint_position,
+          latestMotionState.joint_position,
+          MOTION_DELTA_THRESHOLD,
+        )
+      ) {
+        runInAction(() => {
+          this.rapidlyChangingMotionState.joint_position =
+            latestMotionState.joint_position
+        })
+      }
+
+      // handle tcp pose changes
+      if (
+        !tcpMotionEqual(
+          this.rapidlyChangingMotionState,
+          latestMotionState,
+          MOTION_DELTA_THRESHOLD,
+        )
+      ) {
+        runInAction(() => {
+          if (this.rapidlyChangingMotionState.tcp_pose == null) {
+            this.rapidlyChangingMotionState.tcp_pose =
+              latestMotionState.tcp_pose
+          } else if (
+            latestMotionState.tcp_pose?.orientation &&
+            latestMotionState.tcp_pose?.position &&
+            this.rapidlyChangingMotionState.tcp_pose?.orientation
+          ) {
+            this.rapidlyChangingMotionState.tcp_pose = {
+              position: latestMotionState.tcp_pose.position,
+              orientation: unwrapRotationVector(
+                latestMotionState.tcp_pose.orientation as Vector3Simple,
+                this.rapidlyChangingMotionState.tcp_pose
+                  .orientation as Vector3Simple,
+              ),
+            }
+          } else {
+            console.warn(
+              "Received incomplete tcp_pose, ignoring",
+              latestMotionState.tcp_pose,
+            )
+          }
+        })
+      }
+
+      // handle standstill changes
+      if (
+        this.rapidlyChangingMotionState.standstill !==
+        latestMotionState.standstill
+      ) {
+        runInAction(() => {
+          this.rapidlyChangingMotionState.standstill =
+            latestMotionState.standstill
+        })
+      }
+    })
+    makeAutoObservable(this)
+  }
+
+  get motionGroupId() {
+    return this.motionGroup.motion_group
+  }
+
+  get controllerId() {
+    return this.controller.controller
+  }
+
+  get wandelscriptIdentifier() {
+    const num = this.motionGroupId.split("@")[0]
+    return `${this.controllerId.replace(/-/g, "_")}_${num}`
+  }
+
+  get joints() {
+    return this.initialMotionState.joint_position.map((_, i) => {
+      return {
+        index: i,
+      }
+    })
+  }
+
+  dispose() {
+    this.motionStateSocket.close()
+  }
+}

package/src/lib/motionStateUpdate.test.ts

@@ -0,0 +1,28 @@
+import { describe, expect, test } from "vitest"
+import { poseEqual } from "./motionStateUpdate"
+
+describe("poseEqual", async () => {
+  test("returns true for identical poses", () => {
+    const pose1 = {
+      position: [0, 0, 0],
+      orientation: [0, 0, 0],
+    }
+    const pose2 = {
+      position: [0, 0, 0],
+      orientation: [0, 0, 0],
+    }
+    expect(poseEqual(pose1, pose2, 0.001)).toBe(true)
+  })
+
+  test("returns false for different poses", () => {
+    const pose1 = {
+      position: [0, 0, 0],
+      orientation: [0, 0, 0],
+    }
+    const pose2 = {
+      position: [1, 1, 1],
+      orientation: [1, 1, 1],
+    }
+    expect(poseEqual(pose1, pose2, 0.001)).toBe(false)
+  })
+})

package/src/lib/motionStateUpdate.ts

@@ -0,0 +1,117 @@
+import type { MotionGroupState, Pose } from "@wandelbots/nova-js/v2"
+import type { Vector3Simple } from "./JoggerConnection"
+import { Vector3 } from "three"
+
+export function jointValuesEqual(
+  oldJointValues: number[],
+  newJointValues: number[],
+  changeDeltaThreshold: number,
+): boolean {
+  if (newJointValues.length !== oldJointValues.length) {
+    return true
+  }
+
+  for (let jointIndex = 0; jointIndex < newJointValues.length; jointIndex++) {
+    if (
+      // biome-ignore lint/style/noNonNullAssertion: legacy code
+      Math.abs(newJointValues[jointIndex]! - oldJointValues[jointIndex]!) >
+      changeDeltaThreshold
+    ) {
+      return false
+    }
+  }
+
+  return true
+}
+
+export function poseEqual(
+  oldTcp: Pose | undefined,
+  newTcp: Pose | undefined,
+  changeDeltaThreshold: number,
+): boolean {
+  // undefined -> defined (+reverse) transition
+  if ((oldTcp === undefined && newTcp) || (oldTcp && newTcp === undefined)) {
+    return false
+  }
+
+  // Poses might be incomplete (missing orientation or position)
+  if (
+    oldTcp?.orientation === undefined ||
+    newTcp?.orientation === undefined ||
+    oldTcp?.position === undefined ||
+    newTcp?.position === undefined
+  ) {
+    return false
+  }
+
+  // the typechecker cannot resolve states to "!= undefined" if "&&" is used
+  if (oldTcp === undefined || newTcp === undefined) {
+    return true
+  }
+
+  let changedDelta = 0
+  changedDelta += Math.abs(oldTcp.orientation[0] - newTcp.orientation[0])
+  changedDelta += Math.abs(oldTcp.orientation[1] - newTcp.orientation[1])
+  changedDelta += Math.abs(oldTcp.orientation[2] - newTcp.orientation[2])
+  changedDelta += Math.abs(oldTcp.position[0] - newTcp.position[0])
+  changedDelta += Math.abs(oldTcp.position[1] - newTcp.position[1])
+  changedDelta += Math.abs(oldTcp.position[2] - newTcp.position[2])
+
+  return changedDelta <= changeDeltaThreshold
+}
+
+// Runs poseEqual check + coordinate system/tcp name equality
+export function tcpMotionEqual(
+  oldMotionState: MotionGroupState,
+  newMotionState: MotionGroupState,
+  changeDeltaThreshold: number,
+): boolean {
+  return (
+    oldMotionState.coordinate_system === newMotionState.coordinate_system &&
+    oldMotionState.tcp === newMotionState.tcp &&
+    poseEqual(
+      oldMotionState.tcp_pose,
+      newMotionState.tcp_pose,
+      changeDeltaThreshold,
+    )
+  )
+}
+
+export function unwrapRotationVector(
+  newRotationVectorApi: Vector3Simple,
+  currentRotationVectorApi: Vector3Simple,
+): Vector3Simple {
+  const currentRotationVector = new Vector3(
+    currentRotationVectorApi[0],
+    currentRotationVectorApi[1],
+    currentRotationVectorApi[2],
+  )
+
+  const newRotationVector = new Vector3(
+    newRotationVectorApi[0],
+    newRotationVectorApi[1],
+    newRotationVectorApi[2],
+  )
+
+  const currentAngle = currentRotationVector.length()
+  const currentAxis = currentRotationVector.normalize()
+
+  let newAngle = newRotationVector.length()
+  let newAxis = newRotationVector.normalize()
+
+  // Align rotation axes
+  if (newAxis.dot(currentAxis) < 0) {
+    newAngle = -newAngle
+    newAxis = newAxis.multiplyScalar(-1.0)
+  }
+
+  // Shift rotation angle close to previous one to extend domain of rotation angles beyond [0, pi]
+  // - this simplifies interpolation and prevents abruptly changing signs of the rotation angles
+  let angleDifference = newAngle - currentAngle
+  angleDifference -=
+    2.0 * Math.PI * Math.floor((angleDifference + Math.PI) / (2.0 * Math.PI))
+
+  newAngle = currentAngle + angleDifference
+
+  return [...newAxis.multiplyScalar(newAngle)] as Vector3Simple
+}