@mchp-mcc/scf-pic8-opamp-v2 1.0.0

package/src/opa-output-parameters.tsx

@@ -0,0 +1,95 @@
+import { InterfaceId } from "@microchip/scf-common/lib/InterfaceId";
+import * as Creator from "@microchip/scf-common/lib/Creator";
+import * as Processor from "@microchip/scf-common/lib/Processor";
+import * as InterfaceTypes from "@microchip/scf-interface";
+
+/** The arguments to be provided to the implementation. */
+export interface Arguments extends InterfaceTypes.Arguments {
+    //Standard Interface
+    customName?: string;
+    enableOpa?: boolean;
+}
+
+/** The payload to be passed back to the dependent module after the BasicUART has been processed. */
+export interface ProcessedPayload extends InterfaceTypes.ProcessedPayload {
+    //Standard Interface
+    moduleName?: string;
+    customName?: string;
+
+    //Interrupt Handling Extension
+    hasInterrupts?: boolean;
+}
+
+export interface API extends InterfaceTypes.CFunctions {
+    Initialize: InterfaceTypes.CFunction;
+    EnableChargePump: InterfaceTypes.CFunction;
+    DisableChargePump: InterfaceTypes.CFunction;
+    EnableSoftwareUnityGain: InterfaceTypes.CFunction;
+    DisableSoftwareUnityGain: InterfaceTypes.CFunction;
+    SetPositiveChannel: InterfaceTypes.CFunction;
+    SetPositiveSource: InterfaceTypes.CFunction;
+    SetNegativeChannel: InterfaceTypes.CFunction;
+    SetNegativeSource: InterfaceTypes.CFunction;
+    SetResistorLadder: InterfaceTypes.CFunction;
+    EnableHardwareOverride: InterfaceTypes.CFunction;
+    SetHardwareOverrideSource: InterfaceTypes.CFunction;
+    DisableHardwareOverride: InterfaceTypes.CFunction;
+    SetSoftwareOverride: InterfaceTypes.CFunction;
+    ManualInputOffsetCalibration: InterfaceTypes.CFunction;
+}
+
+/** The type of the processed export interface */
+export type ProcessedExportInterface = Processor.ProcessedInterface<
+    ProcessedPayload,
+    Arguments
+>;
+
+/** Used by implementations of this interface in their module's creator. */
+type CreatorExportInterface = Creator.Interface<ProcessedPayload>;
+
+const getInterfaceId = (): InterfaceId => {
+    return {
+        name: "opamp-output-parameters",
+        version: "1.0.0",
+    };
+};
+
+const createPrototypeImport = (): Creator.Import => {
+    return {
+        interfaceId: getInterfaceId(),
+    };
+};
+
+const createPrototypeExport = (): Creator.Export<CreatorExportInterface[]> => {
+    return {
+        interfaces: [{ interfaceId: getInterfaceId() }],
+    };
+};
+
+const createMock = (): ProcessedExportInterface => {
+    return {
+        interfaceId: getInterfaceId(),
+        payload: {
+            moduleName: "OPA",
+            customName: "OPA",
+        },
+        args: {
+            requestId: {
+                customName: "OPA",
+                enableOpa: true,
+            },
+        },
+    };
+};
+
+interface Interface extends InterfaceTypes.Interface {
+    createPrototypeImport: () => Creator.Import<Arguments>;
+    createMock: () => ProcessedExportInterface;
+}
+
+export const Interface: Interface = {
+    createPrototypeExport: createPrototypeExport,
+    createPrototypeImport: createPrototypeImport,
+    getInterfaceId: getInterfaceId,
+    createMock: createMock,
+};

package/src/pinsdata.json

@@ -0,0 +1,81 @@
+{
+    "rows": [
+    {
+        "name" : "posPins",
+        "module": "OPA1",
+        "function": "OPA1INx+",
+        "direction": "input",
+        "filter": {
+            "module": "OPA1",
+            "aliasReEx": "^OPA\\dIN\\d\\+$"
+        },
+        "behaviour": "SINGLE_PIN_MUX",
+        "behaviourMeta":{
+            "lockPinRegEx":"OPA1IN0+"
+        },
+        "attribs": [
+            {
+                "aliasReEx": "^OPA\\dIN\\d\\+$",
+                "analog": true,
+                "cname": "IN"
+            }
+        
+        ]
+    },
+    {
+        "name" : "negPins",
+        "module": "OPA1",
+        "function": "OPA1INx-",
+        "direction": "input",
+        "filter": {
+            "module": "OPA1",
+            "aliasReEx": "^OPA\\dIN\\d-$"
+        },
+        "behaviour": "OPTIONAL_PIN_MUX",
+        "behaviourMeta":{
+            "lockPinRegEx":"OPA1IN0-"
+        },
+        "attribs": [
+            {
+                "aliasReEx": "^OPA\\dIN\\d\\-$",
+                "analog": true,
+                "cname": "IN"
+            }
+        ]
+    },
+    {
+        "name" : "outputPin",
+        "module": "OPA1",
+        "function": "OPA1OUT",
+        "direction": "output",
+        "filter": {
+            "module": "OPA1",
+            "aliasReEx": "^OPA\\dOUT$"
+        },
+        "behaviour": "ALWAYS_LOCKED",
+        "attribs": [
+            {
+                "aliasReEx": ".*",
+                "analog": true
+            }
+        ]
+    },
+    {
+        "name" : "ppsPin",
+        "module": "OPA1",
+        "function": "OPA1ORPPS",
+        "direction": "input",
+        "filter": {
+            "module": "OPA1",
+            "aliasReEx": "^OPA\\dOR$"
+        },
+        "behaviour": "PPS",
+        "attribs": [
+            {
+                "aliasReEx": ".*",
+                "analog": true
+            }
+        ]
+    }
+    ]
+}

package/src/reducer.test.ts

@@ -0,0 +1,177 @@
+import { State } from "../generated_module/src/types/State";
+import { reduce, setDefaultConfigValues } from "./reducer";
+
+describe("reduce() for Default Values", () => {
+    it("Change in Op Amp Configuration ", () => {
+        const state: State = {
+            main: {
+                hardware: {
+                    customConfig: "Direct Connection to Pins",
+                },
+            },
+        };
+        const action = {
+            type: "[FORM] SUBMIT",
+            payload: {
+                tabId: "main",
+                path: "hardware.customConfig",
+                value: "Unity Gain Buffer",
+            },
+        };
+        const nextState: State = {
+            main: {
+                hardware: {
+                    customConfig: "Unity Gain Buffer",
+                },
+            },
+        };
+        expect(reduce(state, action)).toStrictEqual(nextState);
+    });
+
+    it("Overriding UI edits for required components", () => {
+        const state: State = {
+            main: {
+                hardware: {
+                    customConfig: "Non-Inverting Programmable Gain Amplifier",
+                },
+                channelSel: {
+                    pchOpacon2: "DAC1_OUT",
+                    nchOpacon2: "OPA1IN-",
+                },
+                feedbackSel: {
+                    gselOpacon1: "R1 = 1R and R2 = 15R, R2/R1 = 15",
+                    fmsOpacon3: "Vdd",
+                },
+            },
+        };
+        const action = {
+            type: "[FORM] SUBMIT",
+            payload: {
+                tabId: "main",
+                path: "hardware.customConfig",
+                value: "Inverting Programmable Gain Amplifier",
+            },
+        };
+        const nextState: State = {
+            main: {
+                hardware: {
+                    customConfig: "Inverting Programmable Gain Amplifier",
+                },
+            },
+        };
+        expect(reduce(state, action)).toStrictEqual(nextState);
+    });
+
+    it("Retaining UI edits for Configuration independent components", () => {
+        const state: State = {
+            main: {
+                hardware: {
+                    customConfig: "Inverting Programmable Gain Amplifier",
+                },
+                channelSel: {
+                    pssOpacon3: "GSEL",
+                    nssOpacon1: "Vss",
+                },
+                feedbackSel: {
+                    gselOpacon1: "R1 = 1R and R2 = 15R, R2/R1 = 15",
+                    fmsOpacon3: "No Connection",
+                },
+                overrideSel: {
+                    orenOpahwc: true,
+                    hwchOpahwc: "Rail Drive to Vdd",
+                },
+            },
+        };
+        const action = {
+            type: "[FORM] SUBMIT",
+            payload: {
+                tabId: "main",
+                path: "hardware.customConfig",
+                value: "Direct Connection to Pins",
+            },
+        };
+        const nextState: State = {
+            main: {
+                hardware: {
+                    customConfig: "Direct Connection to Pins",
+                },
+                overrideSel: {
+                    orenOpahwc: true,
+                    hwchOpahwc: "Rail Drive to Vdd",
+                },
+            },
+        };
+        expect(reduce(state, action)).toStrictEqual(nextState);
+    });
+
+    it("Test for default switch case", () => {
+        const state: State = {
+            main: {
+                hardware: {
+                    customConfig: "Direct Connection to Pins",
+                },
+            },
+        };
+        const action = {
+            type: "",
+            payload: {
+                tabId: "main",
+                path: "hardware.customConfig",
+                value: "Unity Gain Buffer",
+            },
+        };
+        const nextState: State = {
+            main: {
+                hardware: {
+                    customConfig: "Direct Connection to Pins",
+                },
+            },
+        };
+        expect(reduce(state, action)).toStrictEqual(nextState);
+    });
+
+    it("Test for boolean component", () => {
+        const state: State = {
+            main: {
+                hardware: {
+                    cponOpacon0: true,
+                },
+            },
+        };
+        const action = {
+            type: "[FORM] SUBMIT",
+            payload: {
+                tabId: "main",
+                path: "hardware.cponOpacon0",
+                value: false,
+            },
+        };
+        const nextState: State = {
+            main: {
+                hardware: {
+                    cponOpacon0: false,
+                },
+            },
+        };
+        expect(reduce(state, action)).toStrictEqual(nextState);
+    });
+
+    it("Test for undefined main", () => {
+        const state: State = {
+            main: undefined,
+        };
+        const action = {
+            type: "[FORM] SUBMIT",
+            payload: {
+                tabId: "main",
+                path: "hardware.customConfig",
+                value: "Unity Gain Buffer",
+            },
+        };
+
+        const nextState: State = {
+            main: undefined,
+        };
+        expect(setDefaultConfigValues(state, action.payload)).toStrictEqual(nextState);
+    });
+});

package/src/reducer.ts

@@ -0,0 +1,29 @@
+import * as Auto from "@microchip/scf-autoview-impl/src/lib/reducer/reducer";
+import { Actions } from "@microchip/scf-autoview/lib/simpleForm/actions";
+import { Action } from "@microchip/scf-common";
+import { State } from "../generated_module/src/types/State";
+import { FormActionPayload } from "@microchip/scf-autoview/lib/simpleForm/action-types/actionTypes";
+
+export const reduce = (state: State, action: Action<any, any>): State => {
+    switch (action.type) {
+        case Actions.SUBMIT_FORM:
+            return opampReduce(Auto.reduce(state, action), action);
+        default:
+            return state;
+    }
+};
+
+export const opampReduce = (state: State, action: Action<any, any>): State => {
+    return setDefaultConfigValues(state, action.payload);
+};
+
+export const setDefaultConfigValues = (
+    state: State,
+    payload: FormActionPayload,
+): State => {
+    if (payload.path.endsWith(".customConfig")) {
+        delete state.main?.["channelSel"];
+        delete state.main?.["feedbackSel"];
+    }
+    return state;
+};