@kuriousdesign/machine-sdk 1.0.0 → 1.0.2

package/src/enums/ExtrusionType.ts

@@ -0,0 +1,5 @@
+export enum ExtrusionType {
+  //FORMATTING CUSTOMERNAME_PARTNO, please use all caps
+  ARMY_1703429 = 1,
+  ARMY_1801183 = 2,
+}

package/src/enums/OpcuaDatatype.ts

@@ -0,0 +1,28 @@
+export enum OpcuaDatatype {
+  Null = 0,
+  Boolean = 1,
+  SByte = 2,
+  Byte = 3,
+  Int16 = 4,
+  UInt16 = 5,
+  Int32 = 6,
+  UInt32 = 7,
+  Int64 = 8,
+  UInt64 = 9,
+  Float = 10,
+  Double = 11,
+  String = 12,
+  DateTime = 13,
+  Guid = 14,
+  ByteString = 15,
+  XmlElement = 16,
+  NodeId = 17,
+  ExpandedNodeId = 18,
+  StatusCode = 19,
+  QualifiedName = 20,
+  LocalizedText = 21,
+  ExtensionObject = 22,
+  DataValue = 23,
+  Variant = 24,
+  DiagnosticInfo = 25
+}

package/src/enums/Pages.ts

@@ -0,0 +1,21 @@
+export enum Page {
+  UNCONTROLLED = 0,
+  LOGIN = 1,
+  OPERATION = 2,
+  HOME = 3,
+  SETTINGS = 4,
+
+  RAW_SHELF = 5,
+  EDIT_RAW_SHELF = 6,
+  DONE_SHELF = 7,
+  EDIT_DONE_SHELF = 8,
+
+  RECIPES = 9,
+  EDIT_RECIPES = 10,
+  CHANGE_RECIPE = 11,
+  JOB_SETUP = 13,
+
+  ERRORS = 14,
+  WARNINGS = 15,
+  ROBOT = 16,
+}

package/src/enums/Priorities.ts

@@ -0,0 +1,21 @@
+export enum Priority {
+  //TopPriorities must be ordered from most important (priority = 1) to least important
+  NoPriority = 0, //no priorites were detected
+  StartCnc = 1, //priority to start cnc (get robot out of cnc, close door and start that thing)
+  DropoffMachinedParts = 2, //Dropoff machined parts in the post op (do this after cnc machining and before cnc loading)
+  LoadCnc = 3, //Top priority to load the deburred parts into the cnc
+  FinishPostOp = 4, //Top prioroity to finish parts after the cnc op
+  UnloadCnc = 5, //Top priority to remove machined parts from cnc
+  PrepParts = 6, //Top priority to get two parts deburred into the preop deadnest
+  WaitToUnload = 7,
+  CloseCncDoor = 8,
+
+  //FillRobotWithTwoDeburredParts=11, //sub priority to loading cnc, robot needs to fill both grippers with deburred parts
+  DeburrPart = 20, //sub priorty to loading cnc and robot needs deburred parts
+  PickRawShelf = 21, //sub priority to pick raw shelf
+  PickRawPartFromPreOp = 22, //sub priority to pick raw shelf
+  LoadPreOpWithDeburred = 23,
+  GatherDeburredPartsForCncLoad = 24, //Top priority to grab deburred parts and get in ready position to load cnc (do this before cnc loading)
+  WashParts = 31,
+  RejectScrap = 91, //priority to pick and reject a scrap part
+}

package/src/enums/RobPositions.ts

@@ -0,0 +1,12 @@
+export enum RobPositions {
+  AnyPosition = -1, //used when configuring tasks, this is used for start position id for pure moves
+  Lost = 0,
+  Home = 1,
+  WashPerch = 2,
+  RackPerch = 3, //used for shelf picking and reject
+  DeadNestPerch = 4, //used for preop and postop tasks
+  CncPerch = 5, //standby position outside of cnc door with wrist rotated so parts are horizontal
+  DeburrPerch = 6,
+  CncWaypoint = 7,
+  CncHover = 8,
+}

package/src/enums/States.ts

@@ -0,0 +1,59 @@
+export enum VisibilityState {
+  Invisible = 0,
+  Visible = 1,
+  FlashingFast = 2,
+  FlashingMed = 3,
+  FlashingSlow = 4,
+  StrobingFast = 5,
+  StrobingSlow = 6,
+  GrowingSlow = 7,
+}
+
+export enum DeviceState {
+  Faulted = -2,
+  Killed = -1,
+  Inactive = 0,
+  Resetting = 50,
+  Idle = 100,
+  Running = 500,
+  Stopping = 900,
+  Aborting = 911,
+  Paused = 999,
+  Done = 1000,
+  Manual = 2000,
+}
+
+export enum PartState {
+  Empty = 0, //no part present
+  Raw = 10,
+  DeburrBottomStarted = 11,
+  DeburrBottomFinished = 12,
+  DeburrTopStarted = 15,
+  Deburred = 20, //completely deburred, both bottom and top
+  MachiningStarted = 45,
+  Machined = 50,
+  WashStarted = 55,
+  Washed = 60,
+  DryStarted = 65,
+  Dryed = 70,
+  Finished = 100,
+  Scrapped = 911,
+  Error = 999,
+}
+
+export enum TaskItemState {
+  TaskDone = 48,
+  TaskActive = 49,
+  TaskFuture = 50,
+}
+
+export enum StatusMsg {
+  Running = 0,
+  Faulted = 2,
+}
+
+export enum BannerMode {
+  Good = 0,
+  Warning = 1,
+  Faulted = 2,
+}

package/src/enums/TaskId.ts

@@ -0,0 +1,37 @@
+export enum TaskId {
+  NoTask = 0,
+  WayPointMove = 1, //use endPositionId as the destination to communicate to robot, all other parameters are useless.
+  PickRawShelf_R = 2, //pick raw shelf with Right Gripper, left gripper must be empty
+  DeburrBottom_R = 3, //Right Gripper Side Only, params(top/bottom/both
+  DeburrTop_R = 4, //Right Gripper Side Only, params(top/bottom/both
+  LoadPreOp2_L = 5, //rarely used (only be used if robot were ready to load cnc but had to abandon that to go wash parts or something like that), position 2 on pre op is on the right, left gripper must be empty
+  LoadPreOp2_R = 6, //position 2 on pre op is on the right, left gripper must be empty
+  LoadPreOp1_R = 7, //position 1 on pre op is on the left
+  PickPreOp1_R = 8, //position 1 on pre op is on the left
+  PickPreOp2_L = 9, //position 2 on pre op is on the right
+  LoadCnc2_L = 10,
+  LoadCnc1_R = 11,
+  PickCnc1_R = 12,
+  PickCnc2_L = 13,
+  LoadPostOp2_L = 14,
+  LoadPostOp1_R = 15,
+  PickPostOp1_R = 16,
+  PickPostOp2_L = 17,
+  PickPostOp2_R = 18, //left gripper must be empty
+  WashAndDry = 19,
+  LoadDoneShelf_R = 20, //uses a PLC PR offset for done shelf user frame
+  RejectPart_L = 21, //start and end at rack perch
+  RejectPart_R = 22, //start and end at rack perch
+  WaitToUnload = 23, //MARTIN WE WILL USE WayPointMove FOR THIS,
+  WaitToLoad = 24, //MARTIN WE WILL USE WayPointMove FOR THIS, wait in front of cnc with deburred parts in both robot gripppers, only used when cnc is empty and waiting to be filled, REPLACE WITH WAYPOINT MOVE?
+  ExitCnc = 25, //MARTIN WE WILL USE WayPointMove FOR THIS, move from cnc hover position to cnc perch position, REPLACE WITH WAYPOINT MOVE?
+  EnterCnc = 26, //MARTIN WE WILL USE WayPointMove FOR THIS, move to cnc hover position, MARTIN WE WILL USE WayPointMove FOR THIS
+
+  //non-robot tasks
+  ChangeCncProgram = 27,
+  StartCnc = 28,
+  StopCnc = 29,
+  ResetCnc = 30,
+  OpenCncDoor = 31,
+  CloseCncDoor = 32,
+}

package/src/enums/Warnings.ts

@@ -0,0 +1,20 @@
+import { DeviceId } from "./DeviceId";
+
+export const WarningsMap: {
+  [key in DeviceId]: {
+    [key: number]: string;
+  };
+} = {
+  [DeviceId.SYS]: {
+    //refer to SysWarnings enum in CoDeSys for mapping
+  },
+  [DeviceId.RACK]: {
+    //refer to RackWarnings enum in CoDeSys for mapping
+  },
+  [DeviceId.CNC]: {},
+  [DeviceId.CON]: {},
+  [DeviceId.DBRR]: {},
+  [DeviceId.ROB]: {},
+  [DeviceId.SFTY]: {},
+  [DeviceId.WASH]: {},
+};

package/src/enums/index.ts

@@ -0,0 +1,11 @@
+export * from "./Colors";
+export * from "./States";
+export * from "./OpcuaDatatype";
+export * from "./ExtrusionType";
+export * from "./Warnings";
+export * from "./Errors";
+export * from "./DeviceId";
+export * from "./TaskId";
+export * from "./Priorities";
+export * from "./Pages";
+export * from "./RobPositions";

package/src/functions/colorMapping.ts

@@ -0,0 +1,42 @@
+import { Color } from "../enums/Colors";
+import { DeviceState, PartState } from "../enums/States";
+
+export function deviceStateToColorMap(state: DeviceState): Color {
+  const colorMap: { [key in DeviceState]: Color } = {
+    [DeviceState.Killed]: Color.Black,
+    [DeviceState.Inactive]: Color.Inactive,
+    [DeviceState.Resetting]: Color.Resetting,
+    [DeviceState.Idle]: Color.Idle,
+    [DeviceState.Running]: Color.Running,
+    [DeviceState.Stopping]: Color.Processing,
+    [DeviceState.Done]: Color.Done,
+    [DeviceState.Aborting]: Color.Error,
+    [DeviceState.Manual]: Color.Manual,
+    [DeviceState.Paused]: Color.Processing,
+    [DeviceState.Faulted]: Color.Error,
+  };
+
+  return colorMap[state];
+}
+
+export function partStateToColorMap(state: PartState): Color {
+  const colorMap: { [key in PartState]: Color } = {
+    [PartState.Empty]: Color.Empty,
+    [PartState.Raw]: Color.Raw,
+    [PartState.DeburrBottomStarted]: Color.Processing,
+    [PartState.DeburrBottomFinished]: Color.DeburrBottomFinished,
+    [PartState.DeburrTopStarted]: Color.Processing,
+    [PartState.Deburred]: Color.Deburred,
+    [PartState.MachiningStarted]: Color.Processing,
+    [PartState.Machined]: Color.Machined,
+    [PartState.WashStarted]: Color.Processing,
+    [PartState.Washed]: Color.Processing,
+    [PartState.DryStarted]: Color.Processing,
+    [PartState.Dryed]: Color.Dryed,
+    [PartState.Finished]: Color.Finished,
+    [PartState.Scrapped]: Color.Scrapped,
+    [PartState.Error]: Color.Error,
+  };
+
+  return colorMap[state];
+}

package/src/functions/index.ts

@@ -0,0 +1,2 @@
+export * from "./colorMapping";
+export * from "./topicMapping";

package/src/functions/topicMapping.ts

@@ -0,0 +1,6 @@
+export function machineIdToTopicMap(id: string): string {
+  const topicMap: { [key in string]: string } = {
+    "BendPro G2 Demo": "BendProG2/2286/198C/#",
+  };
+  return topicMap[id];
+}

package/src/index.ts

@@ -1,34 +1,4 @@
-// Data Types
-export interface Machine {
-  id: string;
-  name: string;
-  status: 'idle' | 'running' | 'stopped' | 'error';
-  lastUpdated: Date;
-}
-
-export interface SensorData {
-  machineId: string;
-  temperature: number;
-  pressure: number;
-  timestamp: Date;
-}
-
-// Helper Functions
-export function formatTimestamp(timestamp: Date): string {
-  return timestamp.toISOString();
-}
-
-export function isMachineActive(machine: Machine): boolean {
-  return machine.status === 'running';
-}
-
-export function calculateAverageTemperature(data: SensorData[]): number {
-  if (data.length === 0) return 0;
-  const total = data.reduce((sum, reading) => sum + reading.temperature, 0);
-  return Number((total / data.length).toFixed(2));
-}
-
-export function validateMachineId(id: string): boolean {
-  const idRegex = /^[A-Za-z0-9-_]{1,36}$/;
-  return idRegex.test(id);
-}
+export * from "./custom-types";
+export * from "./enums";
+export * from "./functions";
+export * from "./plc-tags";

package/src/plc-tags/index.ts

@@ -0,0 +1,24 @@
+export const PlcNamespaces = {
+    Machine: 'Machine',
+    MachineHw: 'MachineHw',
+    Main: 'Main'
+}
+
+export const MachineTags = {
+    deviceStore: 'Devices',
+    //deviceTypeStore: 'DeviceTypes',
+    registeredDevices: 'RegisteredDevices',
+    axisStsArray: 'AxisStsArray',
+    HeartbeatPLC: 'HeartbeatPLC',
+    HeartbeatHMI: 'HeartbeatHMI'
+}
+
+export const DeviceTags = {
+    Cfg: 'Cfg',
+    Is: 'Is',
+    Registration: 'Registration',
+}
+
+
+export * from "./opcua";
+export * from "./mqtt";

package/src/plc-tags/mqtt.ts

@@ -0,0 +1,8 @@
+export interface TopicData {
+    timestamp: number;
+    payload: unknown; // Placeholder until cfg, status, data schemas provided
+}
+
+export const MqttTopics = {
+    BRIDGE_STATUS: 'bridge/status',
+} as const;

package/src/plc-tags/opcua.ts

@@ -0,0 +1,3 @@
+export const nodeListString = "ns=4;s=|var|";
+export const nodeTypeString = "ns=4;s=|type|";
+