@kuriousdesign/machine-sdk 1.0.90 → 1.0.97

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

@@ -25,6 +25,22 @@ export interface MachineCfg {
     ethernetAdapterList: number[];
 }
 export declare const initialMachineCfg: MachineCfg;
+export interface SettingsExpert {
+    overridesEnabled: boolean;
+    autoLogoutTime: number;
+    expertStaysLoggedIn: boolean;
+    dryCycle: boolean;
+}
+export declare const initialSettingsExpert: SettingsExpert;
+export interface SettingsAllUsers {
+    placeholderBool: boolean;
+}
+export declare const initialSettingsAllUsers: SettingsAllUsers;
+export interface Settings {
+    allUsers: SettingsAllUsers;
+    expert: SettingsExpert;
+}
+export declare const initialSettings: Settings;
 export interface Machine {
     estopCircuit_OK: boolean;
     estopCircuitDelayed_OK: boolean;
@@ -49,6 +65,7 @@ export interface Machine {
     currentTimeMs: number;
     activeUserId: number;
     activeRecipe: RecipeData;
+    settings: Settings;
 }
 export interface LogRecordData {
     list: DebugLogData[];

package/dist/custom-types/Machine.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.initialMachine = exports.initialLogRecordData = exports.initialMachineCfg = exports.initialSystemFaultData = exports.initialFaultCodeData = void 0;
+exports.initialMachine = exports.initialLogRecordData = exports.initialSettings = exports.initialSettingsAllUsers = exports.initialSettingsExpert = exports.initialMachineCfg = exports.initialSystemFaultData = exports.initialFaultCodeData = void 0;
 const _1 = require(".");
 const Part_1 = require("./Part");
 const GlobalConstants_1 = require("./GlobalConstants");
@@ -21,6 +21,21 @@ exports.initialMachineCfg = {
     apiOpcuaDeviceId: -1,
     ethernetAdapterList: [],
 };
+exports.initialSettingsExpert = {
+    overridesEnabled: false,
+    autoLogoutTime: 15, // default to 15 minutes
+    //skipDeburrBottom: false,
+    //skipDeburrTop: false,
+    expertStaysLoggedIn: false,
+    dryCycle: false,
+};
+exports.initialSettingsAllUsers = {
+    placeholderBool: false,
+};
+exports.initialSettings = {
+    allUsers: { ...exports.initialSettingsAllUsers },
+    expert: { ...exports.initialSettingsExpert },
+};
 exports.initialLogRecordData = {
     list: Array(GlobalConstants_1.GCs.NUM_ENTRIES_MACHINE_LOG).fill(null).map(() => ({ ..._1.initialDebugLogData })),
     lastIndex: 0,
@@ -50,4 +65,5 @@ exports.initialMachine = ({
     currentTimeMs: 0,
     activeUserId: 0,
     activeRecipe: { ..._1.initialRecipe },
+    settings: { ...exports.initialSettings },
 });

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

@@ -2,7 +2,6 @@ export interface JobData {
     activeRecipeIndex: number;
     jobName: string;
     tubeTypeString: string;
-    activeBatchNumber: number;
     lotQty: number;
     goodCnt: number;
     scrapCnt: number;
@@ -12,6 +11,16 @@ export interface JobData {
     jobStartTime: bigint;
     jobEndTime: bigint;
     jobComplete: boolean;
+    activeBatchNumber: number;
+    batchId: string;
+    workOrderId: string;
+    lotId: string;
+    salesOrderId: string;
+    assemblyName: string;
+    assemblyNumber: string;
+    workInstruction: string;
+    operationNumber: string;
+    operatorId: string;
 }
 export declare const initialJobData: JobData;
 export interface ApplicatorSetpoint {

package/dist/custom-types/Recipe.js

@@ -5,9 +5,8 @@ exports.getTubeTypeString = getTubeTypeString;
 const GlobalConstants_1 = require("./GlobalConstants");
 exports.initialJobData = {
     activeRecipeIndex: 0,
-    jobName: "",
-    tubeTypeString: "",
-    activeBatchNumber: 0,
+    jobName: '',
+    tubeTypeString: '',
     lotQty: 0,
     goodCnt: 0,
     scrapCnt: 0,
@@ -16,7 +15,18 @@ exports.initialJobData = {
     setupCompleted: false,
     jobStartTime: BigInt(0),
     jobEndTime: BigInt(0),
-    jobComplete: false
+    jobComplete: false,
+    activeBatchNumber: 0,
+    //heatId: '',
+    batchId: '',
+    workOrderId: '',
+    lotId: '',
+    salesOrderId: '',
+    assemblyName: '',
+    assemblyNumber: '',
+    workInstruction: '',
+    operationNumber: '',
+    operatorId: '',
 };
 exports.initialApplicatorSetpoint = {
     speed: 0,

package/dist/enums/DeviceId.d.ts

@@ -1,11 +1,11 @@
 export declare enum DeviceId {
-    NONE = 0,
+    NONE = 0,// Represents no device selected or invalid state
     SYS = 1,
     HMI = 2,
     SFTY = 3,
     CON = 4,
     DIAG = 5,
-    RC = 6,
+    UDP = 6,//Robot Controller
     ROB = 10,
     ABB = 11,
     EOAT = 12,

package/dist/enums/DeviceId.js

@@ -10,7 +10,8 @@ var DeviceId;
     DeviceId[DeviceId["SFTY"] = 3] = "SFTY";
     DeviceId[DeviceId["CON"] = 4] = "CON";
     DeviceId[DeviceId["DIAG"] = 5] = "DIAG";
-    DeviceId[DeviceId["RC"] = 6] = "RC";
+    DeviceId[DeviceId["UDP"] = 6] = "UDP";
+    // 0 - 9 ARE RESERVED FOR SYSTEM LEVEL STUFF
     DeviceId[DeviceId["ROB"] = 10] = "ROB";
     DeviceId[DeviceId["ABB"] = 11] = "ABB";
     DeviceId[DeviceId["EOAT"] = 12] = "EOAT";
@@ -64,7 +65,7 @@ function deviceIdToString(deviceId) {
         case DeviceId.SFTY: return "SFTY";
         case DeviceId.CON: return "CON";
         case DeviceId.DIAG: return "DIAG";
-        case DeviceId.RC: return "RC";
+        case DeviceId.UDP: return "UDP";
         case DeviceId.ROB: return "ROB";
         case DeviceId.ABB: return "ABB";
         case DeviceId.EOAT: return "EOAT";

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

@@ -25,6 +25,7 @@ export declare const MachineTags: {
     ethercatMaster_OK: string;
     ethercatSlaves_OK: string;
     currentTimeMs: string;
+    settings: string;
 };
 export declare const DeviceTags: {
     Cfg: string;

package/dist/plc-tags/index.js

@@ -45,6 +45,7 @@ exports.MachineTags = {
     ethercatMaster_OK: 'EthercatMaster_OK',
     ethercatSlaves_OK: 'EthercatSlaves_OK',
     currentTimeMs: 'CurrentTimeMs',
+    settings: 'Settings',
 };
 exports.DeviceTags = {
     Cfg: 'Cfg',

package/package.json

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

package/src/custom-types/Machine.ts

@@ -68,6 +68,45 @@ export const initialMachineCfg: MachineCfg = {
   ethernetAdapterList: [],
 };
 
+
+
+export interface SettingsExpert {
+  overridesEnabled: boolean;
+  autoLogoutTime: number; // expert user will be automatically logged-out after this time
+  //skipDeburrBottom: boolean; // skip deburr bottom
+  //skipDeburrTop: boolean; // skip deburr top
+  expertStaysLoggedIn: boolean;
+  dryCycle: boolean; // when true, this will run the machine through the cycle without dispensing or curing to allow for testing and setup
+}
+
+export const initialSettingsExpert: SettingsExpert = {
+  overridesEnabled: false,
+  autoLogoutTime: 15, // default to 15 minutes
+  //skipDeburrBottom: false,
+  //skipDeburrTop: false,
+  expertStaysLoggedIn: false,
+  dryCycle: false,
+};
+
+
+
+export interface SettingsAllUsers {
+  placeholderBool: boolean;
+}
+export const initialSettingsAllUsers: SettingsAllUsers = {
+  placeholderBool: false,
+};
+
+export interface Settings {
+  allUsers: SettingsAllUsers;
+  expert: SettingsExpert;
+}
+
+export const initialSettings: Settings = {
+  allUsers: { ...initialSettingsAllUsers },
+  expert: { ...initialSettingsExpert },
+};
+
 export interface Machine {
     estopCircuit_OK: boolean;
     estopCircuitDelayed_OK: boolean;
@@ -93,6 +132,7 @@ export interface Machine {
     currentTimeMs: number;
     activeUserId: number;
     activeRecipe: RecipeData;
+    settings: Settings;
 }
 
 // TYPE LogRecordData :
@@ -137,4 +177,5 @@ export const initialMachine: Machine = ({
   currentTimeMs: 0,
   activeUserId: 0,
   activeRecipe: { ...initialRecipe},
+  settings: { ...initialSettings },
 });

package/src/custom-types/Recipe.ts

@@ -2,27 +2,35 @@ import { GCs } from "./GlobalConstants";
 
 
 export interface JobData {
-    activeRecipeIndex: number;
-    jobName: string;
+    activeRecipeIndex: number; //used with Machine.RecipeStore.Recipes array
+    jobName: string; //this is the identifier for the specific job
     tubeTypeString: string;
-    activeBatchNumber: number;
-
-    lotQty: number;
-    goodCnt: number;
-    scrapCnt: number;
-    setupStartTime: bigint;
-    setupEndTime: bigint;
-    setupCompleted: boolean;
-    jobStartTime: bigint;
-    jobEndTime: bigint;
+    lotQty: number; //how many parts you are supposed to make per the job request
+    goodCnt: number; //how many good parts you've completed since starting the job
+    scrapCnt: number; //how many parts you've scrapped since starting the job
+    setupStartTime: bigint; //timestamp
+    setupEndTime: bigint;//timestamp
+    setupCompleted: boolean;//status
+    jobStartTime: bigint;//timestamp
+    jobEndTime: bigint;//timestamp
     jobComplete: boolean;
+    activeBatchNumber: number; //this probably needs to change to activeHeatId
+    //heatId: string;
+    batchId: string;
+    workOrderId: string;
+    lotId: string;
+    salesOrderId: string;
+    assemblyName : string;
+    assemblyNumber : string;
+    workInstruction : string;
+    operationNumber : string;
+    operatorId: string; //uses collins employeeId
 }
 
 export const initialJobData: JobData = {
     activeRecipeIndex: 0,
-    jobName: "",
-    tubeTypeString: "",
-    activeBatchNumber: 0,
+    jobName: '',
+    tubeTypeString: '',
     lotQty: 0,
     goodCnt: 0,
     scrapCnt: 0,
@@ -31,7 +39,18 @@ export const initialJobData: JobData = {
     setupCompleted: false,
     jobStartTime: BigInt(0),
     jobEndTime: BigInt(0),
-    jobComplete: false
+    jobComplete: false,
+    activeBatchNumber: 0,
+    //heatId: '',
+    batchId: '',
+    workOrderId: '',
+    lotId: '',
+    salesOrderId: '',
+    assemblyName : '',
+    assemblyNumber : '',
+    workInstruction : '',
+    operationNumber : '',
+    operatorId: '',
 };
 
 export interface ApplicatorSetpoint {
@@ -54,29 +73,37 @@ export const initialApplicatorSetpoint: ApplicatorSetpoint = {
 export const initialApplicatorSetpoints: ApplicatorSetpoint[] = Array.from({ length: GCs.MAX_APPLICATOR_SETPOINTS }, () => initialApplicatorSetpoint);
 
 export interface RecipeData {
-    index: number;
-    dbId: string;
-    nickname: string;
-    linerPotPressure: number;
-    linerTypeString: string;
+    index: number; //same as index in Machine.RecipeStore.Recipes
+    dbId: string; //mongodb identifier for recipe
+    nickname: string; //unique nickname for the recipe
+
+    // LINER DATA
+    linerPotPressure: number; //psi
+    linerTypeString: string; //display purposes only
     linerWeightMin: number;
     linerWeightMax: number;
-    tubeTypeId: number;
-    tubeTypeString: string;
-    tubeOuterDiameterMax: number;
-    tubeHeightMax: number;
-    tubeMassKg: number;
-    falseBottomStaysOpen: boolean;
+
+    // TUBE DATA
+    tubeTypeId: number; //ROBOT
+    tubeTypeString: string; //display purposes only
+    tubeOuterDiameterMax: number; //mm, used for robot offsets in fixture  <ROBOT>
+    tubeHeightMax: number; //mm, used for approach to tubes and the pick position for weighing <ROBOT>
+    tubeMassKg: number; //kg, used for payload adjustment when gripping tubes
+    falseBottomStaysOpen: boolean; //this also determines if only the tall fixture is used or not  <ROBOT>
+
+    // APPLICATOR SETPOINTS
     applicatorHasVariableSqueegee: boolean;
-    measuredSqueegeeDiaAtSetpoint1: number;
-    applicatorSetpoints: ApplicatorSetpoint[];
-    applicatorPreloadPauseDuration: number;
-    applicatorToolId: number;
+    measuredSqueegeeDiaAtSetpoint1: number;//set after calibration
+    applicatorSetpoints: ApplicatorSetpoint[]; // <ROBOT>
+    applicatorPreloadPauseDuration: number; //pause it takes after opening ball valve for the first move
+
+    // TOOLS
+    applicatorToolId: number; // <ROBOT> --> this would link to TCP number in the ABB Code
     applicatorToolString: string;
-    applicatorCollisionPayloadOffset: number;
-    cleanerId: number;
+    applicatorCollisionPayloadOffset: number; //kg, used to set the collision detection sensitivity during liner application, gripLoad cmd used to add artificial payload
+    cleanerId: number; // <ROBOT>
     cleanerString: string;
-    weighingFingerId: number;
+    weighingFingerId: number; // <ROBOT> --> this would link to TCP number in the ABB Code
     weighingFingerString: string;
     cameraId: number;
     cameraString: string;

package/src/enums/DeviceId.ts

@@ -1,24 +1,25 @@
 export enum DeviceId {
-  NONE = 0,
-  SYS = 1,
-  HMI = 2,
-  SFTY = 3,
-  CON = 4,
-  DIAG = 5,
-  RC = 6,
-  
-  ROB = 10,
-  ABB = 11,
-  EOAT = 12,
-  VIS = 13,
-  FIX_T = 14,
-  FIX_S = 15,
-  CLAMP_T = 16,
-  CLAMP_S = 17,
-  FLSB_T = 18,
-  FLSB_S = 19,
-  POT = 20,
-  SQUEE = 21,
+    NONE = 0,       // Represents no device selected or invalid state
+    SYS = 1,
+    HMI = 2,
+    SFTY = 3,
+    CON = 4,
+	DIAG = 5,
+	UDP = 6, //Robot Controller
+	// 0 - 9 ARE RESERVED FOR SYSTEM LEVEL STUFF
+	
+	ROB = 10,
+	ABB = 11,
+	EOAT = 12,
+	VIS = 13,
+	FIX_T = 14,
+	FIX_S = 15,
+	CLAMP_T = 16,
+	CLAMP_S = 17,
+	FLSB_T = 18,
+	FLSB_S = 19,
+	POT = 20,
+	SQUEE = 21,
 	GRIP = 22,
 	WEIGH = 23,
 
@@ -66,7 +67,7 @@ export function deviceIdToString(deviceId: DeviceId | number): string {
     case DeviceId.SFTY: return "SFTY";
     case DeviceId.CON: return "CON";
     case DeviceId.DIAG: return "DIAG";
-    case DeviceId.RC: return "RC";
+    case DeviceId.UDP: return "UDP";
     case DeviceId.ROB: return "ROB";
     case DeviceId.ABB: return "ABB";
     case DeviceId.EOAT: return "EOAT";

package/src/plc-tags/index.ts

@@ -30,6 +30,7 @@ export const MachineTags = {
 	ethercatMaster_OK: 'EthercatMaster_OK',
 	ethercatSlaves_OK: 'EthercatSlaves_OK',
     currentTimeMs: 'CurrentTimeMs',
+    settings: 'Settings',
 }
 
 export const DeviceTags = {