@libs-scripts-mep/grav-fw-pvi 2.0.1 → 2.1.1

package/README.md

@@ -26,41 +26,100 @@ npm uninstall @libs-scripts-mep/grav-fw-pvi
 | Renesas    | Renesas Flash Programmer | ✔️       |
 | Nuvoton    | JLink v7.82              | ✔️       |
 
-## Exemplo de Utilização de Buffers
+## Exemplo de Utilização do Modulo
 
+### STM8
 ```js
 
-static async GravaFirmware(ObjParams) {
+static async GravaFirmware(dirFirm, dirOpt) {
 
-        return new Promise(async (resolve) => {
+        const ObjParams = {
+
+            objArguments: {
+                verbose: true,
+                Device: "STM8S003F3",
+            },
+            timeOut : 4000
 
-        if(await ExecGravacao(dirFirm, dirOpt, modelo_uC, ObjParams)){
-            console.log("GRAVOU")
-        }else{
-            console.log("NÃO GRAVOU")
         }
 
-        async function ExecGravacao(dirFirm, dirOpt, modelo_uC, ObjParams) {
+        return new Promise(async (resolve) => {
 
-            let RetornoGravacao = await GravaFW.STM8(dirFirm, dirOpt, modelo_uC, ObjParams.timeOut)
+            let RetornoGravacao = await GravaFW.STM8(dirFirm, dirOpt, ObjParams.objArguments, ObjParams.timeOut)
 
             if (RetornoGravacao.sucess) {
 
-                return true
+                console.log("GRAVOU")
                 
             } else {
 
-                if (ObjParams.Tentativa >= ObjParams.MaxTentativas) {
-                    return false
-                } else {
-                    ObjParams.Tentativa++
-                    return ExecGravacao(dirFirm, dirOpt, modelo_uC, ObjParams)
-                }
-
+                console.log("NÃO GRAVOU")
             }
 
-        }
-    }
+        })
+
+}  
 
 ```
 
+#### <h3> Possíveis valores para os argumentos da gravação <h3>
+
+
+```js
+[-BoardName=STxxx] ==========> Programming Tool name (ST-LINK, RLINK, STICE, ...)
+[-Tool_ID=x] ================> ST-LINK Programming Tool ID (0, 1, 2...)
+[-NbTools=x] ================> Number of ST-LINK Tools with same device connected (Tool_ID is automatically incremented)
+[-Port=xxx] =================> Communication Port (USB, LPT1)
+[-ProgMode=xxx] =============> Programming mode or protocol (SWIM, JTAG, SWD)
+[-Device=STxxx] =============> Device name (exact same name as in STVP)
+[-version] ==================> Display version of this application
+[-verbose] ==================> Display messages, warnings, errors
+[-log] ======================> Generate or append Result.log log file
+[-loop] =====================> Loop on actions until 'Space' key hit
+[-progress] =================> Display progress of each action
+[-warn_protect] =============> Message Box if programming Option Byte protection
+[-no_progProg] ==============> Do not program PROGRAM MEMORY (used to verify device from a file)
+[-no_progData] ==============> Do not program DATA MEMORY (used to verify device from a file)
+[-no_progOption] ============> Do not program OPTION BYTE (used to verify device from a file)
+[-readProg] =================> Read PROGRAM MEMORY
+[-readData] =================> Read DATA MEMORY
+[-readOption] ===============> Read OPTION BYTE
+[-erase] ====================> Erase the device (before programming)
+[-blank] ====================> Blank Check the device (before programming)
+[-verif] ====================> Verify the device after programming
+[-FileProg=fname.hex/s19] ===> File name to program PROGRAM MEMORY area (hex or s19)
+[-FileData=fname.hex/s19] ===> File name to program DATA MEMORY area (hex or s19)
+[-FileOption=fname.hex/s19] => File name to program OPTION BYTE area (hex or s19)
+
+
+
+objArguments = {
+
+    log: true or false 
+    loop: true or false
+    erase: true or false
+    blank: true or false
+    verif: true or false
+    verbose: true or false
+    version: true or false
+    progress: true or false
+    readProg: true or false
+    readData: true or false
+    readOption: true or false
+    no_progProg: true or false
+    warn_protect: true or false
+    no_progOption: true or false
+    verbose: true or false,
+
+    Port:"USB",
+    ProgMode:"SWIM",
+    NbTools:"1",
+    Tool_ID:"0",
+    BoardName:"ST-LINK",
+    Device: "STM8S003F3",
+    FileData: ""
+
+},  
+
+
+```

package/grav-fw-pvi.js

@@ -6,11 +6,11 @@ class GravaFW {
      * @param {string} dirOpt formato esperado: "I:\\\Documentos\\\Softwares\\\STM8\\\STM8S003F3\\\INV-173\\\173v01\\\173v01_1.50_Com.stp"
      * @param {string} modelo_uC formato esperado: "STM8S003F3"
      */
-    static async STM8(dirFirm = null, dirOpt = null, modelo_uC = null, timeOut = 5000) {
+    static async STM8(dirFirm = null, dirOpt = null, objArguments = {}, timeOut = 5000) {
 
         return new Promise(async (resolve) => {
 
-            let ObjWriteSTM8 = await defineWriteSTM8(dirFirm, dirOpt, modelo_uC)
+            let ObjWriteSTM8 = await defineWriteSTM8(dirFirm, dirOpt, objArguments)
 
             let logGravacao = ""
 
@@ -61,47 +61,51 @@ class GravaFW {
 
         })
 
-
-        async function defineWriteSTM8(dirFirm, dirOpt, modelo_uC) {
-
-            return new Promise((resolve) => {
-
-                if (dirFirm != null && dirOpt != null) {
-
-                    dirFirm = dirFirm.replace(/[\\]/g, `\/`).replace(/\.stp|\.STP/, `.HEX`)
-                    dirOpt = dirOpt.replace(/[\\]/g, `\/`).replace(/\.stp|\.STP/, `.HEX`)
-
-                    resolve({
-                        sucess: true,
-                        commandLineArguments: `-BoardName=ST-LINK -Tool_ID=0 -NbTools=1 -Port=USB -ProgMode=SWIM -Device=${modelo_uC} -verbose -no_loop -no_warn_protect -FileProg=${dirFirm} -FileOption=${dirOpt}`,
-                    })
-
-                } else if (dirFirm != null) {
-
-                    dirFirm = dirFirm.replace(/[\\]/g, `\/`).replace(/\.stp|\.STP/, `.HEX`)
-
-                    resolve({
-                        sucess: true,
-                        commandLineArguments: `-BoardName=ST-LINK -Tool_ID=0 -NbTools=1 -Port=USB -ProgMode=SWIM -Device=${modelo_uC} -verbose -no_loop -no_warn_protect -FileProg=${dirFirm}`,
-                    })
-
-                } else if (dirOpt != null) {
-
-                    dirOpt = dirOpt.replace(/[\\]/g, `\/`).replace(/\.stp|\.STP/, `.HEX`)
-
-                    resolve({
-                        sucess: true,
-                        commandLineArguments: `-BoardName=ST-LINK -Tool_ID=0 -NbTools=1 -Port=USB -ProgMode=SWIM -Device=${modelo_uC} -verbose -no_loop -no_warn_protect -FileOption=${dirOpt}`,
-                    })
-
-                } else {
-                    resolve({
-                        sucess: false,
-                    })
-                }
+        /**
+         * 
+         * @param {string} dirFirm 
+         * @param {string} dirOpt 
+         * @param {object} objArguments 
+         * @returns 
+         */
+        async function defineWriteSTM8(dirFirm, dirOpt, objArguments) {
+
+            return new Promise(async (resolve) => {
+
+                const log = objArguments.log == true ? "-log " : ""
+                const loop = objArguments.loop == true ? "-loop " : "-no_loop "
+                const erase = objArguments.erase == true ? "-erase " : ""
+                const blank = objArguments.blank == true ? "-blank " : ""
+                const verif = objArguments.verif == true ? "-verif " : ""
+                const verbose = objArguments.verbose == true ? "-verbose " : ""
+                const version = objArguments.version == true ? "-version " : ""
+                const progress = objArguments.progress == true ? "-progress " : ""
+                const readProg = objArguments.readProg == true ? "-readProg " : ""
+                const readData = objArguments.readData == true ? "-readData " : ""
+                const readOption = objArguments.readOption == true ? "-readOption " : ""
+                const no_progProg = objArguments.no_progProg == true ? "-no_progProg " : ""
+                const warn_protect = objArguments.warn_protect == true ? "-warn_protect " : "-no_warn_protect "
+                const no_progOption = objArguments.no_progOption == true ? "-no_progOption " : ""
+
+                const Port = objArguments.Port != undefined ? `-Port=${objArguments.Port} ` : "-Port=USB "
+                const ProgMode = objArguments.ProgMode != undefined ? `-ProgMode=${objArguments.ProgMode} ` : "-ProgMode=SWIM "
+                const Device = objArguments.Device != undefined ? `-Device=${objArguments.Device}` : ""
+                const NbTools = objArguments.NbTools != undefined ? `-NbTools=${objArguments.NbTools} ` : "-NbTools=1 "
+                const Tool_ID = objArguments.Tool_ID != undefined ? `-Tool_ID=${objArguments.Tool_ID} ` : "-Tool_ID=0 "
+                const BoardName = objArguments.BoardName != undefined ? `-BoardName=${objArguments.BoardName} ` : "-BoardName=ST-LINK ";
+
+                const FileData = objArguments.FileData != undefined ? `-FileOption=${objArguments.FileData} ` : ""
+                const FileProg = dirFirm != null ? `-FileProg=${dirFirm.replace(/[\\]/g, `\/`).replace(/\.stp|\.STP/, `.HEX`)} ` : ""
+                const FileOption = dirOpt != null ? `-FileOption=${dirOpt.replace(/[\\]/g, `\/`).replace(/\.stp|\.STP/, `.HEX`)} ` : ""
+
+                resolve({
+                    sucess: true,
+                    commandLineArguments: `${BoardName}${Tool_ID}${NbTools}${Port}${ProgMode}${verbose}` +
+                        `${loop}${warn_protect}${erase}${blank}${verif}${FileProg}${FileOption}${FileData}` +
+                        `${readProg}${readData}${readOption}${log}${progress}${no_progOption}${no_progProg}${version}${version}${Device}`,
+                })
 
             })
-
         }
     }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@libs-scripts-mep/grav-fw-pvi",
-  "version": "2.0.1",
+  "version": "2.1.1",
   "description": "Auxilia na gravação de microcontroladores por linha de comando através do PVI",
   "main": "grav-fw-pvi.js",
   "scripts": {