Pull request #1: Feature/Release V1

Merge in MCU16CE/matlab-dspic33a-curiosity-simple-filter-example from ~I50990/matlab-dspic33a-curiosity-simple-filter-example:feature/Release_V1 to develop

* commit '51b1abeb7207691ccf5e4432434e9b19d48d9b44':
  Minor correction Readme
  main.json file is updated.
  Updated gitignore file. Added PDF version of Readme to the docs folder.
  Copied the project folder,images and Readme files from- Commit: 7442ff61ab3a7ddd33830cefc63a9ab15da71b11 [7442ff6] Parents: c551fd5631 Date: Tuesday, October 7, 2025 2:56:26 PM
  Updated the following files the release- 1.changelog.md 2.Jenkinfile 3.main.json

Author: SHYAMP8

.citd/Jenkinsfilek8s

@@ -80,7 +80,9 @@ pipeline {
 
         stage('Build') {
             steps {
-                script {                   
+                script {  
+                    sh("npm install -g xml2js")
+					sh("npm link xml2js")					
                     mplabxProjectBuild(
                         sourceFilePath: "${env.MPLABX_PROJECT_SOURCE}"
                     )

.gitignore

@@ -19,6 +19,19 @@
 #Excluding Files/Folders Auto-Generated by Test Harness
 .generated_files/
 
+#Excluding Files/Folders Auto-Generated by Simulink
+*.X
+*.slx.autosave
+*.slx.original
+*.slxc
+*.mat
+*.tlc
+*.tlh
+*.xml
+*.tmw
+*.dmr
+*.l
+
 # Excluding Netbeans specific build directories and file types
 ~*.*
 .generated_files/

.main-meta/main.json

@@ -4,43 +4,46 @@
    "content":{
       "metaDataVersion":"1.0.0",
       "name":"com.microchip.matlab.project.matlab-dspic33a-curiosity-simple-filter-example",
-      "version":"x.x.x",
-      "displayName":"xxxxxxxxxxxxxxx",
+      "version":"1.0.0",
+      "displayName":"MATLAB/Simulink Model Example Using MPLAB Device Blocks for dsPIC33AK128MC106 Curiosity GP DIM",
       "projectName":"matlab-dspic33a-curiosity-simple-filter-example",
-      "shortDescription":"xxxxxxxxxxxxxxx",
+      "shortDescription":"MATLAB/Simulink Model Example Using MPLAB Device Blocks on the hardware platform Curiosity Platform Development Board and dsPIC33AK128MC106 GP DIM",
       "simulationTool":{
          "name":"MATLAB/Simulink",
-         "semverRange":">=2022"
+         "semverRange":">=2024"
       },
 	  "addonPackages":[
 				"MATLAB add on packages",
 				"Simulink",
 				"MPLAB Device blocks for Simulink",
-				"Motor Control Blockset",
-				"Embedded Coder",
-				"Fixed-Point Designer"
+				"Embedded Coder"
       ],
       "compiler":{
-         "name":"XC16",
-         "semverRange":"^2.0.0"
+         "name":"XCDSC",
+         "semverRange":"^3.21"
       },
       "dfp":{
-         "name":"xxxxxxxxxxxxxxx",
-         "semverRange":">=x.x.x"
+         "name":"dsPIC33AK-MC_DFP",
+         "semverRange":">=1.1.109"
       },
       "device":{
          "metaDataVersion":"1.0.0",
          "category":"com.microchip.portal.contentRef",
          "content":{
             "metaDataVersion":"1.0.0",
             "category":"com.microchip.device",
-            "name":"xxxxxxxxxxxxxxx",
+            "name":"dsPIC33AK128MC106",
             "versionRange":"*"
          }
       },
       "keywords":[
-        "GPIO",
-		"UART"
+      "GPIO",
+		"UART",
+		"ADC",
+		"Filter",
+		"MATLAB",
+		"MATLAB Simulink",
+		"Communication Module"
       ]
    }
 }

README.md

@@ -1,29 +1,146 @@
 <picture>
     <source media="(prefers-color-scheme: dark)" srcset="images/microchip_logo_white_red.png">
-	<source media="(prefers-color-scheme: light)" srcset="images/microchip_logo_black_red.png">
+  <source media="(prefers-color-scheme: light)" srcset="images/microchip_logo_black_red.png">
     <img alt="Microchip Logo." src="images/microchip_logo_black_red.png">
 </picture> 
 
-## matlab dspic33a curiosity simple filter example
+# MATLAB/Simulink Model Example Using MPLAB® Device Blocks for dsPIC33AK128MC106 Curiosity GP DIM
 
-Board Image if any.
+## 1. INTRODUCTION
 
-## Summary
+This document describes the setup requirements for demonstrating the use of [MPLAB Device Blocks](https://in.mathworks.com/matlabcentral/fileexchange/71892-mplab-device-blocks-for-simulink-dspic-pic32-and-sam-mcu) to configure and operate the dsPIC Digital Signal Controller (DSC) and its peripherals within a MATLAB/Simulink model. The example is developed using the hardware platform
+[EV74H48A](https://www.microchip.com/en-us/development-tool/EV74H48A) "Curiosity Platform Development Board" and [EV02G02A](https://www.microchip.com/en-us/development-tool/EV02G02A) "dsPIC33AK128MC106 General Purpose Dual In-Line Module (DIM)"</p>
 
+## 2. SUGGESTED DEMONSTRATION REQUIREMENTS
 
-## Related Documentation
+### 2.1 MATLAB Model Required for the Demonstration
 
+To clone or download this MATLAB model on GitHub, 
 
-## Software Used 
+- MATLAB model can be cloned or downloaded as zip file from the Github repository ([link](https://github.com/microchip-pic-avr-solutions/matlab-dspic33a-curiosity-simple-filter-example)).
 
+### 2.2 Software Tools Used for Testing the MATLAB/Simulink Model
 
-## Hardware Used
+- MPLAB® X IDE **v6.25** 
+- MPLAB® XC-DSC Compiler **v3.21**
+-	MATLAB R2024b
+-	Required MATLAB add-on packages
+    -	Simulink (v24.2)
+    -	Simulink Coder (v24.2)
+    -	MATLAB Coder (v24.2)
+    -	Embedded Coder (v24.2)
+    -	MPLAB Device blocks for Simulink (v3.62)
+    
+> **_NOTE:_**
+>The software tools used for testing the model during release is listed above. It is recommended to use the version listed above or later versions for building the model.
 
+  ### 2.3 Hardware Tools Required for the Demonstration
 
-## Setup
+- Curiosity Platform Development Board ([EV74H48A](https://www.microchip.com/en-us/development-tool/EV74H48A))
+- dsPIC33AK128MC106 General Purpose Dual In-Line Module ([EV02G02A](https://www.microchip.com/en-us/development-tool/EV02G02A))
 
+## 3. HARDWARE SETUP
+This section describes the hardware setup required for the demonstration.
+> **Note:** </br>
+>In this document, hereinafter Curiosity Platform Development Board is referred as **development board**.
 
-## Operation
+1. Insert the **dsPIC33AK128MC106 Curiosity GP DIM** into the DIM Interface **connector J1** on the development board. Make sure the DIM is placed correctly and oriented before going ahead.
 
+     <p align="left" >
+     <img  src="images/dimconnected.png"width="500"></p>
 
+2. The development board has an onboard programmer **PICkit™ On Board (PKoBv4)** , which can be used for programming or debugging the microcontroller or dsPIC DSC on the DIM. To use the onboard programmer, connect a Micro-C® cable between the Host PC and **connector J24** on the development board.
 
+    The development board is also powered by this USB itself.
+
+      <p align="left">
+     <img  src="images/pkob4.png"width="500"></p>
+
+## 4. BASIC DEMONSTRATION
+<p style='text-align: justify;'> Follow the below instructions step-by-step, to set up and run demo application:</p>
+
+1. Launch MATLAB (refer the section [“2.2 Software Tools Used for Testing the MATLAB/Simulink Model"](#22-software-tools-used-for-testing-the-matlabsimulink-model)).</p> 
+
+2. Open the folder downloaded from the repository, in which MATLAB files are saved (refer the section ["2.1 MATLAB Model Required for the Demonstration"](#21-matlab-model-required-for-the-demonstration)).
+
+    <p align="left" >
+    <img  src="images/dem1.png"width="500"></p>
+
+3.	Double click on the example Simulink model - **Curiosity_33ak128mc106_Simple_Filter.slx**. This opens the Simulink model as shown below.
+
+    <p align="left">
+      <img  src="images/dem3.png"width="500"></p>
+    </p>
+
+    > **Note:** </br>
+    >This example illustrates how to configure the dsPIC DSC and its peripherals through code generation using MPLAB Device blocks. Simulation is not supported.
+
+4. <p style='text-align: justify;'>	This model uses the <b>External Mode</b> debug option for real time data visualization. To configure the external mode click on <b>"Ext Mode Settings" </b> option under the <b>“Microchip”</b> tab. <p style='text-align: justify;'>  This will open <b>External Mode Setup</b> window and enable the checkboxes as shown in the figure. Also select the <b> COM port </b> connected to the development board  and <b>Baud Rate</b>.
+
+    <p align="left">
+      <img  src="images/dem5.png"width="500"></p>
+    </p>
+
+    > **Note:** </br>
+    >The PKOB4 based USB-UART Channel is used in this example for USB-UART communication. The development board has a 2-port USB hub.
+
+5.	<p style='text-align: justify;'>	To generate the code and run the model on hardware, click on <b>"Monitor & Tune" </b> option under the <b>Hardware</b> tab and ensure that <b>"Stop Time" </b> is set to <b>"inf"</b>. 
+
+    <p align="left">
+      <img  src="images/dem6.png"width="500"></p>
+    </p>
+6.	<p style='text-align: justify;'> After compiling the code and programming the device, External Mode will be activated on the dsPIC DSC.
+
+    <p align="left">
+      <img  src="images/dem7.png"width="500"></p>
+
+    </p>
+7. <p style='text-align: justify;'>	The <b> RGB LEB</b> will be glowing in green color and general purpose LEDs start blinking in a particular pattern.
+
+    <p align="left">
+      <img  src="images/led_rgb_green1.png"width="500"></p>
+    </p>
+8. <p style='text-align: justify;'> Press the push button <b>S1</b>,to change the blinking pattern of general purpose LEDs. 
+
+    <p align="left">
+      <img  src="images/led_rgb_green2.png"width="500"></p>
+    </p>
+9. <p style='text-align: justify;'> Press the push button <b>S2</b>, and  vary the potentiometer to change the rate of blinking. 
+
+    <p align="left">
+      <img  src="images/led_rgb_green3.png"width="500"></p>
+    </p>
+10. <p style='text-align: justify;'> To visualize the input and filtered output signals, double-click the Scope in the model to launch the scope view.The filter input is set to a 1Hz pulse by default. 
+ 
+
+    <p align="left">
+      <img  src="images/dem9.png"width="500"></p>
+    </p>
+
+11. Press the push button <b>S3</b>, the <b> RGB LEB</b> will be glowing in blue color and  vary the potentiometer to change input signal and observe the filtered output signal in the scope view. 
+
+    <p align="left">
+      <img  src="images/led_rgb_blue.png"width="500"></p>
+    </p>
+
+    <p align="left">
+      <img  src="images/dem9_view.png"width="500"></p>
+    </p>
+
+12. <p style='text-align: justify;'>Click on the <b>Stop</b> button to stop the external mode.
+
+    <p align="left">
+      <img  src="images/dem10.png"width="500"></p>
+    </p>
+
+
+## 	REFERENCES:
+For more information, refer to the following documents or links.
+1. Curiosity Platform Development Board User's Guide ([DS70005562](https://ww1.microchip.com/downloads/aemDocuments/documents/MCU16/ProductDocuments/UserGuides/Curiosity-Platform-Development-Board-Users-Guide-DS70005562.pdf))
+2. dsPIC33AK128MC106 General Purpose Dual In-Line Module (DIM) Information Sheet ([DS70005556](https://ww1.microchip.com/downloads/aemDocuments/documents/MCU16/ProductDocuments/InformationSheet/dsPIC33AK128MC106-General-Purpose-DIM-Info-Sheet-DS70005556.pdf))
+3. dsPIC33AK128MC106 Family datasheet ([DS70005539](https://ww1.microchip.com/downloads/aemDocuments/documents/MCU16/ProductDocuments/DataSheets/dsPIC33AK128MC106-Family-Data-Sheet-DS70005539.pdf))
+4. MPLAB® X IDE User’s Guide ([DS50002027](https://ww1.microchip.com/downloads/en/DeviceDoc/50002027E.pdf) or [MPLAB® X IDE help](https://microchipdeveloper.com/xwiki/bin/view/software-tools/x/))
+5. [MPLAB® X IDE installation](http://microchipdeveloper.com/mplabx:installation)
+6. [MPLAB® XC-DSC Compiler installation](https://developerhelp.microchip.com/xwiki/bin/view/software-tools/xc-dsc/install/)
+7.  [MPLAB Device Blocks for Simulink :dsPIC, PIC32 and SAM mcu](https://in.mathworks.com/matlabcentral/fileexchange/71892-mplab-device-blocks-for-simulink-dspic-pic32-and-sam-mcu)
+8. [External Mode Demo](https://www.microchip.com/en-us/about/media-center/videos/wuzLmORk1M0)

changelog.md

@@ -1,9 +1,3 @@
 # matlab-dspic33a-curiosity-simple-filter-example v1.0.0
 ### Release Highlights
-
-
-
-### Features Added\Updated
-
-
-
+This is the first version of MATLAB/Simulink Model Example Using [MPLAB Device Blocks](https://in.mathworks.com/matlabcentral/fileexchange/71892-mplab-device-blocks-for-simulink-dspic-pic32-and-sam-mcu) on the hardware platform [EV74H48A](https://www.microchip.com/en-us/development-tool/EV74H48A) "Curiosity Platform Development Board" and [EV02G02A](https://www.microchip.com/en-us/development-tool/EV02G02A) "dsPIC33AK128MC106 General Purpose Dual In-Line Module (DIM)".