Pull request #1: Feature/ver1

Merge in MCU16CE/matlab-dspic33a-curiosity-i2cexample-mpu9250 from ~I52209/matlab-dspic33a-curiosity-i2cexample-mpu9250-ce:feature/ver1 to develop

* commit 'bcd0cea32ac3f6d2b090c38032f8e48574194050':
  Copied for release (Commit: 63f6481924b4d8be4bd5b9276e1ff4b6cd0c51c4 16 March 2025, 11:15PM)
  Updating the changelog, main.json, jenkins and gitignore files

Author: HitheshCN

.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,45 @@
    "content":{
       "metaDataVersion":"1.0.0",
       "name":"com.microchip.matlab.project.matlab-dspic33a-curiosity-i2cexample-mpu9250",
-      "version":"x.x.x",
-      "displayName":"xxxxxxxxxxxxxxx",
+      "version":"1.0.0",
+      "displayName":"MATLAB/Simulink Model for I2C Peripheral Demonstration on dsPIC33AK128MC106",
       "projectName":"matlab-dspic33a-curiosity-i2cexample-mpu9250",
-      "shortDescription":"xxxxxxxxxxxxxxx",
+      "shortDescription":"MATLAB/Simulink Model for I2C Peripheral Demonstration on the hardware platform Curiosity Platform Development Board, dsPIC33AK128MC106 GP DIM and MPU9250 sensor on the MPU 9DOF Click Board",
       "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"
+         "Communication Module",
+         "I2C",
+         "I2C Protocol",
+         "GPIO",
+	      "ADC",
+	      "PWM"
       ]
    }
 }

README.md

@@ -1,29 +1,145 @@
 <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 i2cexample mpu9250
+# MATLAB/Simulink Model for I2C Peripheral Example: Curiosity Platform Development Board, dsPIC33AK128MC106 Curiosity GP DIM and MPU9250
 
-Board Image if any.
+## 1. INTRODUCTION
 
-## Summary
+This document describes the setup requirements for demonstration of I2C communication 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)" using MPU9250 sensor on the MPU 9DOF Click Board.</p>
 
+MPU-9250 is a multi-chip module (MCM) with 9-axis MotionTracking device that combines a 3-axis gyroscope, 3-axis accelerometer, 3-axis magnetometer and a Digital Motion Processor™ (DMP).
 
-## Related Documentation
+## 2. SUGGESTED DEMONSTRATION REQUIREMENTS
 
+### 2.1 MATLAB Model Required for the Demonstration
 
-## Software Used 
+To clone or download this MATLAB model on GitHub, 
 
+- 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-i2cexample-mpu9250)).
 
-## Hardware Used
+### 2.2 Software Tools Used for Testing the MATLAB/Simulink Model
 
+- 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.59)
+    - Motor Control Blockset (v24.2)
+> **_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.
 
-## Setup
+  ### 2.3 Hardware Tools Required for the Demonstration
 
+- 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)
+- [MPU 9DOF CLICK](https://www.mikroe.com/mpu-9dof-click)
 
-## Operation
+## 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**.
 
+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. Insert the **MPU 9DOF click** into the **mikro BUS A** interface **connector J13** on the development board. Make sure the click board is inserted correctly before going ahead.
+
+     <p align="left" >
+     <img  src="images/microbusA.png"width="500"></p>
+
+3. 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-USB 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 I2C 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 I2C example Simulink model - **curiosity_i2c.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 demonstrates only the code generation to demostrate the I2C communication. The simulation is not possible in this case.
+
+4.	<p style='text-align: justify;'>From this Simulink model an MPLAB X project can be generated, and it can be used to run the I2C Communication using development board. <p style='text-align: justify;'>To generate the code from the Simulink model, go to the <b>"MICROCHIP"</b> tab, and enable the tabs shown in the figure below. 
+
+    <p align="left">
+      <img  src="images/dem4.png"width="500"></p>
+    </p>
+
+5. <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>
+    >Two COM ports are available on the development board. Select the second COM port number for the external mode (if COM2 and COM3 are available on the development board, select COM3).
+
+6.	<p style='text-align: justify;'>	To generate the code and run the I2C communication 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>
+7.	<p style='text-align: justify;'> After compilation and programming the device. The external mode will be running on the dsPIC.
+
+    <p align="left">
+      <img  src="images/dem7.png"width="500"></p>
+
+    </p><p style='text-align: justify;'> The <b>General Purpose LED's</b> will be blinking.
+
+    <p align="left">
+      <img  src="images/debug_led.png"width="500"></p>
+    </p>
+
+8. <p style='text-align: justify;'>	The <b> RGB LEB</b> will be glowing in different colors. To increase the brightness of the RGB LED, vary the <b>Potentiometer</b> on the development board.
+
+    <p align="left">
+      <img  src="images/led_rgb.png"width="500"></p>
+    </p>
+
+9. <p style='text-align: justify;'>	To view the I2C communication from <b>"MPU9250" </b> double click on the scope. This opens the scope view. Tilt or turn the development board by hand to view variations in the signal from the <b>accelerometer, gyroscope and magnetometer sensors of MPU9250</b>.
+
+    <p align="left">
+      <img  src="images/dem9.png"width="500"></p>
+    </p>
+
+10. <p style='text-align: justify;'>Click on the <b>Stop</b> button to stop the I2C communication and 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,6 +1,6 @@
 # matlab-dspic33a-curiosity-i2cexample-mpu9250 v1.0.0
 ### Release Highlights
-
+This is the first version of MATLAB Simulink model for I2C Communication Demonstration on hardware platform Curiosity Platform Development Board, dsPIC33AK128MC106 Curiosity GP DIM and MPU9250.
 
 
 ### Features Added\Updated