@kuriousdesign/machine-sdk 1.0.21 → 1.0.22

package/dist/custom-types/BaseDevice/ApiOpcua.d.ts

@@ -2,16 +2,16 @@ import { DeviceActionRequestData } from "./Actions";
 export interface ApiOpcuaReqData {
     id: number;
     checkSum: number;
-    ActionRequestData: DeviceActionRequestData;
-    Sts: number;
+    actionRequestData: DeviceActionRequestData;
+    sts: number;
 }
 export declare const initialApiOpcuaReqData: ApiOpcuaReqData;
 export interface ApiOpcuaData {
-    HmiReq: ApiOpcuaReqData;
-    HmiResp: ApiOpcuaReqData;
-    OrchReq: ApiOpcuaReqData;
-    OrchResp: ApiOpcuaReqData;
-    Req: ApiOpcuaReqData;
-    Resp: ApiOpcuaReqData;
+    hmiReq: ApiOpcuaReqData;
+    hmiResp: ApiOpcuaReqData;
+    orchReq: ApiOpcuaReqData;
+    orchResp: ApiOpcuaReqData;
+    req: ApiOpcuaReqData;
+    resp: ApiOpcuaReqData;
 }
 export declare const initialApiOpcuaData: ApiOpcuaData;

package/dist/custom-types/BaseDevice/ApiOpcua.js

@@ -5,14 +5,14 @@ const Actions_1 = require("./Actions");
 exports.initialApiOpcuaReqData = {
     id: 0,
     checkSum: 0,
-    ActionRequestData: Actions_1.initialDeviceActionRequestData,
-    Sts: 0
+    actionRequestData: Actions_1.initialDeviceActionRequestData,
+    sts: 0
 };
 exports.initialApiOpcuaData = {
-    HmiReq: {},
-    HmiResp: {},
-    OrchReq: {},
-    OrchResp: {},
-    Req: {},
-    Resp: {}
+    hmiReq: {},
+    hmiResp: {},
+    orchReq: {},
+    orchResp: {},
+    req: {},
+    resp: {}
 };

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

@@ -2,14 +2,14 @@ import { DeviceTypes } from '../Devices/DeviceTypes';
 import { ProcessData } from './Processes';
 import { ApiOpcuaData } from './ApiOpcua';
 export interface DebugLogData {
-    Msg: string;
-    TimeStamp: Date;
-    Id: number;
+    msg: string;
+    timeStamp: Date;
+    id: number;
 }
 export declare const initialDebugLogData: DebugLogData;
 export interface DeviceLogData {
-    List: DebugLogData[];
-    LastIndex: number;
+    list: DebugLogData[];
+    lastIndex: number;
 }
 export declare const initialDeviceLogData: DeviceLogData;
 export interface DeviceRegistration {
@@ -28,21 +28,21 @@ export interface DeviceCfg {
 }
 export declare const initialDeviceCfg: DeviceCfg;
 export interface FaultData {
-    DeviceId: number;
-    Code: number;
-    Msg: string;
-    AutoReset: boolean;
-    ResetFlag: boolean;
-    LogFlag: boolean;
-    TimeStamp: Date;
-    StepNum: number;
-    ParentStepNum: number;
+    deviceId: number;
+    code: number;
+    msg: string;
+    autoReset: boolean;
+    resetFlag: boolean;
+    logFlag: boolean;
+    timeStamp: Date;
+    stepNum: number;
+    parentStepNum: number;
 }
 export declare const initialFaultData: FaultData;
 export interface DeviceFaultData {
-    List: FaultData[];
-    Present: boolean;
-    ChildrenPresent: boolean;
+    list: FaultData[];
+    present: boolean;
+    childrenPresent: boolean;
 }
 export declare const initialDeviceFaultData: DeviceFaultData;
 export interface DeviceStatus {

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

@@ -6,13 +6,13 @@ const Processes_1 = require("./Processes");
 const DeviceConstants_1 = require("./DeviceConstants");
 const ApiOpcua_1 = require("./ApiOpcua");
 exports.initialDebugLogData = {
-    Msg: '',
-    TimeStamp: new Date(),
-    Id: 0
+    msg: '',
+    timeStamp: new Date(),
+    id: 0
 };
 exports.initialDeviceLogData = {
-    List: new Array(DeviceConstants_1.DeviceConstants.NUM_LOG_ENTRIES).fill(null),
-    LastIndex: 0
+    list: new Array(DeviceConstants_1.DeviceConstants.NUM_LOG_ENTRIES).fill(null),
+    lastIndex: 0
 };
 ;
 exports.initialDeviceRegistration = {
@@ -29,20 +29,20 @@ exports.initialDeviceCfg = {
     ignore: false
 };
 exports.initialFaultData = {
-    DeviceId: 0,
-    Code: 0,
-    Msg: '',
-    AutoReset: false,
-    ResetFlag: false,
-    LogFlag: false,
-    TimeStamp: new Date(),
-    StepNum: 0,
-    ParentStepNum: 0
+    deviceId: 0,
+    code: 0,
+    msg: '',
+    autoReset: false,
+    resetFlag: false,
+    logFlag: false,
+    timeStamp: new Date(),
+    stepNum: 0,
+    parentStepNum: 0
 };
 exports.initialDeviceFaultData = {
-    List: [],
-    Present: false,
-    ChildrenPresent: false
+    list: [],
+    present: false,
+    childrenPresent: false
 };
 exports.initialDeviceStatus = {
     state: 0,

package/dist/custom-types/BaseDevice/Processes.d.ts

@@ -1,18 +1,18 @@
 export interface ProcessData {
-    RequestId: number;
-    RequestParamArray: number[];
-    SenderId: number;
-    ActiveId: number;
-    ActiveName: string;
-    LastId: number;
+    requestId: number;
+    requestParamArray: number[];
+    senderId: number;
+    activeId: number;
+    activeName: string;
+    lastId: number;
     firstScan: boolean;
     isStepNum: number;
-    StepDescription: string;
+    stepDescription: string;
     isDone: boolean;
     isError: boolean;
-    NextStepNum: number;
-    DeviceStateThatCalled: number;
-    DeviceStepThatCalled: number;
-    ParamArray: number[];
+    nextStepNum: number;
+    deviceStateThatCalled: number;
+    deviceStepThatCalled: number;
+    paramArray: number[];
 }
 export declare const initialProcessData: ProcessData;

package/dist/custom-types/BaseDevice/Processes.js

@@ -2,19 +2,19 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.initialProcessData = void 0;
 exports.initialProcessData = {
-    RequestId: 0,
-    RequestParamArray: new Array(10).fill(0),
-    SenderId: 0,
-    ActiveId: 0,
-    ActiveName: '',
-    LastId: 0,
+    requestId: 0,
+    requestParamArray: new Array(10).fill(0),
+    senderId: 0,
+    activeId: 0,
+    activeName: '',
+    lastId: 0,
     firstScan: false,
     isStepNum: 0,
-    StepDescription: '',
+    stepDescription: '',
     isDone: false,
     isError: false,
-    NextStepNum: 0,
-    DeviceStateThatCalled: 0,
-    DeviceStepThatCalled: 0,
-    ParamArray: new Array(10).fill(0)
+    nextStepNum: 0,
+    deviceStateThatCalled: 0,
+    deviceStepThatCalled: 0,
+    paramArray: new Array(10).fill(0)
 };

package/package.json

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

package/src/custom-types/BaseDevice/ApiOpcua.ts

@@ -3,31 +3,31 @@ import { DeviceActionRequestData, initialDeviceActionRequestData } from "./Actio
 export interface ApiOpcuaReqData {
   id: number; // likely use timestamp ms after epoch
   checkSum: number;
-  ActionRequestData: DeviceActionRequestData;
-  Sts: number;
+  actionRequestData: DeviceActionRequestData;
+  sts: number;
 }
 
 export const initialApiOpcuaReqData: ApiOpcuaReqData = {
   id: 0,
   checkSum: 0,
-  ActionRequestData: initialDeviceActionRequestData,
-  Sts: 0
+  actionRequestData: initialDeviceActionRequestData,
+  sts: 0
 };
 
 export interface ApiOpcuaData {
-  HmiReq: ApiOpcuaReqData; // read by PLC
-  HmiResp: ApiOpcuaReqData; // written by PLC
-  OrchReq: ApiOpcuaReqData; // read by PLC
-  OrchResp: ApiOpcuaReqData; // written by PLC
-  Req: ApiOpcuaReqData; // written by mtac, read by plc
-  Resp: ApiOpcuaReqData; // written by plc, read by testand
+  hmiReq: ApiOpcuaReqData; // read by PLC
+  hmiResp: ApiOpcuaReqData; // written by PLC
+  orchReq: ApiOpcuaReqData; // read by PLC
+  orchResp: ApiOpcuaReqData; // written by PLC
+  req: ApiOpcuaReqData; // written by mtac, read by plc
+  resp: ApiOpcuaReqData; // written by plc, read by testand
 }
 
 export const initialApiOpcuaData: ApiOpcuaData = {
-  HmiReq: {} as ApiOpcuaReqData,
-  HmiResp: {} as ApiOpcuaReqData,
-  OrchReq: {} as ApiOpcuaReqData,
-  OrchResp: {} as ApiOpcuaReqData,
-  Req: {} as ApiOpcuaReqData,
-  Resp: {} as ApiOpcuaReqData
+  hmiReq: {} as ApiOpcuaReqData,
+  hmiResp: {} as ApiOpcuaReqData,
+  orchReq: {} as ApiOpcuaReqData,
+  orchResp: {} as ApiOpcuaReqData,
+  req: {} as ApiOpcuaReqData,
+  resp: {} as ApiOpcuaReqData
 };

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

@@ -6,26 +6,26 @@ import { ApiOpcuaData, initialApiOpcuaData } from './ApiOpcua';
 
 
 export interface DebugLogData {
-  Msg: string;
-  TimeStamp: Date;
-  Id: number;
+  msg: string;
+  timeStamp: Date;
+  id: number;
 }
 
 export const initialDebugLogData: DebugLogData = {
-  Msg: '',
-  TimeStamp: new Date(),
-  Id: 0
+  msg: '',
+  timeStamp: new Date(),
+  id: 0
 };
 
 
 export interface DeviceLogData {
-  List: DebugLogData[];
-  LastIndex: number; // index of the most recent recorded entries
+  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
+  list: new Array(DeviceConstants.NUM_LOG_ENTRIES).fill(null),
+  lastIndex: 0
 };
 
 
@@ -63,39 +63,39 @@ export const initialDeviceCfg: DeviceCfg = {
 };
 
 export interface FaultData {
-  DeviceId: number;
-  Code: number; // this is deprecated
-  Msg: string;
-  AutoReset: boolean; // if this is true, the code will be reset by the fault monitor
-  ResetFlag: boolean; // used by the fault monitor to know whether to clear an fault or not
-  LogFlag: boolean; // when true, this fault hasn't been logged yet
-  TimeStamp: Date;
-  StepNum: number; // of this device
-  ParentStepNum: number;
+  deviceId: number;
+  code: number; // this is deprecated
+  msg: string;
+  autoReset: boolean; // if this is true, the code will be reset by the fault monitor
+  resetFlag: boolean; // used by the fault monitor to know whether to clear an fault or not
+  logFlag: boolean; // when true, this fault hasn't been logged yet
+  timeStamp: Date;
+  stepNum: number; // of this device
+  parentStepNum: number;
 }
 
 export const initialFaultData: FaultData = {
-  DeviceId: 0,
-  Code: 0,
-  Msg: '',
-  AutoReset: false,
-  ResetFlag: false,
-  LogFlag: false,
-  TimeStamp: new Date(),
-  StepNum: 0,
-  ParentStepNum: 0
+  deviceId: 0,
+  code: 0,
+  msg: '',
+  autoReset: false,
+  resetFlag: false,
+  logFlag: false,
+  timeStamp: new Date(),
+  stepNum: 0,
+  parentStepNum: 0
 };
 
 export interface DeviceFaultData {
-  List: FaultData[]; // Array of fault data
-  Present: boolean; // status
-  ChildrenPresent: boolean; // status that children have errors
+  list: FaultData[]; // Array of fault data
+  present: boolean; // status
+  childrenPresent: boolean; // status that children have errors
 }
 
 export const initialDeviceFaultData: DeviceFaultData = {
-  List: [],
-  Present: false,
-  ChildrenPresent: false
+  list: [],
+  present: false,
+  childrenPresent: false
 };
 
 export interface DeviceStatus {

package/src/custom-types/BaseDevice/Processes.ts

@@ -1,38 +1,38 @@
 export interface ProcessData {
     // THESE PARAMETERS MUST ONLY BE WRITTEN OUTSIDE THIS FB BY method: SendProcessRequest()
-    RequestId: number; // processId that is being requested
-    RequestParamArray: number[]; // passable parameter for the RPC Call (MAX_NUM_PARAMS length)
-    SenderId: number; // use DeviceIds enum
-    
+    requestId: number; // processId that is being requested
+    requestParamArray: number[]; // passable parameter for the RPC Call (MAX_NUM_PARAMS length)
+    senderId: number; // use DeviceIds enum
+
     // THESE PARAMETERS ARE SET INTERNALLY
-    ActiveId: number; // active right now and not already DONE
-    ActiveName: string;
-    LastId: number; // last id to be active (it could have ended successfully or with error)
+    activeId: number; // active right now and not already DONE
+    activeName: string;
+    lastId: number; // last id to be active (it could have ended successfully or with error)
     firstScan: boolean;
     isStepNum: number; // read-only
-    StepDescription: string;
+    stepDescription: string;
     isDone: boolean;
     isError: boolean;
-    NextStepNum: number;
-    DeviceStateThatCalled: number;
-    DeviceStepThatCalled: number; // the step number that called the process, which determines where the process returns to after completion
-    ParamArray: number[]; // passable parameter for the RPC Call (MAX_NUM_PARAMS length)
+    nextStepNum: number;
+    deviceStateThatCalled: number;
+    deviceStepThatCalled: number; // the step number that called the process, which determines where the process returns to after completion
+    paramArray: number[]; // passable parameter for the RPC Call (MAX_NUM_PARAMS length)
 }
 
 export const initialProcessData: ProcessData = {
-    RequestId: 0,
-    RequestParamArray: new Array(10).fill(0),
-    SenderId: 0,
-    ActiveId: 0,
-    ActiveName: '',
-    LastId: 0,
+    requestId: 0,
+    requestParamArray: new Array(10).fill(0),
+    senderId: 0,
+    activeId: 0,
+    activeName: '',
+    lastId: 0,
     firstScan: false,
     isStepNum: 0,
-    StepDescription: '',
+    stepDescription: '',
     isDone: false,
     isError: false,
-    NextStepNum: 0,
-    DeviceStateThatCalled: 0,
-    DeviceStepThatCalled: 0,
-    ParamArray: new Array(10).fill(0)
+    nextStepNum: 0,
+    deviceStateThatCalled: 0,
+    deviceStepThatCalled: 0,
+    paramArray: new Array(10).fill(0)
 };