@kuriousdesign/machine-sdk 1.0.64 → 1.0.69

package/src/custom-types/HMI.ts

@@ -1,52 +1,52 @@
-import { FaultCodeData } from "./Machine";
-import { BannerMode, Color, States, VisibilityState } from "..";
-
-
-export interface ComponentAnimation {
-  visibility: VisibilityState; //enum
-  needsExpertUser: boolean; //requires expert user to be active user in order to function
-  backgroundColor: Color; //enum
-  accentColor: Color; //enum
-  fontColor: Color; //enum
-  wasClicked: boolean; //this is set by the UI and reset by the PLC
-}
-
-export interface ButtonBar {
-  stopBtn: ComponentAnimation;
-  unloadBtn: ComponentAnimation;
-  loadBtn: ComponentAnimation;
-  unlockBtn: ComponentAnimation;
-  startBtn: ComponentAnimation;
-  lockBtn: ComponentAnimation;
-  resetBtn: ComponentAnimation;
-  jobChangeBtn: ComponentAnimation;
-  clearFaultsBtn: ComponentAnimation;
-  energizeBtn: ComponentAnimation;
-}
-
-export interface StatusBar {
-  jobName: string;
-  statusMsg: States;
-  status: number;
-  cncTimeLeft: number[]; // get the second element in the array
-  goodCnt: number;
-  batchQty: number;
-  dateAndTime: string; //format : 1970-01-01T00:00:00.000Z
-  bannerMode: BannerMode;
-  faultCodeData: FaultCodeData;
-}
-
-export interface RackHmiPbs {
-  editRawShelfBtn: ComponentAnimation;
-  editDoneShelfBtn: ComponentAnimation;
-  cancelBtn: ComponentAnimation;
-  saveBtn: ComponentAnimation;
-}
-
-export interface HmiData {
-  buttonBar: ButtonBar;
-  statusBar: StatusBar;
-  rackPbs: RackHmiPbs;
-  heartbeatPLC: number;
-  heartbeatHMI: number;
-}
+import { FaultCodeData } from "./Machine";
+import { BannerMode, Color, States, VisibilityState } from "..";
+
+
+export interface ComponentAnimation {
+  visibility: VisibilityState; //enum
+  needsExpertUser: boolean; //requires expert user to be active user in order to function
+  backgroundColor: Color; //enum
+  accentColor: Color; //enum
+  fontColor: Color; //enum
+  wasClicked: boolean; //this is set by the UI and reset by the PLC
+}
+
+export interface ButtonBar {
+  stopBtn: ComponentAnimation;
+  unloadBtn: ComponentAnimation;
+  loadBtn: ComponentAnimation;
+  unlockBtn: ComponentAnimation;
+  startBtn: ComponentAnimation;
+  lockBtn: ComponentAnimation;
+  resetBtn: ComponentAnimation;
+  jobChangeBtn: ComponentAnimation;
+  clearFaultsBtn: ComponentAnimation;
+  energizeBtn: ComponentAnimation;
+}
+
+export interface StatusBar {
+  jobName: string;
+  statusMsg: States;
+  status: number;
+  cncTimeLeft: number[]; // get the second element in the array
+  goodCnt: number;
+  batchQty: number;
+  dateAndTime: string; //format : 1970-01-01T00:00:00.000Z
+  bannerMode: BannerMode;
+  faultCodeData: FaultCodeData;
+}
+
+export interface RackHmiPbs {
+  editRawShelfBtn: ComponentAnimation;
+  editDoneShelfBtn: ComponentAnimation;
+  cancelBtn: ComponentAnimation;
+  saveBtn: ComponentAnimation;
+}
+
+export interface HmiData {
+  buttonBar: ButtonBar;
+  statusBar: StatusBar;
+  rackPbs: RackHmiPbs;
+  heartbeatPLC: number;
+  heartbeatHMI: number;
+}

package/src/custom-types/Machine.ts

@@ -1,130 +1,130 @@
-import { ComponentAnimation, DebugLogData, DeviceConstants, DeviceRegistration, initialDebugLogData, initialRecipeStore, initialTaskQueue, RecipeStore, TaskQueue } from ".";
-import { initialPartDataStatus, PartDataStatus } from "./Part";
-import { GCs } from "./GlobalConstants";
-
-
-export interface UserData {
-  activeUser: number;
-  hmiLoginBtn: ComponentAnimation;
-  hmiLogoutBtn: ComponentAnimation;
-}
-
-export interface FaultCodeData {
-  deviceId: number;
-  code: number;
-}
-
-export const initialFaultCodeData: FaultCodeData = {
-  deviceId: 0,
-  code: 0,
-};
-
-export interface SystemFaultData {
-  list: FaultCodeData[];
-  present: boolean;
-}
-
-export const initialSystemFaultData: SystemFaultData = {
-  list: Array(DeviceConstants.DEVICE_FAULTCODEARRAY_LEN).fill(null).map(() => ({ ...initialFaultCodeData })),
-  present: false,
-};
-
-
-
-// TYPE MachineCfg :
-// STRUCT
-// 	FirmwareVersion: STRING;
-// 	CellType: CellTypes;
-// 	SoftwareMode: SoftwareModes;
-// 	AllowAnonymousControl: BOOL;
-// 	DeviceIsBypassed: ARRAY[0..(GCs.NUM_DEVICES-1)] OF BOOL; //used to set devices to be bypassed or not
-// 	ApiOpcuaDeviceId:INT; //designates which device is using the opcua api
-// 	EthernetAdapterList: ARRAY[0..4] OF INT;
-// 	//SerialNumber: STRING(255); moved to ControllerInstanceData
-// 	//Name: STRING; moved to ControllerInstanceData
-// 	//Location: STRING; moved to ControllerInstanceData
-	
-// END_STRUCT
-// END_TYPE
-
-
-export interface MachineCfg {
-  firmwareVersion: string;
-  cellType: string;
-  softwareMode: string;
-  allowAnonymousControl: boolean;
-  deviceIsBypassed: boolean[];
-  apiOpcuaDeviceId: number;
-  ethernetAdapterList: number[];
-}
-
-export const initialMachineCfg: MachineCfg = {
-  firmwareVersion: "",
-  cellType: "",
-  softwareMode: "",
-  allowAnonymousControl: false,
-  deviceIsBypassed: [],
-  apiOpcuaDeviceId: -1,
-  ethernetAdapterList: [],
-};
-
-export interface Machine {
-    estopCircuit_OK: boolean;
-    estopCircuitDelayed_OK: boolean;
-    fenceCircuit_OK: boolean;
-    guardDoors_LOCKED: boolean;
-    networkHealth_OK: boolean;
-    ethercatMaster_OK: boolean;
-    ethercatSlaves_OK: boolean;
-    supplyAir_OK: boolean;
-    cfg: MachineCfg;
-    pdmSts: PartDataStatus;
-    errors: SystemFaultData;
-    warnings: SystemFaultData;
-    taskQueue: TaskQueue;
-    registeredDevices: DeviceRegistration[];
-    heartbeatPlc: number;
-    heartbeatHmi: number;
-    machineLog: LogRecordData;
-    recipeStore: RecipeStore;
-    //deviceLogs: DeviceLogData[];  //ARRAY[0..(GCs.NUM_DEVICES-1)] OF DeviceLogData;
-}
-
-// TYPE LogRecordData :
-// STRUCT
-// 	List: ARRAY[0..DiagConstants.NUM_ENTRIES_RECORDED_LOG-1] OF DebugLogData;
-// 	LastIndex:USINT; //index of the most recent recorde entries
-// END_STRUCT
-// END_TYPE
-
-export interface LogRecordData {
-  list: DebugLogData[];
-  lastIndex: number; // index of the most recent recorded entries
-}
-
-export const initialLogRecordData: LogRecordData = {
-  list: Array(GCs.NUM_ENTRIES_MACHINE_LOG).fill(null).map(() => ({ ...initialDebugLogData })),
-  lastIndex: 0,
-};
-
-export const initialMachine: Machine = ({
-  estopCircuit_OK: false,
-  estopCircuitDelayed_OK: false,
-  fenceCircuit_OK: false,
-  guardDoors_LOCKED: false,
-  networkHealth_OK: false,
-  ethercatMaster_OK: false,
-  ethercatSlaves_OK: false,
-  supplyAir_OK: false,
-  cfg: { ...initialMachineCfg },
-  pdmSts: initialPartDataStatus,
-  errors: { ...initialSystemFaultData },
-  warnings: { ...initialSystemFaultData },
-  taskQueue: { ...initialTaskQueue },
-  registeredDevices: [],
-  heartbeatPlc: 0,
-  heartbeatHmi: 0,
-  machineLog: { ...initialLogRecordData },
-  recipeStore: { ...initialRecipeStore },
-  //deviceLogs: Array(GCs.NUM_DEVICES).fill(null).map(() => ({ ...initialDeviceLogData })),
-});
+import { ComponentAnimation, DebugLogData, DeviceConstants, DeviceRegistration, initialDebugLogData, initialRecipeStore, initialTaskQueue, RecipeStore, TaskQueue } from ".";
+import { initialPartDataStatus, PartDataStatus } from "./Part";
+import { GCs } from "./GlobalConstants";
+
+
+export interface UserData {
+  activeUser: number;
+  hmiLoginBtn: ComponentAnimation;
+  hmiLogoutBtn: ComponentAnimation;
+}
+
+export interface FaultCodeData {
+  deviceId: number;
+  code: number;
+}
+
+export const initialFaultCodeData: FaultCodeData = {
+  deviceId: 0,
+  code: 0,
+};
+
+export interface SystemFaultData {
+  list: FaultCodeData[];
+  present: boolean;
+}
+
+export const initialSystemFaultData: SystemFaultData = {
+  list: Array(DeviceConstants.DEVICE_FAULTCODEARRAY_LEN).fill(null).map(() => ({ ...initialFaultCodeData })),
+  present: false,
+};
+
+
+
+// TYPE MachineCfg :
+// STRUCT
+// 	FirmwareVersion: STRING;
+// 	CellType: CellTypes;
+// 	SoftwareMode: SoftwareModes;
+// 	AllowAnonymousControl: BOOL;
+// 	DeviceIsBypassed: ARRAY[0..(GCs.NUM_DEVICES-1)] OF BOOL; //used to set devices to be bypassed or not
+// 	ApiOpcuaDeviceId:INT; //designates which device is using the opcua api
+// 	EthernetAdapterList: ARRAY[0..4] OF INT;
+// 	//SerialNumber: STRING(255); moved to ControllerInstanceData
+// 	//Name: STRING; moved to ControllerInstanceData
+// 	//Location: STRING; moved to ControllerInstanceData
+	
+// END_STRUCT
+// END_TYPE
+
+
+export interface MachineCfg {
+  firmwareVersion: string;
+  cellType: string;
+  softwareMode: string;
+  allowAnonymousControl: boolean;
+  deviceIsBypassed: boolean[];
+  apiOpcuaDeviceId: number;
+  ethernetAdapterList: number[];
+}
+
+export const initialMachineCfg: MachineCfg = {
+  firmwareVersion: "",
+  cellType: "",
+  softwareMode: "",
+  allowAnonymousControl: false,
+  deviceIsBypassed: [],
+  apiOpcuaDeviceId: -1,
+  ethernetAdapterList: [],
+};
+
+export interface Machine {
+    estopCircuit_OK: boolean;
+    estopCircuitDelayed_OK: boolean;
+    fenceCircuit_OK: boolean;
+    guardDoors_LOCKED: boolean;
+    networkHealth_OK: boolean;
+    ethercatMaster_OK: boolean;
+    ethercatSlaves_OK: boolean;
+    supplyAir_OK: boolean;
+    cfg: MachineCfg;
+    pdmSts: PartDataStatus;
+    errors: SystemFaultData;
+    warnings: SystemFaultData;
+    taskQueue: TaskQueue;
+    registeredDevices: DeviceRegistration[];
+    heartbeatPlc: number;
+    heartbeatHmi: number;
+    machineLog: LogRecordData;
+    recipeStore: RecipeStore;
+    //deviceLogs: DeviceLogData[];  //ARRAY[0..(GCs.NUM_DEVICES-1)] OF DeviceLogData;
+}
+
+// TYPE LogRecordData :
+// STRUCT
+// 	List: ARRAY[0..DiagConstants.NUM_ENTRIES_RECORDED_LOG-1] OF DebugLogData;
+// 	LastIndex:USINT; //index of the most recent recorde entries
+// END_STRUCT
+// END_TYPE
+
+export interface LogRecordData {
+  list: DebugLogData[];
+  lastIndex: number; // index of the most recent recorded entries
+}
+
+export const initialLogRecordData: LogRecordData = {
+  list: Array(GCs.NUM_ENTRIES_MACHINE_LOG).fill(null).map(() => ({ ...initialDebugLogData })),
+  lastIndex: 0,
+};
+
+export const initialMachine: Machine = ({
+  estopCircuit_OK: false,
+  estopCircuitDelayed_OK: false,
+  fenceCircuit_OK: false,
+  guardDoors_LOCKED: false,
+  networkHealth_OK: false,
+  ethercatMaster_OK: false,
+  ethercatSlaves_OK: false,
+  supplyAir_OK: false,
+  cfg: { ...initialMachineCfg },
+  pdmSts: initialPartDataStatus,
+  errors: { ...initialSystemFaultData },
+  warnings: { ...initialSystemFaultData },
+  taskQueue: { ...initialTaskQueue },
+  registeredDevices: [],
+  heartbeatPlc: 0,
+  heartbeatHmi: 0,
+  machineLog: { ...initialLogRecordData },
+  recipeStore: { ...initialRecipeStore },
+  //deviceLogs: Array(GCs.NUM_DEVICES).fill(null).map(() => ({ ...initialDeviceLogData })),
+});