@kuriousdesign/machine-sdk 1.0.6 → 1.0.8

package/README.md

@@ -1,7 +1,17 @@
-@kuriousdesign/machine-sdk
+# npm install @kuriousdesign/machine-sdk
 A shared SDK for data types and helper functions used in machine-related repositories.
-Installation
-npm install @kuriousdesign/machine-sdk
+
+# Publishing to npm
+first, commit you git changes
+npm login (if not already)
+npm version patch   # 1.0.0 → 1.0.1
+npm version minor   # 1.0.0 → 1.1.0
+npm version major   # 1.0.0 → 2.0.0
+npm publish
+
+
+# Installation
+npm install @kuriousdesign/machine-sdk@latest
 
 Usage
 import { Machine, formatTimestamp, isMachineActive } from '@kuriousdesign/machine-sdk';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kuriousdesign/machine-sdk",
-  "version": "1.0.6",
+  "version": "1.0.8",
   "description": "Shared data types and helpers for machine-related repositories",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

package/src/custom-types/Bridge.ts

@@ -0,0 +1,9 @@
+export enum BridgeCmds {
+    NONE = 1,
+    CONNECT = 2,
+    DISCONNECT = 3
+}
+
+export interface BridgeData {
+    connectedClients: number[];
+}

package/src/custom-types/Devices/Device.ts

@@ -1,12 +1,61 @@
 import { DeviceTypes } from './DeviceTypes'
 
+export const DeviceConstants = {
+  DEVICE_CHILDREN_ARRAY_LEN: 10,
+  DEVICE_FAULTCODEARRAY_LEN: 10, //this value should be greater than equal to children array len
+  MAX_NUM_PARAMS: 10, //used for tasks and processes
+  NUM_ACTION_TYPES: 6, //this includes NONE
+  NUM_LOG_ENTRIES: 50,
+  MAX_NUM_OUTBOUND_AXIS_INTERLOCKS: 10,
+  UNIT_TEST_PROCESS_ID: 1100,
+  TIME_MS_AUTOCLEAR_DONE_BIT_TASK_OR_PROCESS: 250
+};
+
+export interface DebugLogData {
+  Msg: string;
+  TimeStamp: Date;
+  Id: number;
+}
+
+export const initialDebugLogData: DebugLogData = {
+  Msg: '',
+  TimeStamp: new Date(),
+  Id: 0
+};
+
+
+export interface DeviceLogData {
+  List: DebugLogData[];
+  LastIndex: number; // index of the most recent recorded entries
+}
+
+export const initialDeviceLogData: DeviceLogData = {
+  List: new Array(DeviceConstants.NUM_LOG_ENTRIES).fill(null),
+  LastIndex: 0
+};
+
+
 export interface DeviceRegistration {
   mnemonic: string; // short hand notation for the device, e.g. IB for Bufferwall, IBG for gantry
   id: number; // this device id
   childIdArray: number[]; // array of child device ids
   parentId: number; // this is the parent id
   deviceType: DeviceTypes; // type of the device
-}
+};
+
+export interface DeviceActionRequestData {
+  SenderId: number;
+  ActionType: number; // ActionTypes enum
+  ActionId: number; // could be cmd, task or processId
+  ParamArray: number[]; // Array of LREAL values
+};
+
+export const initialDeviceActionRequestData: DeviceActionRequestData = {
+  SenderId: 0,
+  ActionType: 0,
+  ActionId: 0,
+  ParamArray: new Array(DeviceConstants.MAX_NUM_PARAMS).fill(0)
+};
 
 export const initialDeviceRegistration: DeviceRegistration = {
   mnemonic: '',
@@ -136,6 +185,16 @@ export const initialDeviceStatus: DeviceStatus = {
   recordingLogs: false
 };
 
+export enum ActionTypes {
+  MISSION = 0,
+  CMD = 1,
+  TASK = 2,
+  PROCESS = 3,
+  EXEC_METHOD = 4,
+  SCRIPT = 5,
+  COUNT = 6 // Update this value to match the number of action types
+}
+
 export interface Device {
   is: DeviceStatus;
   errors: DeviceFaultData;

package/src/custom-types/Devices/DeviceTypes.ts

@@ -3,5 +3,31 @@ export enum DeviceTypes {
     Axis = 1,
     BoschAxis = 2, //need to deprecate this soon
     DualAxis = 3,
-    Gantry = 4
+    Gantry = 4,
+    Bridge = 5, //used for communication
+    Machine = 6,
+    Robot = 7,
+}
+
+export function deviceTypeToString(deviceType: DeviceTypes): string {
+    switch (deviceType) {
+        case DeviceTypes.Base:
+            return 'Base';
+        case DeviceTypes.Axis:
+            return 'Axis';
+        case DeviceTypes.BoschAxis:
+            return 'Bosch Axis';
+        case DeviceTypes.DualAxis:
+            return 'Dual Axis';
+        case DeviceTypes.Gantry:
+            return 'Gantry';
+        case DeviceTypes.Bridge:
+            return 'Bridge';
+        case DeviceTypes.Machine:
+            return 'Machine';
+        case DeviceTypes.Robot:
+            return 'Robot';
+        default:
+            return 'Unknown';
+    }
 }

package/src/custom-types/index.ts

@@ -11,3 +11,4 @@ export * from "./UserManagerFB";
 export * from "./TaskQueue";
 export * from "./RobData";
 export * from "./Devices";
+export * from "./Bridge";

package/src/enums/States.ts

@@ -7,20 +7,133 @@ export enum VisibilityState {
   StrobingFast = 5,
   StrobingSlow = 6,
   GrowingSlow = 7,
+};
+
+export enum States {
+  ABORTING = -3,
+  ERROR = -2,
+  KILLED = -1,
+  INACTIVE = 0,
+  RESETTING = 50,
+  IDLE = 100,
+  RUNNING = 500,
+  STOPPING = 900,
+  PAUSED = 999,
+  DONE = 1000,
+  MANUAL = 1100,
+  UNKNOWN = 9999,
+};
+
+export function convertStateToString(state: States) {
+    switch (state) {
+        case States.ABORTING:
+            return "ABORTING";
+        case States.ERROR:
+            return "ERROR";
+        case States.KILLED:
+            return "KILLED";
+        case States.INACTIVE:
+            return "INACTIVE";
+        case States.RESETTING:
+            return "RESETTING";
+        case States.IDLE:
+            return "IDLE";
+        case States.RUNNING:
+            return "RUNNING";
+        case States.STOPPING:
+            return "STOPPING";
+        case States.PAUSED:
+            return "PAUSED";
+        case States.DONE:
+            return "DONE";
+        case States.MANUAL:
+            return "MANUAL";
+        case States.UNKNOWN:
+            return "UNKNOWN";
+        default:
+            return "UNKNOWN";
+    }
+}
+
+export function convertStateToColor(state: States) {
+
+    switch (state) {
+        case States.ABORTING:
+            return "text-darkred-500";
+        case States.ERROR:
+            return "text-red-500";
+        case States.KILLED:
+            return "text-gray-500";
+        case States.INACTIVE:
+            return "text-white";
+        case States.RESETTING:
+            return "text-lightblue-500";
+        case States.IDLE:
+            return "text-blue-500";
+        case States.RUNNING:
+            return "text-green-500";
+        case States.STOPPING:
+            return "text-orange-500";
+        case States.MANUAL:
+            return "text-purple-500";
+        case States.UNKNOWN:
+            return "text-pink-500";
+    }
 }
 
-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 function getStateFromStep(step:number): States {
+    let state = States.UNKNOWN;
+    switch (step) {
+        case States.ABORTING:
+            state = States.ABORTING;
+            break;
+        case States.ERROR:
+            state = States.ERROR;
+            break;
+        case States.KILLED:
+            state = States.KILLED;
+            break;
+        case States.INACTIVE:
+            state = States.INACTIVE;
+            break;
+        case States.RESETTING:
+            state = States.RESETTING;
+            break;
+        case States.IDLE:
+            state = States.IDLE;
+            break;
+        case States.RUNNING:
+            state = States.RUNNING;
+            break;
+        case States.STOPPING:
+            state = States.STOPPING;
+            break;
+        case States.PAUSED:
+            state = States.PAUSED;
+            break;
+        case States.DONE:
+            state = States.DONE;
+            break;
+        case States.MANUAL:
+            state = States.MANUAL;
+            break;
+        case States.UNKNOWN:
+            state = States.UNKNOWN;
+            break;
+    }
+
+    if(state === States.UNKNOWN){
+        if (state >= States.RESETTING && state < States.IDLE) {
+            state = States.RESETTING;
+        } else if (state > States.IDLE && state < States.STOPPING) {
+            state = States.RUNNING;
+        } else if (state >= States.STOPPING && state < States.PAUSED) {
+            state = States.STOPPING;
+        } else if (state >= States.MANUAL && state < States.UNKNOWN) {
+            state = States.MANUAL;
+        }
+    }
+    return state;
 }
 
 export enum PartState {

package/src/plc-tags/mqtt.ts

@@ -7,10 +7,4 @@ export const MqttTopics = {
     BRIDGE_STATUS: 'bridge/status',
     BRIDGE_CMD: 'bridge/cmd',
     DEVICE_MAP: 'deviceMap',
-} as const;
-
-
-export const BridgeCmds = {
-    CONNECT: 'connect',
-    DISCONNECT: 'disconnect'
 } as const;