@mchp-mcc/timer-timeout-driver - npm Package Compare versions

Comparing version 3.0.6 to 3.0.7

package.json

 {
     "name": "@mchp-mcc/timer-timeout-driver",
-    "version": "3.0.6",
+    "version": "3.0.7",
     "scf": {
@@ -42,4 +42,4 @@ "reducer": "auto",
         "release": "yarn build && yarn test && node -e 'require(\"./config/scf-project-scripts\").releaseProject()'",
-        "test:itf:all": "node ./node_modules/@mchp-mcc/ccl-itf/lib/index.js --sp=./tests --rd=./run",
-        "test:itf:dev": "node ./node_modules/@mchp-mcc/ccl-itf/lib/index.js --sp=./tests --rd=./run --sf=timeout.major.test.ts --df=PIC18F47Q43"
+        "test:itf:all": "node ./node_modules/@mchp-mcc/ccl-itf/lib/index.js --sp=./tests --rd=./run --sf=timeout.major.test.ts --df=\"PIC16F18854|PIC16F18877|PIC18F25Q43|PIC18F57Q43|PIC18F04Q40|PIC18F16Q40|PIC18F04Q41|PIC18F16Q41|PIC18F24Q10|PIC18F47Q10\"",
+        "test:itf:dev": "node ./node_modules/@mchp-mcc/ccl-itf/lib/index.js --sp=./tests --rd=./run --sf=timeout.major.test.ts --df=\"AVR128DB48|PIC18F47Q43\""
     },
@@ -61,5 +61,2 @@ "husky": {
     ],
-    "publishConfig": {
-        "registry": "https://artifacts.microchip.com/artifactory/api/npm/npm/"
-    },
     "jest": {
@@ -78,4 +75,13 @@ "testPathIgnorePatterns": [
         "preset": "ts-jest",
-        "collectCoverage": true
+        "collectCoverage": true,
+        "coverageThreshold": {
+            "./src": {
+                "branches": 80,
+                "functions": 80,
+                "lines": 80,
+                "statements": 80
+            }
+        }
     },
+    "jenkinsPipeline": "MCU8_DS_PIPELINE_1XY",
     "dependencies": {
@@ -90,4 +96,4 @@ "@mchp-mcc/avr-8bit": "^4.2.0",
         "@microchip/pin-standard": "^0.2.14",
-        "@microchip/scf-automodule-interface": "^0.16.5",
-        "@microchip/scf-common": "^3.10.0",
+        "@microchip/scf-automodule-interface": "^0.17.0",
+        "@microchip/scf-common": "^3.13.4",
         "@microchip/scf-device": "^8.2.0",
@@ -108,7 +114,7 @@ "@microchip/scf-integration-test": "^1.0.0",
         "@babel/preset-typescript": "^7.9.0",
-        "@mchp-mcc/ccl-itf": "^0.2.10",
+        "@mchp-mcc/ccl-itf": "^0.2.14",
         "@microchip/initializer-system": "^0.5.4",
-        "@microchip/run-directory": "^2.4.17",
+        "@microchip/run-directory": "2.4.28",
         "@microchip/run-directory-future": "^1.0.5",
-        "@microchip/scf-automodule": "^4.14.2",
+        "@microchip/scf-automodule": "^4.14.6",
         "@microchip/scf-autoview": "^3.17.0",
@@ -115,0 +121,0 @@ "@microchip/scf-project-scripts": "^1.0.0",

Readme.md

@@ -0,4 +1,25 @@
+# Timeout Driver
+
+## Overview
+The Timeout Driver aims to provide an abstraction interface to Timer-type peripherals such as the Timer0/1/2 peripherals and their derivatives; the Signal Measurement Timer (SMT); and the Hardware Limit Timer (HLT). On top of this hardware abstraction, the application side interface allows users to create applications that need a timeout event after a specified time. The driver can register multiple timers with different callbacks that trigger different events upon their corresponding timer expiration.
+ 
+## Features
+* In general, the Timeout driver can be used two different ways:
+    * Scheduled Timer mode - This mode enables users to schedule events to happen at different times. The scheduled timer can be used as a oneshot timer which runs only once, or as a periodic timer which can run repeatedly.
+    * Stopwatch/Cycle Counter mode - This mode enable users to measure time elapsed between or during events.
+
+## Generated Files
+This driver generates the following files:
+* ./mcc_generated_files/timer/src/timeout.c => This source file contains the function implementations of the Timeout Driver
+* ./mcc_generated_files/timer/timeout.h => This header file contains the function prototypes of the Timeout Driver
+
+        
+
+
 # Changelog
+All notable changes to this project will be documented in this file.
 
-## [3.0.6]
-   - Initial release version.
+## [3.0.7] - 2021-09-22
+
+### New Features
+- **CC8SCRIP-5125** :- Updating Readme and Release Notes for Timeout

src/moduleConfig.json

@@ -31,7 +31,9 @@ {
             "src": "output/TIMEOUTDRIVER_app.c.ftl",
-            "dest": "timer/src/timeout.c"
+            "dest": "timer/src/timeout.c",
+            "isGeneratableProperty": "isTimerDependencySelected"
         },
         {
             "src": "output/TIMEOUTDRIVER_app.h.ftl",
-            "dest": "timer/timeout.h"
+            "dest": "timer/timeout.h",
+            "isGeneratableProperty": "isTimerDependencySelected"
         },
@@ -61,2 +63,6 @@ {
                 "isRequired": true
+            },
+            "nodeModule": {
+                "importName": "timer_timeout",
+                "node": "@microchip/timer-timeout"
             }
@@ -63,0 +69,0 @@ },

New alerts

New author

Supply chain risk

A new npm collaborator published a version of the package for the first time. New collaborators are usually benign additions to a project, but do indicate a change to the security surface area of a package.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

983181

increased by1.05%

Number of package files

22

increased by15.79%

Lines of code

8438

increased by3.58%

Number of lines in readme file

26

increased by550%

Worsened metrics

Number of medium supply chain risk alerts

1

increased byInfinity%

Dependency changes

• Updated@microchip/scf-automodule-interface@^0.17.0

• Updated@microchip/scf-common@^3.13.4