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

package/src/PinsLogic.ts

@@ -0,0 +1,293 @@
+import { AppModel } from "../generated_module/src/types/AutoModuleTypes";
+import { pin_row, pin_attribs_enum } from "@microchip/pin-standard";
+import { QueryAdapterKey } from "@microchip/pin-standard/lib/pin-standard";
+import { Dictionary } from "@microchip/scf-common/lib/Processor";
+
+// provide complete dynamic data for all pin rows. It overrides static pindata.json
+export const getCompletePinData = (appModel: AppModel): any => {
+    // way to programatically override the json data
+    return {};
+};
+
+// overrides pin data for a particular row based on model.
+export function getRowData(appModel: AppModel, rowData: pin_row): pin_row | undefined {
+    let retRowJSONdata: pin_row | undefined = rowData;
+    const mod = appModel.getHardware()?.getName() ?? "OPA";
+
+    const pinPayload = appModel.getImportValue("pin_standard");
+
+    const allPins = pinPayload?.[QueryAdapterKey.ALLPINS] ?? {};
+    const allPinsData = getInputPinsData(allPins, mod);
+
+    const posPinAttribs = getPinAttribs(allPinsData, "+");
+    const negPinAttribs = getPinAttribs(allPinsData, "-");
+
+    if (/^posPins$/.test(rowData.name)) {
+        if (appModel.getComponentValue("pchOpacon2") === mod + "IN+") {
+            if (appModel.getComponentValue("pssOpacon3") === mod + "IN0+") {
+                retRowJSONdata = {
+                    ...retRowJSONdata,
+                    module: mod,
+                    function: mod + "INx+",
+                    filter: { ...retRowJSONdata.filter, module: mod },
+                    behaviourMeta: { lockPinRegEx: mod + "IN0+" },
+                    attribs: posPinAttribs,
+                };
+            } else if (appModel.getComponentValue("pssOpacon3") === mod + "IN1+") {
+                retRowJSONdata = {
+                    ...retRowJSONdata,
+                    module: mod,
+                    function: mod + "INx+",
+                    filter: { ...retRowJSONdata.filter, module: mod },
+                    behaviourMeta: { lockPinRegEx: mod + "IN1+" },
+                    attribs: posPinAttribs,
+                };
+            } else if (appModel.getComponentValue("pssOpacon3") === mod + "IN2+") {
+                retRowJSONdata = {
+                    ...retRowJSONdata,
+                    module: mod,
+                    function: mod + "INx+",
+                    filter: { ...retRowJSONdata.filter, module: mod },
+                    behaviourMeta: { lockPinRegEx: mod + "IN2+" },
+                    attribs: posPinAttribs,
+                };
+            } else if (appModel.getComponentValue("pssOpacon3") === mod + "IN3+") {
+                retRowJSONdata = {
+                    ...retRowJSONdata,
+                    module: mod,
+                    function: mod + "INx+",
+                    filter: { ...retRowJSONdata.filter, module: mod },
+                    behaviourMeta: { lockPinRegEx: mod + "IN3+" },
+                    attribs: posPinAttribs,
+                };
+            }
+            let rowActions = [];
+            const posSrc = appModel
+                .getAutoModuleAppModel()
+                .getComponent("pssOpacon3")?.component;
+            if (posSrc) {
+                rowActions = rowActions.concat(
+                    appModel
+                        .getPCPHelper?.()
+                        .stateActionBuilder(rowData)
+                        .rowWithName("posPins")
+                        .forComponent(posSrc)
+                        .addIfLockedSetValue(mod + "IN0+", mod + "IN0+")
+                        .addIfLockedSetValue(mod + "IN1+", mod + "IN1+")
+                        .addIfLockedSetValue(mod + "IN2+", mod + "IN2+")
+                        .addIfLockedSetValue(mod + "IN3+", mod + "IN3+")
+                        .build(),
+                );
+            }
+            const neededAttribs: pin_attribs_enum[] = [pin_attribs_enum.cname];
+            const cnameAttribComponent = appModel.getComponent(
+                "cnameAttribforPosPins",
+            )?.component;
+            if (cnameAttribComponent) {
+                rowActions = rowActions.concat(
+                    appModel
+                        .getPCPHelper?.()
+                        .stateActionBuilder(rowData)
+                        .rowWithName("posPins")
+                        .forComponent(cnameAttribComponent)
+                        .addIfLockedProvideAttribs(".*", neededAttribs)
+                        .addIfUnlockedProvideAttribs(".*", neededAttribs)
+                        .build(),
+                );
+            }
+            retRowJSONdata = { ...retRowJSONdata, actions: rowActions };
+        } else {
+            retRowJSONdata = undefined;
+        }
+    } else if (/^negPins$/.test(rowData.name)) {
+        const config = appModel.getComponentValue("customConfig");
+        const negChannel = appModel.getComponentValue("nchOpacon2");
+        if (
+            negChannel === mod + "IN-" ||
+            (config?.indexOf("Programmable Gain Amplifier") !== -1 &&
+                negChannel === "GSEL" &&
+                config !== "Unity Gain Buffer")
+        ) {
+            if (appModel.getComponentValue("nssOpacon1") === mod + "IN0-") {
+                retRowJSONdata = {
+                    ...retRowJSONdata,
+                    module: mod,
+                    function: mod + "INx-",
+                    filter: { ...retRowJSONdata.filter, module: mod },
+                    behaviourMeta: { lockPinRegEx: mod + "IN0-" },
+                    attribs: negPinAttribs,
+                };
+            } else if (appModel.getComponentValue("nssOpacon1") === mod + "IN1-") {
+                retRowJSONdata = {
+                    ...retRowJSONdata,
+                    module: mod,
+                    function: mod + "INx-",
+                    filter: { ...retRowJSONdata.filter, module: mod },
+                    behaviourMeta: { lockPinRegEx: mod + "IN1-" },
+                    attribs: negPinAttribs,
+                };
+            } else if (appModel.getComponentValue("nssOpacon1") === mod + "IN2-") {
+                retRowJSONdata = {
+                    ...retRowJSONdata,
+                    module: mod,
+                    function: mod + "INx-",
+                    filter: { ...retRowJSONdata.filter, module: mod },
+                    behaviourMeta: { lockPinRegEx: mod + "IN2-" },
+                    attribs: negPinAttribs,
+                };
+            } else if (appModel.getComponentValue("nssOpacon1") === mod + "IN3-") {
+                retRowJSONdata = {
+                    ...retRowJSONdata,
+                    module: mod,
+                    function: mod + "INx-",
+                    filter: { ...retRowJSONdata.filter, module: mod },
+                    behaviourMeta: { lockPinRegEx: mod + "IN3-" },
+                    attribs: negPinAttribs,
+                };
+            } else if (appModel.getComponentValue("nssOpacon1") === "Vss") {
+                retRowJSONdata = {
+                    ...retRowJSONdata,
+                    module: mod,
+                    function: mod + "INx-",
+                    filter: { ...retRowJSONdata.filter, module: mod },
+                    behaviourMeta: { lockPinRegEx: "^.{0}$" },
+                };
+            }
+            let rowActions = [];
+            const negSrc = appModel
+                .getAutoModuleAppModel()
+                .getComponent("nssOpacon1")?.component;
+            if (negSrc) {
+                rowActions = rowActions.concat(
+                    appModel
+                        .getPCPHelper?.()
+                        .stateActionBuilder(rowData)
+                        .rowWithName("negPins")
+                        .forComponent(negSrc)
+                        .addIfLockedSetValue(mod + "IN0-", mod + "IN0-")
+                        .addIfLockedSetValue(mod + "IN1-", mod + "IN1-")
+                        .addIfLockedSetValue(mod + "IN2-", mod + "IN2-")
+                        .addIfLockedSetValue(mod + "IN3-", mod + "IN3-")
+                        .addIfUnLockedSetValue(".*", "Vss")
+                        .build(),
+                );
+            }
+            const neededAttribs: pin_attribs_enum[] = [pin_attribs_enum.cname];
+            const cnameAttribComponent = appModel.getComponent(
+                "cnameAttribforNegPins",
+            )?.component;
+            if (cnameAttribComponent) {
+                rowActions = rowActions.concat(
+                    appModel
+                        .getPCPHelper?.()
+                        .stateActionBuilder(rowData)
+                        .rowWithName("negPins")
+                        .forComponent(cnameAttribComponent)
+                        .addIfLockedProvideAttribs(".*", neededAttribs)
+                        .addIfUnlockedProvideAttribs(".*", neededAttribs)
+                        .build(),
+                );
+            }
+            retRowJSONdata = { ...retRowJSONdata, actions: rowActions };
+        } else {
+            retRowJSONdata = undefined;
+        }
+    } else if (/^outputPin$/.test(rowData.name)) {
+        if (!appModel.isComponentValue("intoeOpacon3")) {
+            retRowJSONdata = {
+                ...retRowJSONdata,
+                module: mod,
+                function: mod + "OUT",
+                filter: { ...retRowJSONdata.filter, module: mod },
+                behaviourMeta: { lockPinRegEx: mod + "OUT" },
+            };
+            retRowJSONdata = { ...retRowJSONdata };
+        } else {
+            retRowJSONdata = undefined;
+        }
+    } else if (/^ppsPin$/.test(rowData.name)) {
+        if (appModel.getComponentValue("orsOpaors") === "OPAxORPPS") {
+            retRowJSONdata = {
+                ...retRowJSONdata,
+                module: mod,
+                function: mod + "ORPPS",
+                filter: { ...retRowJSONdata.filter, module: mod },
+            };
+            retRowJSONdata = { ...retRowJSONdata };
+        } else {
+            retRowJSONdata = undefined;
+        }
+    }
+    return retRowJSONdata;
+}
+
+export interface AllPinsData {
+    [pinName: string]: {
+        [module: string]: {
+            [key: string]: {
+                alias: string;
+            };
+        };
+    };
+}
+
+export interface PinData {
+    funcName: string;
+    customName: string;
+    pinName: string;
+}
+
+export interface PinAttribs {
+    aliasReEx: string;
+    cname: string;
+}
+
+export const getInputPinsData = (
+    allPins: AllPinsData,
+    moduleName: string,
+): Dictionary<PinData> => {
+    return getPinsData(allPins, /OPA\d(IN\d)(\D)/, moduleName);
+};
+
+export const getPinsData = (
+    allPins: AllPinsData,
+    aliasRegex: RegExp,
+    modName: string,
+): Dictionary<PinData> => {
+    const pinData: Dictionary<PinData> = {};
+    Object.keys(allPins).forEach((pinName) => {
+        const pins = allPins[pinName];
+        const modPins = pins[modName];
+        if (modPins) {
+            Object.keys(modPins).forEach((key) => {
+                const opaPins = modPins[key].alias.match(aliasRegex);
+                if (opaPins) {
+                    const customName = pinName + "_" + opaPins[1];
+                    const funcName = opaPins[0];
+                    pinData[funcName] = {
+                        funcName,
+                        customName,
+                        pinName,
+                    };
+                }
+            });
+        }
+    });
+    return pinData;
+};
+
+export const getPinAttribs = (
+    allPins: Dictionary<PinData>,
+    pinPolarity: string,
+): PinAttribs[] => {
+    const pinAttribArr: PinAttribs[] = [];
+    Object.keys(allPins)
+        .filter((key) => key.endsWith(pinPolarity))
+        .forEach((key) => {
+            pinAttribArr.push({
+                aliasReEx: allPins[key].funcName,
+                cname: allPins[key].customName,
+            });
+        });
+    return pinAttribArr;
+};

package/src/catalog.json

@@ -0,0 +1,24 @@
+{
+    "name": "@mchp-mcc/local-catalog",
+    "version": "1.0.0",
+    "content": [
+        {
+            "name": "@mchp-mcc/scf-pic8-opamp-v2",
+            "version": "*",
+            "meta": {
+                "keywords": [
+                    "pic8",
+                    "opamp"
+                ],
+                "name": "OPA",
+                "category": "Drivers/OPAMP",
+                "description": "The Operational Amplifier (OPA) module features programmable gain options, adjustable input offset voltage and hardware override control capabilities.",
+                "deviceFilterRegEx": "^PIC18F.*Q71$",
+                "defaultSelection": true,
+                "releaseNotesLink": "https://onlinedocs.microchip.com/v2/keyword-lookup?keyword=MCC.MELODY.8BITPIC.RELEASENOTES&version=latest&redirect=true"
+            }
+        }
+        
+    ],
+    "catalogs": []
+}