@kuriousdesign/machine-sdk 1.0.10 → 1.0.11

package/dist/custom-types/Bridge.d.ts

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

package/dist/custom-types/Bridge.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BridgeCmds = void 0;
+var BridgeCmds;
+(function (BridgeCmds) {
+    BridgeCmds[BridgeCmds["NONE"] = 1] = "NONE";
+    BridgeCmds[BridgeCmds["CONNECT"] = 2] = "CONNECT";
+    BridgeCmds[BridgeCmds["DISCONNECT"] = 3] = "DISCONNECT";
+})(BridgeCmds || (exports.BridgeCmds = BridgeCmds = {}));

package/dist/custom-types/Devices/Device.d.ts

@@ -1,4 +1,25 @@
 import { DeviceTypes } from './DeviceTypes';
+export declare const DeviceConstants: {
+    DEVICE_CHILDREN_ARRAY_LEN: number;
+    DEVICE_FAULTCODEARRAY_LEN: number;
+    MAX_NUM_PARAMS: number;
+    NUM_ACTION_TYPES: number;
+    NUM_LOG_ENTRIES: number;
+    MAX_NUM_OUTBOUND_AXIS_INTERLOCKS: number;
+    UNIT_TEST_PROCESS_ID: number;
+    TIME_MS_AUTOCLEAR_DONE_BIT_TASK_OR_PROCESS: number;
+};
+export interface DebugLogData {
+    Msg: string;
+    TimeStamp: Date;
+    Id: number;
+}
+export declare const initialDebugLogData: DebugLogData;
+export interface DeviceLogData {
+    List: DebugLogData[];
+    LastIndex: number;
+}
+export declare const initialDeviceLogData: DeviceLogData;
 export interface DeviceRegistration {
     mnemonic: string;
     id: number;
@@ -6,6 +27,13 @@ export interface DeviceRegistration {
     parentId: number;
     deviceType: DeviceTypes;
 }
+export interface DeviceActionRequestData {
+    SenderId: number;
+    ActionType: number;
+    ActionId: number;
+    ParamArray: number[];
+}
+export declare const initialDeviceActionRequestData: DeviceActionRequestData;
 export declare const initialDeviceRegistration: DeviceRegistration;
 export interface DeviceCfg {
     safetyZoneId: number;
@@ -63,6 +91,15 @@ export interface DeviceStatus {
     recordingLogs: boolean;
 }
 export declare const initialDeviceStatus: DeviceStatus;
+export declare enum ActionTypes {
+    MISSION = 0,
+    CMD = 1,
+    TASK = 2,
+    PROCESS = 3,
+    EXEC_METHOD = 4,
+    SCRIPT = 5,
+    COUNT = 6
+}
 export interface Device {
     is: DeviceStatus;
     errors: DeviceFaultData;

package/dist/custom-types/Devices/Device.js

@@ -1,7 +1,34 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.initialDevice = exports.initialDeviceStatus = exports.initialDeviceFaultData = exports.initialFaultData = exports.initialDeviceCfg = exports.initialDeviceRegistration = void 0;
+exports.initialDevice = exports.ActionTypes = exports.initialDeviceStatus = exports.initialDeviceFaultData = exports.initialFaultData = exports.initialDeviceCfg = exports.initialDeviceRegistration = exports.initialDeviceActionRequestData = exports.initialDeviceLogData = exports.initialDebugLogData = exports.DeviceConstants = void 0;
 const DeviceTypes_1 = require("./DeviceTypes");
+exports.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
+};
+exports.initialDebugLogData = {
+    Msg: '',
+    TimeStamp: new Date(),
+    Id: 0
+};
+exports.initialDeviceLogData = {
+    List: new Array(exports.DeviceConstants.NUM_LOG_ENTRIES).fill(null),
+    LastIndex: 0
+};
+;
+;
+exports.initialDeviceActionRequestData = {
+    SenderId: 0,
+    ActionType: 0,
+    ActionId: 0,
+    ParamArray: new Array(exports.DeviceConstants.MAX_NUM_PARAMS).fill(0)
+};
 exports.initialDeviceRegistration = {
     mnemonic: '',
     id: 0,
@@ -61,6 +88,16 @@ exports.initialDeviceStatus = {
     commanderId: 0,
     recordingLogs: false
 };
+var ActionTypes;
+(function (ActionTypes) {
+    ActionTypes[ActionTypes["MISSION"] = 0] = "MISSION";
+    ActionTypes[ActionTypes["CMD"] = 1] = "CMD";
+    ActionTypes[ActionTypes["TASK"] = 2] = "TASK";
+    ActionTypes[ActionTypes["PROCESS"] = 3] = "PROCESS";
+    ActionTypes[ActionTypes["EXEC_METHOD"] = 4] = "EXEC_METHOD";
+    ActionTypes[ActionTypes["SCRIPT"] = 5] = "SCRIPT";
+    ActionTypes[ActionTypes["COUNT"] = 6] = "COUNT"; // Update this value to match the number of action types
+})(ActionTypes || (exports.ActionTypes = ActionTypes = {}));
 exports.initialDevice = {
     is: exports.initialDeviceStatus,
     errors: exports.initialDeviceFaultData,

package/dist/custom-types/Devices/deviceTypes.d.ts

@@ -3,5 +3,9 @@ export declare 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 declare function deviceTypeToString(deviceType: DeviceTypes): string;

package/dist/custom-types/Devices/deviceTypes.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.DeviceTypes = void 0;
+exports.deviceTypeToString = deviceTypeToString;
 var DeviceTypes;
 (function (DeviceTypes) {
     DeviceTypes[DeviceTypes["Base"] = 0] = "Base";
@@ -8,4 +9,31 @@ var DeviceTypes;
     DeviceTypes[DeviceTypes["BoschAxis"] = 2] = "BoschAxis";
     DeviceTypes[DeviceTypes["DualAxis"] = 3] = "DualAxis";
     DeviceTypes[DeviceTypes["Gantry"] = 4] = "Gantry";
+    DeviceTypes[DeviceTypes["Bridge"] = 5] = "Bridge";
+    DeviceTypes[DeviceTypes["Machine"] = 6] = "Machine";
+    DeviceTypes[DeviceTypes["Robot"] = 7] = "Robot";
 })(DeviceTypes || (exports.DeviceTypes = DeviceTypes = {}));
+;
+function deviceTypeToString(deviceType) {
+    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/dist/custom-types/Devices/index.d.ts

@@ -1,2 +1,3 @@
-export * from "./Device";
 export * from "./Axis";
+export * from "./Device";
+export * from "./DeviceTypes";

package/dist/custom-types/Devices/index.js

@@ -14,5 +14,6 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./Device"), exports);
 __exportStar(require("./Axis"), exports);
+__exportStar(require("./Device"), exports);
+__exportStar(require("./DeviceTypes"), exports);

package/dist/custom-types/HMI.d.ts

@@ -1,5 +1,5 @@
 import { FaultCodeData } from "./Machine";
-import { BannerMode, Color, DeviceState, VisibilityState } from "..";
+import { BannerMode, Color, States, VisibilityState } from "..";
 export interface ComponentAnimation {
     visibility: VisibilityState;
     needsExpertUser: boolean;
@@ -22,7 +22,7 @@ export interface ButtonBar {
 }
 export interface StatusBar {
     jobName: string;
-    statusMsg: DeviceState;
+    statusMsg: States;
     status: number;
     cncTimeLeft: number[];
     goodCnt: number;

package/dist/custom-types/index.d.ts

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

package/dist/custom-types/index.js

@@ -27,3 +27,4 @@ __exportStar(require("./UserManagerFB"), exports);
 __exportStar(require("./TaskQueue"), exports);
 __exportStar(require("./RobData"), exports);
 __exportStar(require("./Devices"), exports);
+__exportStar(require("./Bridge"), exports);

package/dist/enums/States.d.ts

@@ -8,19 +8,23 @@ export declare enum VisibilityState {
     StrobingSlow = 6,
     GrowingSlow = 7
 }
-export declare 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 declare 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 declare function convertStateToString(state: States): "ABORTING" | "ERROR" | "KILLED" | "INACTIVE" | "RESETTING" | "IDLE" | "RUNNING" | "STOPPING" | "PAUSED" | "DONE" | "MANUAL" | "UNKNOWN";
+export declare function convertStateToColor(state: States): "text-darkred-500" | "text-red-500" | "text-gray-500" | "text-white" | "text-lightblue-500" | "text-blue-500" | "text-green-500" | "text-orange-500" | "text-purple-500" | "text-pink-500" | undefined;
+export declare function getStateFromStep(step: number): States;
 export declare enum PartState {
     Empty = 0,//no part present
     Raw = 10,

package/dist/enums/States.js

@@ -1,6 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.BannerMode = exports.StatusMsg = exports.TaskItemState = exports.PartState = exports.DeviceState = exports.VisibilityState = void 0;
+exports.BannerMode = exports.StatusMsg = exports.TaskItemState = exports.PartState = exports.States = exports.VisibilityState = void 0;
+exports.convertStateToString = convertStateToString;
+exports.convertStateToColor = convertStateToColor;
+exports.getStateFromStep = getStateFromStep;
 var VisibilityState;
 (function (VisibilityState) {
     VisibilityState[VisibilityState["Invisible"] = 0] = "Invisible";
@@ -12,20 +15,133 @@ var VisibilityState;
     VisibilityState[VisibilityState["StrobingSlow"] = 6] = "StrobingSlow";
     VisibilityState[VisibilityState["GrowingSlow"] = 7] = "GrowingSlow";
 })(VisibilityState || (exports.VisibilityState = VisibilityState = {}));
-var DeviceState;
-(function (DeviceState) {
-    DeviceState[DeviceState["Faulted"] = -2] = "Faulted";
-    DeviceState[DeviceState["Killed"] = -1] = "Killed";
-    DeviceState[DeviceState["Inactive"] = 0] = "Inactive";
-    DeviceState[DeviceState["Resetting"] = 50] = "Resetting";
-    DeviceState[DeviceState["Idle"] = 100] = "Idle";
-    DeviceState[DeviceState["Running"] = 500] = "Running";
-    DeviceState[DeviceState["Stopping"] = 900] = "Stopping";
-    DeviceState[DeviceState["Aborting"] = 911] = "Aborting";
-    DeviceState[DeviceState["Paused"] = 999] = "Paused";
-    DeviceState[DeviceState["Done"] = 1000] = "Done";
-    DeviceState[DeviceState["Manual"] = 2000] = "Manual";
-})(DeviceState || (exports.DeviceState = DeviceState = {}));
+;
+var States;
+(function (States) {
+    States[States["ABORTING"] = -3] = "ABORTING";
+    States[States["ERROR"] = -2] = "ERROR";
+    States[States["KILLED"] = -1] = "KILLED";
+    States[States["INACTIVE"] = 0] = "INACTIVE";
+    States[States["RESETTING"] = 50] = "RESETTING";
+    States[States["IDLE"] = 100] = "IDLE";
+    States[States["RUNNING"] = 500] = "RUNNING";
+    States[States["STOPPING"] = 900] = "STOPPING";
+    States[States["PAUSED"] = 999] = "PAUSED";
+    States[States["DONE"] = 1000] = "DONE";
+    States[States["MANUAL"] = 1100] = "MANUAL";
+    States[States["UNKNOWN"] = 9999] = "UNKNOWN";
+})(States || (exports.States = States = {}));
+;
+function convertStateToString(state) {
+    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";
+    }
+}
+function convertStateToColor(state) {
+    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";
+    }
+}
+function getStateFromStep(step) {
+    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;
+}
 var PartState;
 (function (PartState) {
     PartState[PartState["Empty"] = 0] = "Empty";

package/dist/functions/colorMapping.d.ts

@@ -1,4 +1,4 @@
 import { Color } from "../enums/Colors";
-import { DeviceState, PartState } from "../enums/States";
-export declare function deviceStateToColorMap(state: DeviceState): Color;
+import { States, PartState } from "../enums/States";
+export declare function deviceStateToColorMap(state: States): Color;
 export declare function partStateToColorMap(state: PartState): Color;

package/dist/functions/colorMapping.js

@@ -6,17 +6,18 @@ const Colors_1 = require("../enums/Colors");
 const States_1 = require("../enums/States");
 function deviceStateToColorMap(state) {
     const colorMap = {
-        [States_1.DeviceState.Killed]: Colors_1.Color.Black,
-        [States_1.DeviceState.Inactive]: Colors_1.Color.Inactive,
-        [States_1.DeviceState.Resetting]: Colors_1.Color.Resetting,
-        [States_1.DeviceState.Idle]: Colors_1.Color.Idle,
-        [States_1.DeviceState.Running]: Colors_1.Color.Running,
-        [States_1.DeviceState.Stopping]: Colors_1.Color.Processing,
-        [States_1.DeviceState.Done]: Colors_1.Color.Done,
-        [States_1.DeviceState.Aborting]: Colors_1.Color.Error,
-        [States_1.DeviceState.Manual]: Colors_1.Color.Manual,
-        [States_1.DeviceState.Paused]: Colors_1.Color.Processing,
-        [States_1.DeviceState.Faulted]: Colors_1.Color.Error,
+        [States_1.States.KILLED]: Colors_1.Color.Black,
+        [States_1.States.INACTIVE]: Colors_1.Color.Inactive,
+        [States_1.States.RESETTING]: Colors_1.Color.Resetting,
+        [States_1.States.IDLE]: Colors_1.Color.Idle,
+        [States_1.States.RUNNING]: Colors_1.Color.Running,
+        [States_1.States.STOPPING]: Colors_1.Color.Processing,
+        [States_1.States.DONE]: Colors_1.Color.Done,
+        [States_1.States.ABORTING]: Colors_1.Color.Error,
+        [States_1.States.MANUAL]: Colors_1.Color.Manual,
+        [States_1.States.PAUSED]: Colors_1.Color.Processing,
+        [States_1.States.ERROR]: Colors_1.Color.Error,
+        [States_1.States.UNKNOWN]: Colors_1.Color.Error,
     };
     return colorMap[state];
 }

package/dist/plc-tags/mqtt.d.ts

@@ -7,7 +7,3 @@ export declare const MqttTopics: {
     readonly BRIDGE_CMD: "bridge/cmd";
     readonly DEVICE_MAP: "deviceMap";
 };
-export declare const BridgeCmds: {
-    readonly CONNECT: "connect";
-    readonly DISCONNECT: "disconnect";
-};

package/dist/plc-tags/mqtt.js

@@ -1,12 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.BridgeCmds = exports.MqttTopics = void 0;
+exports.MqttTopics = void 0;
 exports.MqttTopics = {
     BRIDGE_STATUS: 'bridge/status',
     BRIDGE_CMD: 'bridge/cmd',
     DEVICE_MAP: 'deviceMap',
 };
-exports.BridgeCmds = {
-    CONNECT: 'connect',
-    DISCONNECT: 'disconnect'
-};

package/package.json

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

package/src/custom-types/HMI.ts

@@ -1,5 +1,5 @@
 import { FaultCodeData } from "./Machine";
-import { BannerMode, Color, DeviceState, VisibilityState } from "..";
+import { BannerMode, Color, States, VisibilityState } from "..";
 
 
 export interface ComponentAnimation {
@@ -26,7 +26,7 @@ export interface ButtonBar {
 
 export interface StatusBar {
   jobName: string;
-  statusMsg: DeviceState;
+  statusMsg: States;
   status: number;
   cncTimeLeft: number[]; // get the second element in the array
   goodCnt: number;

package/src/functions/colorMapping.ts

@@ -1,19 +1,20 @@
 import { Color } from "../enums/Colors";
-import { DeviceState, PartState } from "../enums/States";
+import { States, 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,
+export function deviceStateToColorMap(state: States): Color {
+  const colorMap: { [key in States]: Color } = {
+    [States.KILLED]: Color.Black,
+    [States.INACTIVE]: Color.Inactive,
+    [States.RESETTING]: Color.Resetting,
+    [States.IDLE]: Color.Idle,
+    [States.RUNNING]: Color.Running,
+    [States.STOPPING]: Color.Processing,
+    [States.DONE]: Color.Done,
+    [States.ABORTING]: Color.Error,
+    [States.MANUAL]: Color.Manual,
+    [States.PAUSED]: Color.Processing,
+    [States.ERROR]: Color.Error,
+    [States.UNKNOWN]: Color.Error,
   };
 
   return colorMap[state];