@mchp-mcc/scf-pic8-pwm-v2 4.2.8 → 4.2.10

package/src/PwmCalculator.tsx

@@ -1,67 +0,0 @@
-// Reused from Q43 CCP calculator
-// TODO: delete this duplicate and add CCP calculator dependency
-import log10 from "core-js/features/math/log10";
-
-export class PwmCalculator {
-    private prValue: number;
-    private prescaler: number;
-    private fosc: number;
-    private dutyCycleRatio: number;
-
-    constructor(prValue: number, prescaler: number, fosc: number, dutyCycle: number) {
-        this.prValue = prValue;
-        this.prescaler = prescaler;
-        this.fosc = fosc;
-        this.dutyCycleRatio = dutyCycle / 100;
-    }
-
-    public getPwmPeriod = (): number => {
-        let pwmPeriod = (this.prValue + 1) * 4 * this.prescaler;
-        if (this.fosc > 0) {
-            pwmPeriod = pwmPeriod / this.fosc;
-        } else {
-            pwmPeriod = 0;
-        }
-        return pwmPeriod;
-    };
-
-    public getPwmFrequency = (): number => {
-        let pwmFrequency = (this.prValue + 1) * 4 * this.prescaler;
-        if (pwmFrequency > 0) {
-            pwmFrequency = this.fosc / pwmFrequency;
-        } else {
-            pwmFrequency = 0;
-        }
-
-        pwmFrequency = Math.round(pwmFrequency * 100) / 100;
-        return pwmFrequency;
-    };
-
-    public getPwmResolution = (): number => {
-        const pwmResolution = log10(4 * (this.prValue + 1)) / log10(2);
-        return Math.floor(pwmResolution);
-    };
-
-    public getCCPRValue = (): number => {
-        const ccprValue = Math.round(this.dutyCycleRatio * 4 * (this.prValue + 1) - 1);
-        if (ccprValue < 0) {
-            return 0;
-        }
-        return ccprValue;
-    };
-
-    public getActualDutyCycle = (): number => {
-        const dcRatio = this.getCCPRValue() / (4 * (this.prValue + 1));
-        return Math.round(dcRatio * 100);
-    };
-
-    public getActualPulseWidth = (): number => {
-        let pulseWidth = this.getCCPRValue() * this.prescaler;
-        if (this.fosc > 0) {
-            pulseWidth = pulseWidth / this.fosc;
-        } else {
-            pulseWidth = 0;
-        }
-        return pulseWidth;
-    };
-}

package/src/catalog.json

@@ -1,23 +0,0 @@
-{
-    "name": "@mchp-mcc/local-catalog",
-    "version": "1.0.0",
-    "content": [
-        {
-            "name": "@mchp-mcc/scf-pic8-pwm-v2",
-                "version": "*",
-                "meta": {
-                    "keywords": [
-                        "pic8",
-                        "pwm"
-                    ],
-                    "defaultSelection": "defaultRequired",
-                    "name": "PWM",
-                    "category": "Drivers/PWM",
-                    "description": "This module is a 16-bit Pulse-Width Modulator (PWM) with a compare feature and multiple outputs.",
-                    "deviceFilterRegEx": ".*",
-                    "releaseNotesLink": "https://onlinedocs.microchip.com/v2/keyword-lookup?keyword=MCC.MELODY.8BITPIC.RELEASENOTES&version=latest&redirect=true"
-                }
-        }
-    ],
-    "catalogs": []
-}

package/src/interfaces/pwm_general_parameters.test.tsx

@@ -1,40 +0,0 @@
-import { ProcessedExportInterface, Interface } from "./pwm_general_parameters";
-
-describe("The pwm_general_parameters interface", () => {
-    it("doesn't explode", () => {
-        expect(Interface.getInterfaceId()).toBeDefined();
-        expect(Interface.createPrototypeImport()).toBeDefined();
-        expect(Interface.createPrototypeExport()).toBeDefined();
-        expect(
-            Interface.createFirmwareApi("MyModule", [
-                { name: "mymodule.h", path: "include/" },
-            ]),
-        ).toBeDefined();
-        expect(Interface.createMock()).toBeDefined();
-    });
-
-    it("Checks Interface ID", () => {
-        expect(Interface.getInterfaceId().name).toBe("pwm_general_parameters");
-        expect(Interface.getInterfaceId().version).toBe("0.1.0");
-    });
-
-    it("Create's api with name, headers, or custom API undefined", () => {
-        expect(Interface.createFirmwareApi("", [{ name: "", path: "" }])).toBeDefined();
-    });
-});
-
-export const createMock = (): ProcessedExportInterface => {
-    return {
-        interfaceId: Interface.getInterfaceId(),
-        payload: {
-            interfaceApi: Interface.createFirmwareApi("MyModule", [
-                { name: "mymodule.h", path: "include/" },
-            ]),
-        },
-        args: {
-            requestId: {
-                customName: "MyModule",
-            },
-        },
-    };
-};

package/src/interfaces/pwm_general_parameters.tsx

@@ -1,121 +0,0 @@
-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;
-}
-
-/** The payload to be passed back to the dependent module after the BasicUART has been processed. */
-export interface ProcessedPayload extends InterfaceTypes.ProcessedPayload {
-    //Standard Interface
-    interfaceApi: InterfaceTypes.FirmwareAPIPayload<API>;
-    customName?: string;
-    modulename?: string;
-    isdriverisr?: boolean;
-    ispwmi_enabled?: boolean;
-    ispwmpi_enabled?: boolean;
-    moduleName?: string;
-}
-
-export interface API extends InterfaceTypes.CFunctions {
-    Initialize: InterfaceTypes.CFunction;
-    LoadDutyValue: 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: "pwm_general_parameters",
-        version: "0.1.0",
-    };
-};
-
-const createPrototypeImport = (): Creator.Import => {
-    return {
-        interfaceId: getInterfaceId(),
-    };
-};
-
-const createPrototypeExport = (): Creator.Export<CreatorExportInterface[]> => {
-    return {
-        interfaces: [{ interfaceId: getInterfaceId() }],
-    };
-};
-
-const createMock = (): ProcessedExportInterface => {
-    return {
-        interfaceId: getInterfaceId(),
-        payload: {
-            interfaceApi: Interface.createFirmwareApi("MyModule", [
-                { name: "mymodule.h", path: "include/" },
-            ]),
-        },
-        args: {
-            requestId: {
-                customName: "MyModule",
-            },
-        },
-    };
-};
-
-const createFirmwareApi = (
-    moduleName: string,
-    headerFiles: InterfaceTypes.HeaderFile[],
-): InterfaceTypes.FirmwareAPIPayload<API> => {
-    const prefix: string = moduleName ? moduleName : "undefined";
-    const api = createApi(prefix);
-
-    return {
-        api: api,
-        simpleApi: InterfaceTypes.buildSimpleApi(api),
-        headerFiles: headerFiles,
-    };
-};
-
-const createApi = (prefix: string): API => {
-    return {
-        Initialize: {
-            name: prefix + "_Initialize",
-            returns: "void",
-        },
-        LoadDutyValue: {
-            name: prefix + "_LoadDutyValue",
-            arguments: [
-                {
-                    name: "dutyValue",
-                    type: "uint16_t",
-                },
-            ],
-            returns: "void",
-        },
-    };
-};
-
-interface Interface extends InterfaceTypes.Interface {
-    createPrototypeImport: () => Creator.Import<Arguments>;
-    createMock: () => ProcessedExportInterface;
-    createFirmwareApi: (
-        moduleName: string,
-        headerFiles: InterfaceTypes.HeaderFile[],
-    ) => InterfaceTypes.FirmwareAPIPayload<API>;
-}
-
-export const Interface: Interface = {
-    createPrototypeExport: createPrototypeExport,
-    createPrototypeImport: createPrototypeImport,
-    getInterfaceId: getInterfaceId,
-    createMock: createMock,
-    createFirmwareApi: createFirmwareApi,
-};

package/src/moduleConfig.json

@@ -1,371 +0,0 @@
-{
-    "moduleName": "PWM",
-    "deviceType": "PIC",
-    "booleanValues": {
-        "true": "enabled",
-        "false": "disabled"
-    },
-    "UIGroups": {
-        "software": "Software Settings",
-        "hardware": "Hardware Settings"
-    },
-    "UIOrder": {
-        "software": [
-            "*"
-        ],
-        "hardware": [
-            "pwmenPwmcon",
-            "timerSelection",
-            "dutyCycle",
-            "pwmdcValue",
-            "pwmpolPwmcon",
-            "pwmPeriod",
-            "pwmFrequency",
-            "pwmResolution",
-            "*"
-        ]
-    },
-    "hasPins": true,
-    "tabs": {
-        "main": "Easy View",
-        "register": "Register Initialization"
-    },
-    "help": {
-        "url": "v2/keyword-lookup?keyword=scf-pic8-pwm-v2&redirect=true",
-        "tooltip": "Click here to open documentation."
-    },
-    "analytics": {
-        "logAlwaysComps": [
-            "pwmenPwmcon",
-            "pwmFrequency",
-            "pwmResolution"
-        ],
-        "logOnChangeComps": [],
-        "compMapping": {
-            "pwmenPwmcon": "PWM_Enable",
-            "pwmFrequency": "PWM_Frequency",
-            "pwmResolution": "PWM_Resolution"
-        }
-    },
-    "templates": [
-        {
-            "src": "output/pwm-v2.c.ftl",
-            "dest": "pwm/src/${sourceFileName}",
-            "generateWithHardware": true
-        },
-        {
-            "src": "output/pwm-v2.h.ftl",
-            "dest": "pwm/${headerFileName}",
-            "generateWithHardware": true
-        }
-    ],
-    "imports": {
-        "initializer_system": {
-            "nodeModule": {
-                "importName": "systemInit",
-                "node": "@microchip/initializer-system"
-            },
-            "import": {
-                "interfaceId": {
-                    "name": "initializer-system",
-                    "version": "^0.5.3"
-                }
-            }
-        },
-        "scf_pic8_pwm_v2": {
-            "import": {
-                "interfaceId": {
-                    "name": "scf-pic8-pwm-v2",
-                    "version": "1.0.0"
-                },
-                "isRequired": true
-            }
-        },
-        "osc_clocks": {
-            "import": {
-                "interfaceId": {
-                    "name": "osc-clocks",
-                    "version": "^0.2.0"
-                }
-            }
-        },
-        "Timer": {
-            "import": {
-                "interfaceId": {
-                    "name": "timer-2-4-6-general-parameters",
-                    "version": "^0.2.0"
-                }
-            }
-        },
-        "pin_standard": {
-            "import": {
-                "interfaceId": {
-                    "name": "pin-standard",
-                    "version": "^0.1.0"
-                }
-            }
-        },
-        "device_meta": {
-            "import": {
-                "interfaceId": {
-                    "name": "device-meta",
-                    "version": "^1"
-                }
-            }
-        }
-    },
-    "exports": {
-        "pwm_general": {
-            "interfaces": [
-                {
-                    "interfaceId": {
-                        "name": "pwm_general_parameters",
-                        "version": "0.1.0"
-                    }
-                }
-            ]
-        }
-    },
-    "softwareData": {
-        "componentName": {
-            "name": "componentName",
-            "description": "Custom Name",
-            "type": "string",
-            "defaultValue": "PWM",
-            "group": "software",
-            "tabs": [
-                "main"
-            ],
-            "category": "software",
-            "validation": true
-        },
-        "tmr2Dependency": {
-            "name": "tmr2Dependency",
-            "description": "Timer Dependency Selector",
-            "category": "import",
-            "type": "ComboBox",
-            "group": "software",
-            "tabs": [
-                "main"
-            ],
-            "importId": "Timer"
-        },
-        "timerSelection": {
-            "name": "timerSelection",
-            "description": "Select a Timer",
-            "type": "ComboBox",
-            "group": "hardware",
-            "defaultValue": {
-                "value": "TMR2",
-                "options": [
-                    "TMR2",
-                    "TMR4",
-                    "TMR6"
-                ]
-            },
-            "tabs": [
-                "main"
-            ],
-            "category": "software",
-            "sdlHelp": {
-                "tooltip": "Click for more Information",
-                "url": "v2/keyword-lookup?keyword=atmel;device:${deviceName};register:${registerName}&redirect=true"
-            }
-        },
-        "dutyCycle": {
-            "name": "dutyCycle",
-            "description": "Duty Cycle (%)",
-            "type": "number",
-            "defaultValue": 50,
-            "group": "hardware",
-            "validation": true,
-            "tabs": [
-                "main"
-            ],
-            "category": "software",
-            "sdlHelp": {
-                "tooltip": "Click for more Information",
-                "url": "v2/keyword-lookup?keyword=atmel;device:${deviceName};register:${instance}DC&redirect=true"
-            }
-        },
-        "pwmdcValue": {
-            "name": "pwmdcValue",
-            "description": "PWMDC Value",
-            "type": "number",
-            "defaultValue": 0,
-            "group": "hardware",
-            "uiBehavior": {
-                "readonly": true
-            },
-            "tabs": [
-                "main"
-            ],
-            "category": "software",
-            "sdlHelp": {
-                "tooltip": "Click for more Information",
-                "url": "v2/keyword-lookup?keyword=atmel;device:${deviceName};register:${instance}DC&redirect=true"
-            }
-        },
-        "pwmPeriod": {
-            "name": "pwmPeriod",
-            "description": "PWM Period (s)",
-            "type": "number",
-            "defaultValue": 0,
-            "group": "hardware",
-            "uiBehavior": {
-                "readonly": true
-            },
-            "tabs": [
-                "main"
-            ],
-            "category": "software"
-        },
-        "pwmFrequency": {
-            "name": "pwmFrequency",
-            "description": "PWM Frequency (Hz)",
-            "type": "number",
-            "defaultValue": 0,
-            "group": "hardware",
-            "uiBehavior": {
-                "readonly": true
-            },
-            "tabs": [
-                "main"
-            ],
-            "category": "software"
-        },
-        "pwmResolution": {
-            "name": "pwmResolution",
-            "description": "PWM Resolution (bits)",
-            "type": "number",
-            "defaultValue": 0,
-            "group": "hardware",
-            "uiBehavior": {
-                "readonly": true
-            },
-            "tabs": [
-                "main"
-            ],
-            "category": "software"
-        }
-    },
-    "peripherals": [
-        {
-            "interfaceId": {
-                "name": "scf-pic8-pwm-v2",
-                "version": "1.0.0"
-            },
-            "registers": {
-                "PWMTMRS": [
-                    {
-                        "setting": "CTSEL",
-                        "name": "ctselPwmtmrs",
-                        "category": "hardware",
-                        "description": "Insert Description Here",
-                        "type": "ComboBox",
-                        "group": "hardware",
-                        "tabs": [
-                            "register"
-                        ]
-                    }
-                ],
-                "CCPTMRS1": [
-                    {
-                        "setting": "CTSEL",
-                        "name": "ctselCcptmrs1",
-                        "description": "Insert Description Here",
-                        "type": "ComboBox",
-                        "group": "hardware",
-                        "tabs": [
-                            "register"
-                        ],
-                        "category": "hardware"
-                    }
-                ],
-                "CCPTMRS": [
-                    {
-                        "setting": "CTSEL",
-                        "name": "ctselCcptmrs",
-                        "category": "hardware",
-                        "description": "Insert Description Here",
-                        "type": "ComboBox",
-                        "group": "hardware",
-                        "tabs": [
-                            "register"
-                        ]
-                    }
-                ],
-                "PWMCON": [
-                    {
-                        "setting": "PWMPOL",
-                        "name": "pwmpolPwmcon",
-                        "description": "PWM Polarity",
-                        "type": "ComboBox",
-                        "group": "hardware",
-                        "tabs": [
-                            "main"
-                        ],
-                        "category": "hardware",
-                        "sdlHelp": {
-                            "tooltip": "Click for more Information",
-                            "url": "v2/keyword-lookup?keyword=atmel;device:${deviceName};register:${registerName}&redirect=true"
-                        }
-                    },
-                    {
-                        "setting": "PWMOUT",
-                        "name": "pwmoutPwmcon",
-                        "description": "Insert Description Here",
-                        "type": "boolean",
-                        "group": "hardware",
-                        "tabs": [
-                            "register"
-                        ],
-                        "category": "hardware"
-                    },
-                    {
-                        "setting": "PWMEN",
-                        "name": "pwmenPwmcon",
-                        "description": "PWM Enable",
-                        "type": "boolean",
-                        "group": "hardware",
-                        "overrideDefaultValue": "enabled",
-                        "tabs": [
-                            "main"
-                        ],
-                        "category": "hardware",
-                        "sdlHelp": {
-                            "tooltip": "Click for more Information",
-                            "url": "v2/keyword-lookup?keyword=atmel;device:${deviceName};register:${registerName}&redirect=true"
-                        }
-                    }
-                ],
-                "PWMDCH": [
-                    {
-                        "setting": "PWMDCH",
-                        "name": "pwmdchPwmdch",
-                        "description": "Insert Description Here",
-                        "type": "string",
-                        "group": "hardware",
-                        "tabs": [
-                            "register"
-                        ],
-                        "category": "hardware"
-                    }
-                ],
-                "PWMDCL": [
-                    {
-                        "setting": "PWMDCL",
-                        "name": "pwmdclPwmdcl",
-                        "description": "Insert Description Here",
-                        "type": "string",
-                        "group": "hardware",
-                        "tabs": [
-                            "register"
-                        ],
-                        "category": "hardware"
-                    }
-                ]
-            }
-        }
-    ]
-}

package/src/pinlogic.json

@@ -1,20 +0,0 @@
-{
-    "key":"pinmodekey",
-    "pindata": [
-        {
-            "value": "normal",
-            "rows": [
-                {
-                    "name": "myPin",
-                    "pinRegEx": "",
-                    "direction": "output",
-                    "type": "digital",
-                    "interfaceId": {
-                        "name": "basic-pin",
-                        "version": "0.1.0"
-                    }
-                }
-            ]
-        }
-    ]
-}

package/src/pinsdata.json

@@ -1,15 +0,0 @@
-{
-    "rows": [
-        {
-            "name": "out",
-            "module": "PWM6",
-            "function": "PWM6(OUT|$)",
-            "direction": "output",
-            "filter": {
-                "module": "PWM6",
-                "aliasReEx": "^PWM6OUT$|PWM6$"
-            },
-            "behaviour": "PPS"
-        }
-    ]
-}